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