Mercurial > cgi-bin > hgweb.cgi > tincan
annotate tincan.py @ 7:57ec65f527e9 draft
Eliminate a stat() call, allow no code-behind on pages.
| author | David Barts <n5jrn@me.com> |
|---|---|
| date | Mon, 13 May 2019 16:00:11 -0700 |
| parents | a3823da7bb45 |
| children | 9aaa91247b14 |
| rev | line source |
|---|---|
| 0 | 1 #!/usr/bin/env python3 |
| 2 # -*- coding: utf-8 -*- | |
| 3 # As with Bottle, it's all in one big, ugly file. For now. | |
| 4 | |
| 5 # I m p o r t s | |
| 6 | |
| 7 import os, sys | |
| 8 import ast | |
| 9 import binascii | |
| 10 from base64 import b16encode, b16decode | |
|
4
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
11 import functools |
| 2 | 12 import importlib |
|
4
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
13 from inspect import isclass |
| 0 | 14 import io |
| 2 | 15 import py_compile |
| 16 from stat import S_ISDIR, S_ISREG | |
| 5 | 17 from string import whitespace |
| 0 | 18 |
| 19 import bottle | |
| 20 | |
| 2 | 21 # E x c e p t i o n s |
| 0 | 22 |
| 23 class TinCanException(Exception): | |
| 24 """ | |
| 25 The parent class of all exceptions we raise. | |
| 26 """ | |
| 27 pass | |
| 28 | |
| 29 class TemplateHeaderException(TinCanException): | |
| 30 """ | |
| 31 Raised upon encountering a syntax error in the template headers. | |
| 32 """ | |
| 33 def __init__(self, message, line): | |
| 34 super().__init__(message, line) | |
| 35 self.message = message | |
| 36 self.line = line | |
| 37 | |
| 38 def __str__(self): | |
|
4
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
39 return "line {0}: {1}".format(self.line, self.message) |
| 0 | 40 |
| 41 class ForwardException(TinCanException): | |
| 42 """ | |
| 43 Raised to effect the flow control needed to do a forward (server-side | |
| 44 redirect). It is ugly to do this, but other Python frameworks do and | |
| 45 there seems to be no good alternative. | |
| 46 """ | |
| 47 def __init__(self, target): | |
| 48 self.target = target | |
| 49 | |
| 50 class TinCanError(TinCanException): | |
| 51 """ | |
| 52 General-purpose exception thrown by TinCan when things go wrong, often | |
| 53 when attempting to launch webapps. | |
| 54 """ | |
| 55 pass | |
| 56 | |
| 2 | 57 # T e m p l a t e s |
| 58 # | |
| 0 | 59 # Template (.pspx) files. These are standard templates for a supported |
| 60 # template engine, but with an optional set of header lines that begin | |
| 61 # with '#'. | |
| 62 | |
| 63 class TemplateFile(object): | |
| 64 """ | |
| 65 Parse a template file into a header part and the body part. The header | |
| 66 is always a leading set of lines, each starting with '#', that is of the | |
| 67 same format regardless of the template body. The template body varies | |
| 68 depending on the selected templating engine. The body part has | |
| 69 each header line replaced by a blank line. This preserves the overall | |
| 70 line numbering when processing the body. The added newlines are normally | |
| 71 stripped out before the rendered page is sent back to the client. | |
| 72 """ | |
| 5 | 73 _END = "#end" |
| 74 _LEND = len(_END) | |
| 75 _WS = set(whitespace) | |
| 76 | |
| 0 | 77 def __init__(self, raw, encoding='utf-8'): |
| 78 if isinstance(raw, io.TextIOBase): | |
| 79 self._do_init(raw) | |
| 80 elif isinstance(raw, str): | |
| 81 with open(raw, "r", encoding=encoding) as fp: | |
| 82 self._do_init(fp) | |
| 83 else: | |
| 84 raise TypeError("Expecting a string or Text I/O object.") | |
| 85 | |
| 86 def _do_init(self, fp): | |
| 87 self._hbuf = [] | |
| 88 self._bbuf = [] | |
| 89 self._state = self._header | |
| 90 while True: | |
| 91 line = fp.readline() | |
| 92 if line == '': | |
| 93 break | |
| 94 self._state(line) | |
| 95 self.header = ''.join(self._hbuf) | |
| 96 self.body = ''.join(self._bbuf) | |
| 97 | |
| 98 def _header(self, line): | |
| 99 if not line.startswith('#'): | |
| 100 self._state = self._body | |
| 101 self._state(line) | |
| 102 return | |
| 5 | 103 if line.startswith(self._END) and (len(line) == self._LEND or line[self._LEND] in self._WS): |
| 104 self._state = self._body | |
| 0 | 105 self._hbuf.append(line) |
| 106 self._bbuf.append("\n") | |
| 107 | |
| 108 def _body(self, line): | |
| 109 self._bbuf.append(line) | |
| 110 | |
| 111 class TemplateHeader(object): | |
| 112 """ | |
| 113 Parses and represents a set of header lines. | |
| 114 """ | |
| 2 | 115 _NAMES = [ "errors", "forward", "methods", "python", "template" ] |
| 0 | 116 _FNAMES = [ "hidden" ] |
| 117 | |
| 118 def __init__(self, string): | |
| 119 # Initialize our state | |
| 120 for i in self._NAMES: | |
| 121 setattr(self, i, None) | |
| 122 for i in self._FNAMES: | |
| 123 setattr(self, i, False) | |
| 124 # Parse the string | |
| 125 count = 0 | |
| 126 nameset = set(self._NAMES + self._FNAMES) | |
| 127 seen = set() | |
| 128 lines = string.split("\n") | |
| 129 if lines and lines[-1] == "": | |
| 130 del lines[-1] | |
| 131 for line in lines: | |
| 132 # Get line | |
| 133 count += 1 | |
| 134 if not line.startswith("#"): | |
| 135 raise TemplateHeaderException("Does not start with '#'.", count) | |
| 136 try: | |
| 137 rna, rpa = line.split(maxsplit=1) | |
| 138 except ValueError: | |
| 5 | 139 rna = line.rstrip() |
| 140 rpa = None | |
| 0 | 141 # Get name, ignoring remarks. |
| 142 name = rna[1:] | |
| 143 if name == "rem": | |
| 144 continue | |
| 5 | 145 if name == "end": |
| 146 break | |
| 0 | 147 if name not in nameset: |
| 148 raise TemplateHeaderException("Invalid directive: {0!r}".format(rna), count) | |
| 149 if name in seen: | |
| 150 raise TemplateHeaderException("Duplicate {0!r} directive.".format(rna), count) | |
| 151 seen.add(name) | |
| 152 # Flags | |
| 5 | 153 if name in self._FNAMES: |
| 0 | 154 setattr(self, name, True) |
| 155 continue | |
| 156 # Get parameter | |
| 5 | 157 if rpa is None: |
| 158 raise TemplateHeaderException("Missing parameter.", count) | |
| 0 | 159 param = rpa.strip() |
| 160 for i in [ "'", '"']: | |
| 161 if param.startswith(i) and param.endswith(i): | |
| 162 param = ast.literal_eval(param) | |
| 163 break | |
| 164 # Update this object | |
| 165 setattr(self, name, param) | |
| 166 | |
| 2 | 167 # C h a m e l e o n |
| 168 # | |
| 0 | 169 # Support for Chameleon templates (the kind TinCan uses by default). |
| 170 | |
| 171 class ChameleonTemplate(bottle.BaseTemplate): | |
| 172 def prepare(self, **options): | |
| 173 from chameleon import PageTemplate, PageTemplateFile | |
| 174 if self.source: | |
|
4
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
175 self.tpl = PageTemplate(self.source, encoding=self.encoding, |
|
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
176 **options) |
| 0 | 177 else: |
|
4
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
178 self.tpl = PageTemplateFile(self.filename, encoding=self.encoding, |
|
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
179 search_path=self.lookup, **options) |
| 0 | 180 |
| 181 def render(self, *args, **kwargs): | |
| 182 for dictarg in args: | |
| 183 kwargs.update(dictarg) | |
| 184 _defaults = self.defaults.copy() | |
| 185 _defaults.update(kwargs) | |
| 186 return self.tpl.render(**_defaults) | |
| 187 | |
|
4
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
188 chameleon_template = functools.partial(bottle.template, template_adapter=ChameleonTemplate) |
|
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
189 chameleon_view = functools.partial(bottle.view, template_adapter=ChameleonTemplate) |
| 0 | 190 |
| 2 | 191 # U t i l i t i e s |
| 0 | 192 |
| 193 def _normpath(base, unsplit): | |
| 194 """ | |
| 195 Split, normalize and ensure a possibly relative path is absolute. First | |
| 196 argument is a list of directory names, defining a base. Second | |
| 197 argument is a string, which may either be relative to that base, or | |
| 198 absolute. Only '/' is supported as a separator. | |
| 199 """ | |
| 200 scratch = unsplit.strip('/').split('/') | |
| 201 if not unsplit.startswith('/'): | |
| 202 scratch = base + scratch | |
| 203 ret = [] | |
| 204 for i in scratch: | |
| 205 if i == '.': | |
| 206 continue | |
| 207 if i == '..': | |
| 208 ret.pop() # may raise IndexError | |
| 209 continue | |
| 210 ret.append(i) | |
| 211 return ret | |
| 212 | |
| 213 def _mangle(string): | |
| 214 """ | |
| 215 Turn a possibly troublesome identifier into a mangled one. | |
| 216 """ | |
| 217 first = True | |
| 218 ret = [] | |
| 219 for ch in string: | |
| 220 if ch == '_' or not (ch if first else "x" + ch).isidentifier(): | |
| 221 ret.append('_') | |
| 222 ret.append(b16encode(ch.encode("utf-8")).decode("us-ascii")) | |
| 223 else: | |
| 224 ret.append(ch) | |
| 225 first = False | |
| 226 return ''.join(ret) | |
| 227 | |
| 228 # The TinCan class. Simply a Bottle webapp that contains a forward method, so | |
| 229 # the code-behind can call request.app.forward(). | |
| 230 | |
| 231 class TinCan(bottle.Bottle): | |
| 232 def forward(self, target): | |
| 233 """ | |
| 234 Forward this request to the specified target route. | |
| 235 """ | |
| 236 source = bottle.request.environ['PATH_INFO'] | |
| 237 base = source.strip('/').split('/')[:-1] | |
| 238 try: | |
| 239 exc = ForwardException('/' + '/'.join(_normpath(base, target))) | |
| 240 except IndexError as e: | |
| 241 raise TinCanError("{0}: invalid forward to {1!r}".format(source, target)) from e | |
| 242 raise exc | |
| 243 | |
| 2 | 244 # C o d e B e h i n d |
| 245 # | |
| 0 | 246 # Represents the code-behind of one of our pages. This gets subclassed, of |
| 247 # course. | |
| 248 | |
| 249 class Page(object): | |
| 250 # Non-private things we refuse to export anyhow. | |
| 251 __HIDDEN = set([ "request", "response" ]) | |
| 252 | |
| 253 def __init__(self, req, resp): | |
| 254 """ | |
| 255 Constructor. This is a lightweight operation. | |
| 256 """ | |
| 257 self.request = req # app context is request.app in Bottle | |
| 258 self.response = resp | |
| 259 | |
| 260 def handle(self): | |
| 261 """ | |
| 262 This is the entry point for the code-behind logic. It is intended | |
| 263 to be overridden. | |
| 264 """ | |
| 265 pass | |
| 266 | |
| 267 def export(self): | |
| 268 """ | |
| 269 Export template variables. The default behavior is to export all | |
| 270 non-hidden non-callables that don't start with an underscore, | |
| 271 plus a an export named page that contains this object itself. | |
| 272 This method can be overridden if a different behavior is | |
| 273 desired. It should always return a dict or dict-like object. | |
| 274 """ | |
| 275 ret = { "page": self } # feature: will be clobbered if self.page exists | |
| 276 for name in dir(self): | |
| 277 if name in self.__HIDDEN or name.startswith('_'): | |
| 278 continue | |
| 279 value = getattr(self, name) | |
| 280 if callable(value): | |
| 281 continue | |
| 282 ret[name] = value | |
|
4
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
283 return ret |
| 0 | 284 |
| 2 | 285 # R o u t e s |
| 286 # | |
| 0 | 287 # Represents a route in TinCan. Our launcher creates these on-the-fly based |
| 288 # on the files it finds. | |
| 289 | |
| 2 | 290 _ERRMIN = 400 |
| 291 _ERRMAX = 599 | |
| 292 _PEXTEN = ".py" | |
| 293 _TEXTEN = ".pspx" | |
|
1
94b36e721500
Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents:
0
diff
changeset
|
294 _FLOOP = "tincan.forwards" |
|
94b36e721500
Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents:
0
diff
changeset
|
295 _FORIG = "tincan.origin" |
|
94b36e721500
Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents:
0
diff
changeset
|
296 |
|
4
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
297 class _TinCanErrorRoute(object): |
|
1
94b36e721500
Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents:
0
diff
changeset
|
298 """ |
|
94b36e721500
Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents:
0
diff
changeset
|
299 A route to an error page. These never have code-behind, don't get |
|
94b36e721500
Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents:
0
diff
changeset
|
300 routes created for them, and are only reached if an error routes them |
|
94b36e721500
Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents:
0
diff
changeset
|
301 there. Error templates only have two variables available: e (the |
|
94b36e721500
Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents:
0
diff
changeset
|
302 HTTPError object associated with the error) and request. |
|
94b36e721500
Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents:
0
diff
changeset
|
303 """ |
|
94b36e721500
Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents:
0
diff
changeset
|
304 def __init__(self, template): |
|
94b36e721500
Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents:
0
diff
changeset
|
305 self._template = template |
|
94b36e721500
Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents:
0
diff
changeset
|
306 self._template.prepare() |
|
94b36e721500
Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents:
0
diff
changeset
|
307 |
|
94b36e721500
Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents:
0
diff
changeset
|
308 def __call__(self, e): |
| 5 | 309 return self._template.render(error=e, request=bottle.request).lstrip('\n') |
|
1
94b36e721500
Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents:
0
diff
changeset
|
310 |
|
4
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
311 class _TinCanRoute(object): |
| 0 | 312 """ |
| 313 A route created by the TinCan launcher. | |
| 314 """ | |
| 315 def __init__(self, launcher, name, subdir): | |
| 316 self._fsroot = launcher.fsroot | |
| 317 self._urlroot = launcher.urlroot | |
| 318 self._name = name | |
| 2 | 319 self._python = name + _PEXTEN |
| 320 self._fspath = os.path.join(launcher.fsroot, *subdir, name + _TEXTEN) | |
| 321 self._urlpath = self._urljoin(launcher.urlroot, *subdir, name + _TEXTEN) | |
| 0 | 322 self._origin = self._urlpath |
| 323 self._subdir = subdir | |
| 324 self._seen = set() | |
| 325 self._tclass = launcher.tclass | |
| 326 self._app = launcher.app | |
| 327 | |
| 2 | 328 def launch(self): |
| 0 | 329 """ |
| 330 Launch a single page. | |
| 331 """ | |
| 332 # Build master and header objects, process #forward directives | |
| 333 hidden = None | |
| 334 while True: | |
| 335 self._template = TemplateFile(self._fspath) | |
|
4
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
336 try: |
|
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
337 self._header = TemplateHeader(self._template.header) |
|
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
338 except TemplateHeaderException as e: |
|
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
339 raise TinCanError("{0}: {1!s}".format(self._fspath, e)) from e |
| 0 | 340 if hidden is None: |
| 3 | 341 if self._header.errors is not None: |
| 342 break | |
| 0 | 343 hidden = self._header.hidden |
| 3 | 344 elif self._header.errors is not None: |
| 345 raise TinCanError("{0}: #forward to #errors not allowed".format(self._origin)) | |
| 0 | 346 if self._header.forward is None: |
| 347 break | |
| 348 self._redirect() | |
|
4
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
349 # If this is a #hidden page, we ignore it for now, since hidden pages |
| 0 | 350 # don't get routes made for them. |
| 351 if hidden: | |
| 352 return | |
|
4
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
353 # If this is an #errors page, register it as such. |
| 2 | 354 if self._header.errors is not None: |
| 3 | 355 self._mkerror() |
|
1
94b36e721500
Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents:
0
diff
changeset
|
356 return # this implies #hidden |
|
4
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
357 # Get #methods for this route |
| 0 | 358 if self._header.methods is None: |
| 359 methods = [ 'GET' ] | |
| 360 else: | |
| 361 methods = [ i.upper() for i in self._header.methods.split() ] | |
| 3 | 362 if not methods: |
| 363 raise TinCanError("{0}: no #methods specified".format(self._urlpath)) | |
|
4
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
364 # Get the code-behind #python |
| 0 | 365 if self._header.python is not None: |
| 2 | 366 if not self._header.python.endswith(_PEXTEN): |
|
4
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
367 raise TinCanError("{0}: #python files must end in {1}".format(self._urlpath, _PEXTEN)) |
| 0 | 368 self._python = self._header.python |
| 369 # Obtain a class object by importing and introspecting a module. | |
| 3 | 370 self._getclass() |
|
4
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
371 # Build body object (#template) |
| 3 | 372 if self._header.template is not None: |
| 373 if not self._header.template.endswith(_TEXTEN): | |
|
4
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
374 raise TinCanError("{0}: #template files must end in {1}".format(self._urlpath, _TEXTEN)) |
|
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
375 tpath = os.path.normpath(os.path.join(self._fsroot, *self._splitpath(self._header.template))) |
| 3 | 376 tfile = TemplateFile(tpath) |
| 377 self._body = self._tclass(source=tfile.body) | |
| 378 else: | |
| 379 self._body = self._tclass(source=self._template.body) | |
| 380 self._body.prepare() | |
| 381 # Register this thing with Bottle | |
| 6 | 382 print("adding route:", self._origin, '('+','.join(methods)+')') # debug |
| 3 | 383 self._app.route(self._origin, methods, self) |
| 384 | |
| 385 def _splitpath(self, unsplit): | |
| 386 return _normpath(self._subdir, unsplit) | |
| 387 | |
| 388 def _mkerror(self): | |
| 389 try: | |
| 390 errors = [ int(i) for i in self._header.errors.split() ] | |
| 391 except ValueError as e: | |
| 392 raise TinCanError("{0}: bad #errors line".format(self._urlpath)) from e | |
| 393 if not errors: | |
| 394 errors = range(_ERRMIN, _ERRMAX+1) | |
|
4
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
395 route = _TinCanErrorRoute(self._tclass(source=self._template.body)) |
| 3 | 396 for error in errors: |
| 397 if error < _ERRMIN or error > _ERRMAX: | |
| 398 raise TinCanError("{0}: bad #errors code".format(self._urlpath)) | |
| 5 | 399 self._app.error_handler[error] = route # XXX |
| 3 | 400 |
|
7
57ec65f527e9
Eliminate a stat() call, allow no code-behind on pages.
David Barts <n5jrn@me.com>
parents:
6
diff
changeset
|
401 def _gettime(self, path): |
|
57ec65f527e9
Eliminate a stat() call, allow no code-behind on pages.
David Barts <n5jrn@me.com>
parents:
6
diff
changeset
|
402 try: |
|
57ec65f527e9
Eliminate a stat() call, allow no code-behind on pages.
David Barts <n5jrn@me.com>
parents:
6
diff
changeset
|
403 return os.stat(path).st_mtime |
|
57ec65f527e9
Eliminate a stat() call, allow no code-behind on pages.
David Barts <n5jrn@me.com>
parents:
6
diff
changeset
|
404 except FileNotFoundError: |
|
57ec65f527e9
Eliminate a stat() call, allow no code-behind on pages.
David Barts <n5jrn@me.com>
parents:
6
diff
changeset
|
405 return 0 |
|
57ec65f527e9
Eliminate a stat() call, allow no code-behind on pages.
David Barts <n5jrn@me.com>
parents:
6
diff
changeset
|
406 |
| 3 | 407 def _getclass(self): |
|
4
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
408 pypath = os.path.normpath(os.path.join(self._fsroot, *self._splitpath(self._python))) |
|
7
57ec65f527e9
Eliminate a stat() call, allow no code-behind on pages.
David Barts <n5jrn@me.com>
parents:
6
diff
changeset
|
409 # Give 'em a default code-behind if they don't furnish one |
|
57ec65f527e9
Eliminate a stat() call, allow no code-behind on pages.
David Barts <n5jrn@me.com>
parents:
6
diff
changeset
|
410 pytime = self._gettime(pypath) |
|
57ec65f527e9
Eliminate a stat() call, allow no code-behind on pages.
David Barts <n5jrn@me.com>
parents:
6
diff
changeset
|
411 if not pytime: |
|
57ec65f527e9
Eliminate a stat() call, allow no code-behind on pages.
David Barts <n5jrn@me.com>
parents:
6
diff
changeset
|
412 self._class = Page |
|
57ec65f527e9
Eliminate a stat() call, allow no code-behind on pages.
David Barts <n5jrn@me.com>
parents:
6
diff
changeset
|
413 return |
|
57ec65f527e9
Eliminate a stat() call, allow no code-behind on pages.
David Barts <n5jrn@me.com>
parents:
6
diff
changeset
|
414 # Else load the code-behind from a .py file |
| 0 | 415 pycpath = pypath + 'c' |
|
7
57ec65f527e9
Eliminate a stat() call, allow no code-behind on pages.
David Barts <n5jrn@me.com>
parents:
6
diff
changeset
|
416 pyctime = self._gettime(pycpath) |
| 0 | 417 try: |
|
7
57ec65f527e9
Eliminate a stat() call, allow no code-behind on pages.
David Barts <n5jrn@me.com>
parents:
6
diff
changeset
|
418 if pyctime < pytime: |
|
4
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
419 py_compile.compile(pypath, cfile=pycpath, doraise=True) |
|
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
420 except py_compile.PyCompileError as e: |
|
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
421 raise TinCanError(str(e)) from e |
|
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
422 except Exception as e: |
|
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
423 raise TinCanError("{0}: {1!s}".format(pypath, e)) from e |
|
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
424 try: |
|
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
425 spec = importlib.util.spec_from_file_location(_mangle(self._name), pycpath) |
| 0 | 426 mod = importlib.util.module_from_spec(spec) |
| 427 spec.loader.exec_module(mod) | |
| 428 except Exception as e: | |
| 429 raise TinCanError("{0}: error importing".format(pycpath)) from e | |
| 430 self._class = None | |
| 431 for i in dir(mod): | |
| 432 v = getattr(mod, i) | |
|
4
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
433 if isclass(v) and issubclass(v, Page): |
| 0 | 434 if self._class is not None: |
|
4
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
435 raise TinCanError("{0}: contains multiple Page classes".format(pypath)) |
| 0 | 436 self._class = v |
| 3 | 437 if self._class is None: |
|
4
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
438 raise TinCanError("{0}: contains no Page classes".format(pypath)) |
| 0 | 439 |
| 440 def _redirect(self): | |
| 441 try: | |
| 442 rlist = self._splitpath(self._header.forward) | |
|
4
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
443 forw = '/' + '/'.join(rlist) |
|
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
444 if forw in self.seen: |
|
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
445 raise TinCanError("{0}: #forward loop".format(self._origin)) |
|
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
446 self._seen.add(forw) |
| 0 | 447 rname = rlist.pop() |
| 448 except IndexError as e: | |
| 449 raise TinCanError("{0}: invalid #forward".format(self._urlpath)) from e | |
| 450 name, ext = os.path.splitext(rname)[1] | |
| 2 | 451 if ext != _TEXTEN: |
| 0 | 452 raise TinCanError("{0}: invalid #forward".format(self._urlpath)) |
| 453 self._subdir = rlist | |
| 2 | 454 self._python = name + _PEXTEN |
| 0 | 455 self._fspath = os.path.join(self._fsroot, *self._subdir, rname) |
| 456 self._urlpath = self._urljoin(*self._subdir, rname) | |
| 457 | |
| 458 def _urljoin(self, *args): | |
| 459 args = list(args) | |
| 460 if args[0] == '/': | |
| 461 args[0] = '' | |
| 462 return '/'.join(args) | |
| 463 | |
|
1
94b36e721500
Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents:
0
diff
changeset
|
464 def __call__(self): |
| 0 | 465 """ |
| 466 This gets called by the framework AFTER the page is launched. | |
| 467 """ | |
|
1
94b36e721500
Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents:
0
diff
changeset
|
468 target = None |
| 2 | 469 obj = self._class(bottle.request, bottle.response) |
|
1
94b36e721500
Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents:
0
diff
changeset
|
470 try: |
|
94b36e721500
Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents:
0
diff
changeset
|
471 obj.handle() |
| 2 | 472 return self._body.render(obj.export()).lstrip('\n') |
|
1
94b36e721500
Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents:
0
diff
changeset
|
473 except ForwardException as fwd: |
|
94b36e721500
Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents:
0
diff
changeset
|
474 target = fwd.target |
|
94b36e721500
Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents:
0
diff
changeset
|
475 if target is None: |
|
4
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
476 raise TinCanError("{0}: unexpected null target".format(self._urlpath)) |
|
1
94b36e721500
Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents:
0
diff
changeset
|
477 # We get here if we are doing a server-side programmatic |
|
94b36e721500
Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents:
0
diff
changeset
|
478 # forward. |
|
94b36e721500
Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents:
0
diff
changeset
|
479 environ = bottle.request.environ |
|
94b36e721500
Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents:
0
diff
changeset
|
480 if _FORIG not in environ: |
|
94b36e721500
Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents:
0
diff
changeset
|
481 environ[_FORIG] = self._urlpath |
| 2 | 482 if _FLOOP not in environ: |
| 483 environ[_FLOOP] = set([self._urlpath]) | |
|
1
94b36e721500
Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents:
0
diff
changeset
|
484 elif target in environ[_FLOOP]: |
|
4
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
485 raise TinCanError("{0}: forward loop detected".format(environ[_FORIG])) |
|
1
94b36e721500
Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents:
0
diff
changeset
|
486 environ[_FLOOP].add(target) |
|
94b36e721500
Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents:
0
diff
changeset
|
487 environ['bottle.raw_path'] = target |
|
94b36e721500
Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents:
0
diff
changeset
|
488 environ['PATH_INFO'] = urllib.parse.quote(target) |
|
94b36e721500
Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents:
0
diff
changeset
|
489 route, args = self._app.router.match(environ) |
|
94b36e721500
Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents:
0
diff
changeset
|
490 environ['route.handle'] = environ['bottle.route'] = route |
|
94b36e721500
Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents:
0
diff
changeset
|
491 environ['route.url_args'] = args |
|
94b36e721500
Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents:
0
diff
changeset
|
492 return route.call(**args) |
| 0 | 493 |
| 494 def _mkdict(self, obj): | |
| 495 ret = {} | |
| 496 for name in dir(obj): | |
| 497 if name.startswith('_'): | |
| 498 continue | |
| 499 value = getattr(obj, name) | |
| 500 if not callable(value): | |
| 501 ret[name] = value | |
| 502 return ret | |
| 2 | 503 |
| 504 # L a u n c h e r | |
| 505 | |
| 506 _WINF = "WEB-INF" | |
| 507 _BANNED = set([_WINF]) | |
| 508 | |
| 509 class _Launcher(object): | |
| 510 """ | |
| 511 Helper class for launching webapps. | |
| 512 """ | |
|
4
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
513 def __init__(self, fsroot, urlroot, tclass, logger): |
| 2 | 514 """ |
| 515 Lightweight constructor. The real action happens in .launch() below. | |
| 516 """ | |
| 517 self.fsroot = fsroot | |
| 518 self.urlroot = urlroot | |
| 519 self.tclass = tclass | |
|
4
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
520 self.logger = logger |
| 2 | 521 self.app = None |
|
4
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
522 self.errors = 0 |
|
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
523 self.debug = False |
| 2 | 524 |
| 525 def launch(self): | |
| 526 """ | |
| 527 Does the actual work of launching something. XXX - modifies sys.path | |
| 528 and never un-modifies it. | |
| 529 """ | |
| 530 # Sanity checks | |
| 531 if not self.urlroot.startswith("/"): | |
| 532 raise TinCanError("urlroot must be absolute") | |
| 533 if not os.path.isdir(self.fsroot): | |
| 534 raise TinCanError("no such directory: {0!r}".format(self.fsroot)) | |
| 535 # Make WEB-INF, if needed | |
| 536 winf = os.path.join(self.fsroot, _WINF) | |
| 537 lib = os.path.join(winf, "lib") | |
| 538 for i in [ winf, lib ]: | |
| 539 if not os.path.isdir(i): | |
| 540 os.mkdir(i) | |
| 541 # Add our private lib directory to sys.path | |
| 542 sys.path.insert(1, os.path.abspath(lib)) | |
| 543 # Do what we gotta do | |
| 544 self.app = TinCan() | |
| 545 self._launch([]) | |
|
4
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
546 return self |
| 2 | 547 |
| 548 def _launch(self, subdir): | |
| 549 for entry in os.listdir(os.path.join(self.fsroot, *subdir)): | |
| 550 if not subdir and entry in _BANNED: | |
| 551 continue | |
| 552 etype = os.stat(os.path.join(self.fsroot, *subdir, entry)).st_mode | |
| 553 if S_ISREG(etype): | |
| 554 ename, eext = os.path.splitext(entry) | |
| 555 if eext != _TEXTEN: | |
| 556 continue # only look at interesting files | |
|
4
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
557 route = _TinCanRoute(self, ename, subdir) |
|
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
558 try: |
|
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
559 route.launch() |
|
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
560 except TinCanError as e: |
|
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
561 self.logger(str(e)) |
|
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
562 if self.debug: |
|
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
563 while e.__cause__ != None: |
|
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
564 e = e.__cause__ |
|
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
565 self.logger("\t{0}: {1!s}".format(e.__class__.__name__, e)) |
|
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
566 self.errors += 1 |
| 2 | 567 elif S_ISDIR(etype): |
| 568 self._launch(subdir + [entry]) | |
| 569 | |
|
4
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
570 def _logger(message): |
|
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
571 sys.stderr.write(message) |
|
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
572 sys.stderr.write('\n') |
|
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
573 |
|
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
574 def launch(fsroot=None, urlroot='/', tclass=ChameleonTemplate, logger=_logger): |
| 2 | 575 """ |
| 576 Launch and return a TinCan webapp. Does not run the app; it is the | |
| 577 caller's responsibility to call app.run() | |
| 578 """ | |
| 579 if fsroot is None: | |
| 580 fsroot = os.getcwd() | |
|
4
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
581 launcher = _Launcher(fsroot, urlroot, tclass, logger) |
|
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
582 # launcher.debug = True |
|
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
583 launcher.launch() |
|
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
584 return launcher.app, launcher.errors |
|
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
585 |
|
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
586 # XXX - We cannot implement a command-line launcher here; see the |
|
0d47859f792a
Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents:
3
diff
changeset
|
587 # launcher script for why. |