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