annotate tincan.py @ 45:969f515b505b draft

Make it easy to leave stdout and stderr alone (untested).
author David Barts <n5jrn@me.com>
date Thu, 30 May 2019 14:44:09 -0700
parents 7261459351fa
children 997d0c8c174f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
1 #!/usr/bin/env python3
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
2 # -*- coding: utf-8 -*-
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
3 # As with Bottle, it's all in one big, ugly file. For now.
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
4
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
5 # I m p o r t s
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
6
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
7 import os, sys
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
8 import ast
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
9 import binascii
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
10 from base64 import b16encode, b16decode
40
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
11 import email.utils
4
0d47859f792a Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents: 3
diff changeset
12 import functools
2
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
13 import importlib
4
0d47859f792a Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents: 3
diff changeset
14 from inspect import isclass
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
15 import io
45
969f515b505b Make it easy to leave stdout and stderr alone (untested).
David Barts <n5jrn@me.com>
parents: 44
diff changeset
16 import logging
40
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
17 import mimetypes
2
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
18 import py_compile
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
19 from stat import S_ISDIR, S_ISREG
5
31bb8400e6e3 Add #end header, fix #errors.
David Barts <n5jrn@me.com>
parents: 4
diff changeset
20 from string import whitespace
43
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
21 from threading import Lock
40
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
22 import time
17
8186de188daf Improve the run-time error handling in code-behinds.
David Barts <n5jrn@me.com>
parents: 16
diff changeset
23 import urllib
45
969f515b505b Make it easy to leave stdout and stderr alone (untested).
David Barts <n5jrn@me.com>
parents: 44
diff changeset
24 import uuid
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
25
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
26 import bottle
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
27
2
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
28 # E x c e p t i o n s
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
29
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
30 class TinCanException(Exception):
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
31 """
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
32 The parent class of all exceptions we raise.
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
33 """
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
34 pass
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
35
9
75e375b1976a Error pages now can have code-behind.
David Barts <n5jrn@me.com>
parents: 8
diff changeset
36 class TemplateHeaderError(TinCanException):
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
37 """
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
38 Raised upon encountering a syntax error in the template headers.
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
39 """
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
40 def __init__(self, message, line):
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
41 super().__init__(message, line)
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
42 self.message = message
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
43 self.line = line
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
44
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
45 def __str__(self):
4
0d47859f792a Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents: 3
diff changeset
46 return "line {0}: {1}".format(self.line, self.message)
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
47
35
41da0b3d2156 Rename #include to #load (more descriptive).
David Barts <n5jrn@me.com>
parents: 34
diff changeset
48 class LoadError(TinCanException):
24
34d3cfcd37ef First batch of work on getting a #include header. Unfinished.
David Barts <n5jrn@me.com>
parents: 23
diff changeset
49 """
35
41da0b3d2156 Rename #include to #load (more descriptive).
David Barts <n5jrn@me.com>
parents: 34
diff changeset
50 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
51 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
52 """
34d3cfcd37ef First batch of work on getting a #include header. Unfinished.
David Barts <n5jrn@me.com>
parents: 23
diff changeset
53 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
54 super().__init__(message, source)
34d3cfcd37ef First batch of work on getting a #include header. Unfinished.
David Barts <n5jrn@me.com>
parents: 23
diff changeset
55 self.message = message
34d3cfcd37ef First batch of work on getting a #include header. Unfinished.
David Barts <n5jrn@me.com>
parents: 23
diff changeset
56 self.source = source
34d3cfcd37ef First batch of work on getting a #include header. Unfinished.
David Barts <n5jrn@me.com>
parents: 23
diff changeset
57
34d3cfcd37ef First batch of work on getting a #include header. Unfinished.
David Barts <n5jrn@me.com>
parents: 23
diff changeset
58 def __str__(self):
35
41da0b3d2156 Rename #include to #load (more descriptive).
David Barts <n5jrn@me.com>
parents: 34
diff changeset
59 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
60
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
61 class ForwardException(TinCanException):
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
62 """
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
63 Raised to effect the flow control needed to do a forward (server-side
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
64 redirect). It is ugly to do this, but other Python frameworks do and
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
65 there seems to be no good alternative.
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
66 """
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
67 def __init__(self, target):
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
68 self.target = target
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
69
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
70 class TinCanError(TinCanException):
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
71 """
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
72 General-purpose exception thrown by TinCan when things go wrong, often
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
73 when attempting to launch webapps.
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
74 """
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
75 pass
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
76
2
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
77 # T e m p l a t e s
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
78 #
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
79 # Template (.pspx) files. These are standard templates for a supported
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
80 # template engine, but with an optional set of header lines that begin
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
81 # with '#'.
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
82
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
83 class TemplateFile(object):
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
84 """
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
85 Parse a template file into a header part and the body part. The header
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
86 is always a leading set of lines, each starting with '#', that is of the
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
87 same format regardless of the template body. The template body varies
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
88 depending on the selected templating engine. The body part has
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
89 each header line replaced by a blank line. This preserves the overall
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
90 line numbering when processing the body. The added newlines are normally
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
91 stripped out before the rendered page is sent back to the client.
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
92 """
5
31bb8400e6e3 Add #end header, fix #errors.
David Barts <n5jrn@me.com>
parents: 4
diff changeset
93 _END = "#end"
31bb8400e6e3 Add #end header, fix #errors.
David Barts <n5jrn@me.com>
parents: 4
diff changeset
94 _LEND = len(_END)
31bb8400e6e3 Add #end header, fix #errors.
David Barts <n5jrn@me.com>
parents: 4
diff changeset
95 _WS = set(whitespace)
31bb8400e6e3 Add #end header, fix #errors.
David Barts <n5jrn@me.com>
parents: 4
diff changeset
96
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
97 def __init__(self, raw, encoding='utf-8'):
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
98 if isinstance(raw, io.TextIOBase):
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
99 self._do_init(raw)
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
100 elif isinstance(raw, str):
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
101 with open(raw, "r", encoding=encoding) as fp:
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
102 self._do_init(fp)
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
103 else:
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
104 raise TypeError("Expecting a string or Text I/O object.")
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
105
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
106 def _do_init(self, fp):
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
107 self._hbuf = []
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
108 self._bbuf = []
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
109 self._state = self._header
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
110 while True:
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
111 line = fp.readline()
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
112 if line == '':
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
113 break
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
114 self._state(line)
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
115 self.header = ''.join(self._hbuf)
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
116 self.body = ''.join(self._bbuf)
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
117
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
118 def _header(self, line):
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
119 if not line.startswith('#'):
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
120 self._state = self._body
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
121 self._state(line)
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
122 return
5
31bb8400e6e3 Add #end header, fix #errors.
David Barts <n5jrn@me.com>
parents: 4
diff changeset
123 if line.startswith(self._END) and (len(line) == self._LEND or line[self._LEND] in self._WS):
31bb8400e6e3 Add #end header, fix #errors.
David Barts <n5jrn@me.com>
parents: 4
diff changeset
124 self._state = self._body
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
125 self._hbuf.append(line)
36
4ed261056057 Put old newline logic back.
David Barts <n5jrn@me.com>
parents: 35
diff changeset
126 self._bbuf.append("\n")
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
127
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
128 def _body(self, line):
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
129 self._bbuf.append(line)
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
130
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
131 class TemplateHeader(object):
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
132 """
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
133 Parses and represents a set of header lines.
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
134 """
2
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
135 _NAMES = [ "errors", "forward", "methods", "python", "template" ]
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
136 _FNAMES = [ "hidden" ]
35
41da0b3d2156 Rename #include to #load (more descriptive).
David Barts <n5jrn@me.com>
parents: 34
diff changeset
137 _ANAMES = [ "load" ]
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
138
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
139 def __init__(self, string):
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
140 # Initialize our state
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
141 for i in self._NAMES:
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
142 setattr(self, i, None)
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
143 for i in self._FNAMES:
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
144 setattr(self, i, False)
25
e93e5e746cc5 Preliminary debugging, still not fully tested.
David Barts <n5jrn@me.com>
parents: 24
diff changeset
145 for i in self._ANAMES:
e93e5e746cc5 Preliminary debugging, still not fully tested.
David Barts <n5jrn@me.com>
parents: 24
diff changeset
146 setattr(self, i, [])
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
147 # Parse the string
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
148 count = 0
25
e93e5e746cc5 Preliminary debugging, still not fully tested.
David Barts <n5jrn@me.com>
parents: 24
diff changeset
149 nameset = set(self._NAMES + self._FNAMES + self._ANAMES)
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
150 seen = set()
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
151 lines = string.split("\n")
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
152 if lines and lines[-1] == "":
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
153 del lines[-1]
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
154 for line in lines:
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
155 # Get line
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
156 count += 1
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
157 if not line.startswith("#"):
9
75e375b1976a Error pages now can have code-behind.
David Barts <n5jrn@me.com>
parents: 8
diff changeset
158 raise TemplateHeaderError("Does not start with '#'.", count)
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
159 try:
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
160 rna, rpa = line.split(maxsplit=1)
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
161 except ValueError:
5
31bb8400e6e3 Add #end header, fix #errors.
David Barts <n5jrn@me.com>
parents: 4
diff changeset
162 rna = line.rstrip()
31bb8400e6e3 Add #end header, fix #errors.
David Barts <n5jrn@me.com>
parents: 4
diff changeset
163 rpa = None
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
164 # Get name, ignoring remarks.
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
165 name = rna[1:]
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
166 if name == "rem":
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
167 continue
5
31bb8400e6e3 Add #end header, fix #errors.
David Barts <n5jrn@me.com>
parents: 4
diff changeset
168 if name == "end":
31bb8400e6e3 Add #end header, fix #errors.
David Barts <n5jrn@me.com>
parents: 4
diff changeset
169 break
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
170 if name not in nameset:
9
75e375b1976a Error pages now can have code-behind.
David Barts <n5jrn@me.com>
parents: 8
diff changeset
171 raise TemplateHeaderError("Invalid directive: {0!r}".format(rna), count)
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
172 if name in seen:
9
75e375b1976a Error pages now can have code-behind.
David Barts <n5jrn@me.com>
parents: 8
diff changeset
173 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
174 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
175 seen.add(name)
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
176 # Flags
5
31bb8400e6e3 Add #end header, fix #errors.
David Barts <n5jrn@me.com>
parents: 4
diff changeset
177 if name in self._FNAMES:
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
178 setattr(self, name, True)
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
179 continue
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
180 # Get parameter
5
31bb8400e6e3 Add #end header, fix #errors.
David Barts <n5jrn@me.com>
parents: 4
diff changeset
181 if rpa is None:
9
75e375b1976a Error pages now can have code-behind.
David Barts <n5jrn@me.com>
parents: 8
diff changeset
182 raise TemplateHeaderError("Missing parameter.", count)
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
183 param = rpa.strip()
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
184 for i in [ "'", '"']:
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
185 if param.startswith(i) and param.endswith(i):
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
186 param = ast.literal_eval(param)
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
187 break
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
188 # Update this object
24
34d3cfcd37ef First batch of work on getting a #include header. Unfinished.
David Barts <n5jrn@me.com>
parents: 23
diff changeset
189 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
190 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
191 else:
34d3cfcd37ef First batch of work on getting a #include header. Unfinished.
David Barts <n5jrn@me.com>
parents: 23
diff changeset
192 setattr(self, name, param)
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
193
23
e8b6ee7e5b6b Well, *that* attempt at includes didn't work. Revert.
David Barts <n5jrn@me.com>
parents: 22
diff changeset
194 # C h a m e l e o n
2
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
195 #
35
41da0b3d2156 Rename #include to #load (more descriptive).
David Barts <n5jrn@me.com>
parents: 34
diff changeset
196 # Support for Chameleon templates (the kind TinCan uses).
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
197
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
198 class ChameleonTemplate(bottle.BaseTemplate):
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
199 def prepare(self, **options):
23
e8b6ee7e5b6b Well, *that* attempt at includes didn't work. Revert.
David Barts <n5jrn@me.com>
parents: 22
diff changeset
200 from chameleon import PageTemplate, PageTemplateFile
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
201 if self.source:
37
ce67eac10fc7 Allow global character encoding specification.
David Barts <n5jrn@me.com>
parents: 36
diff changeset
202 self.tpl = PageTemplate(self.source, **options)
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
203 else:
4
0d47859f792a Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents: 3
diff changeset
204 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
205 search_path=self.lookup, **options)
37
ce67eac10fc7 Allow global character encoding specification.
David Barts <n5jrn@me.com>
parents: 36
diff changeset
206 # XXX - work around broken Chameleon decoding
ce67eac10fc7 Allow global character encoding specification.
David Barts <n5jrn@me.com>
parents: 36
diff changeset
207 self.tpl.default_encoding = self.encoding
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
208
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
209 def render(self, *args, **kwargs):
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
210 for dictarg in args:
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
211 kwargs.update(dictarg)
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
212 _defaults = self.defaults.copy()
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
213 _defaults.update(kwargs)
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
214 return self.tpl.render(**_defaults)
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
215
4
0d47859f792a Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents: 3
diff changeset
216 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
217 chameleon_view = functools.partial(bottle.view, template_adapter=ChameleonTemplate)
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
218
2
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
219 # U t i l i t i e s
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
220
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
221 def _normpath(base, unsplit):
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
222 """
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
223 Split, normalize and ensure a possibly relative path is absolute. First
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
224 argument is a list of directory names, defining a base. Second
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
225 argument is a string, which may either be relative to that base, or
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
226 absolute. Only '/' is supported as a separator.
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
227 """
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
228 scratch = unsplit.strip('/').split('/')
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
229 if not unsplit.startswith('/'):
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
230 scratch = base + scratch
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
231 ret = []
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
232 for i in scratch:
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
233 if i == '.':
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
234 continue
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
235 if i == '..':
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
236 ret.pop() # may raise IndexError
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
237 continue
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
238 ret.append(i)
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
239 return ret
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
240
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
241 def _mangle(string):
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
242 """
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
243 Turn a possibly troublesome identifier into a mangled one.
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
244 """
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
245 first = True
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
246 ret = []
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
247 for ch in string:
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
248 if ch == '_' or not (ch if first else "x" + ch).isidentifier():
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
249 ret.append('_')
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
250 ret.append(b16encode(ch.encode("utf-8")).decode("us-ascii"))
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
251 else:
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
252 ret.append(ch)
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
253 first = False
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
254 return ''.join(ret)
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
255
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
256 # The TinCan class. Simply a Bottle webapp that contains a forward method, so
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
257 # the code-behind can call request.app.forward().
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
258
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
259 class TinCan(bottle.Bottle):
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
260 def forward(self, target):
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
261 """
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
262 Forward this request to the specified target route.
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
263 """
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
264 source = bottle.request.environ['PATH_INFO']
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
265 base = source.strip('/').split('/')[:-1]
9
75e375b1976a Error pages now can have code-behind.
David Barts <n5jrn@me.com>
parents: 8
diff changeset
266 if bottle.request.environ.get(_FTYPE, False):
75e375b1976a Error pages now can have code-behind.
David Barts <n5jrn@me.com>
parents: 8
diff changeset
267 raise TinCanError("{0}: forward from error page".format(source))
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
268 try:
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
269 exc = ForwardException('/' + '/'.join(_normpath(base, target)))
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
270 except IndexError as e:
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
271 raise TinCanError("{0}: invalid forward to {1!r}".format(source, target)) from e
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
272 raise exc
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
273
2
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
274 # C o d e B e h i n d
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
275 #
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
276 # Represents the code-behind of one of our pages. This gets subclassed, of
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
277 # course.
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
278
9
75e375b1976a Error pages now can have code-behind.
David Barts <n5jrn@me.com>
parents: 8
diff changeset
279 class BasePage(object):
75e375b1976a Error pages now can have code-behind.
David Barts <n5jrn@me.com>
parents: 8
diff changeset
280 """
11
8037bad7d5a8 Update documentation, fix some #forward bugs.
David Barts <n5jrn@me.com>
parents: 9
diff changeset
281 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
282 """
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
283 def handle(self):
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
284 """
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
285 This is the entry point for the code-behind logic. It is intended
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
286 to be overridden.
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
287 """
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
288 pass
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
289
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
290 def export(self):
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
291 """
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
292 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
293 non-hidden non-callables that don't start with an underscore.
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
294 This method can be overridden if a different behavior is
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
295 desired. It should always return a dict or dict-like object.
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
296 """
9
75e375b1976a Error pages now can have code-behind.
David Barts <n5jrn@me.com>
parents: 8
diff changeset
297 ret = { 'page': self }
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
298 for name in dir(self):
9
75e375b1976a Error pages now can have code-behind.
David Barts <n5jrn@me.com>
parents: 8
diff changeset
299 if name in self._HIDDEN or name.startswith('_'):
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
300 continue
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
301 value = getattr(self, name)
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
302 if callable(value):
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
303 continue
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
304 ret[name] = value
4
0d47859f792a Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents: 3
diff changeset
305 return ret
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
306
9
75e375b1976a Error pages now can have code-behind.
David Barts <n5jrn@me.com>
parents: 8
diff changeset
307 class Page(BasePage):
11
8037bad7d5a8 Update documentation, fix some #forward bugs.
David Barts <n5jrn@me.com>
parents: 9
diff changeset
308 """
8037bad7d5a8 Update documentation, fix some #forward bugs.
David Barts <n5jrn@me.com>
parents: 9
diff changeset
309 The code-behind for a normal page.
8037bad7d5a8 Update documentation, fix some #forward bugs.
David Barts <n5jrn@me.com>
parents: 9
diff changeset
310 """
9
75e375b1976a Error pages now can have code-behind.
David Barts <n5jrn@me.com>
parents: 8
diff changeset
311 # 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
312 _HIDDEN = set([ "request", "response" ])
75e375b1976a Error pages now can have code-behind.
David Barts <n5jrn@me.com>
parents: 8
diff changeset
313
75e375b1976a Error pages now can have code-behind.
David Barts <n5jrn@me.com>
parents: 8
diff changeset
314 def __init__(self, req, 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 Constructor. This is a lightweight operation.
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 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
319 self.response = resp
75e375b1976a Error pages now can have code-behind.
David Barts <n5jrn@me.com>
parents: 8
diff changeset
320
75e375b1976a Error pages now can have code-behind.
David Barts <n5jrn@me.com>
parents: 8
diff changeset
321 class ErrorPage(BasePage):
75e375b1976a Error pages now can have code-behind.
David Barts <n5jrn@me.com>
parents: 8
diff changeset
322 """
75e375b1976a Error pages now can have code-behind.
David Barts <n5jrn@me.com>
parents: 8
diff changeset
323 The code-behind for an error page.
75e375b1976a Error pages now can have code-behind.
David Barts <n5jrn@me.com>
parents: 8
diff changeset
324 """
75e375b1976a Error pages now can have code-behind.
David Barts <n5jrn@me.com>
parents: 8
diff changeset
325 _HIDDEN = set()
75e375b1976a Error pages now can have code-behind.
David Barts <n5jrn@me.com>
parents: 8
diff changeset
326
75e375b1976a Error pages now can have code-behind.
David Barts <n5jrn@me.com>
parents: 8
diff changeset
327 def __init__(self, req, err):
75e375b1976a Error pages now can have code-behind.
David Barts <n5jrn@me.com>
parents: 8
diff changeset
328 """
75e375b1976a Error pages now can have code-behind.
David Barts <n5jrn@me.com>
parents: 8
diff changeset
329 Constructor. This is a lightweight operation.
75e375b1976a Error pages now can have code-behind.
David Barts <n5jrn@me.com>
parents: 8
diff changeset
330 """
75e375b1976a Error pages now can have code-behind.
David Barts <n5jrn@me.com>
parents: 8
diff changeset
331 self.request = req
75e375b1976a Error pages now can have code-behind.
David Barts <n5jrn@me.com>
parents: 8
diff changeset
332 self.error = err
75e375b1976a Error pages now can have code-behind.
David Barts <n5jrn@me.com>
parents: 8
diff changeset
333
24
34d3cfcd37ef First batch of work on getting a #include header. Unfinished.
David Barts <n5jrn@me.com>
parents: 23
diff changeset
334 # 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
335 #
29
2e3ac3d7b0a4 A possible workaround for the drainbamage (needs testing)?
David Barts <n5jrn@me.com>
parents: 26
diff changeset
336 # 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
337 # 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
338
35
41da0b3d2156 Rename #include to #load (more descriptive).
David Barts <n5jrn@me.com>
parents: 34
diff changeset
339 class _LoadedFile(object):
29
2e3ac3d7b0a4 A possible workaround for the drainbamage (needs testing)?
David Barts <n5jrn@me.com>
parents: 26
diff changeset
340 def __init__(self, raw):
2e3ac3d7b0a4 A possible workaround for the drainbamage (needs testing)?
David Barts <n5jrn@me.com>
parents: 26
diff changeset
341 if raw.startswith('<') and raw.endswith('>'):
2e3ac3d7b0a4 A possible workaround for the drainbamage (needs testing)?
David Barts <n5jrn@me.com>
parents: 26
diff changeset
342 raw = raw[1:-1]
2e3ac3d7b0a4 A possible workaround for the drainbamage (needs testing)?
David Barts <n5jrn@me.com>
parents: 26
diff changeset
343 self.in_lib = True
2e3ac3d7b0a4 A possible workaround for the drainbamage (needs testing)?
David Barts <n5jrn@me.com>
parents: 26
diff changeset
344 else:
2e3ac3d7b0a4 A possible workaround for the drainbamage (needs testing)?
David Barts <n5jrn@me.com>
parents: 26
diff changeset
345 self.in_lib = False
31
443a0001d841 Improve the #include syntax a bit.
David Barts <n5jrn@me.com>
parents: 30
diff changeset
346 equals = raw.find('=')
443a0001d841 Improve the #include syntax a bit.
David Barts <n5jrn@me.com>
parents: 30
diff changeset
347 if equals < 0:
33
cc975bf7a3fa Fix bug in auto-generated include variables.
David Barts <n5jrn@me.com>
parents: 32
diff changeset
348 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
349 self.fname = raw
443a0001d841 Improve the #include syntax a bit.
David Barts <n5jrn@me.com>
parents: 30
diff changeset
350 else:
443a0001d841 Improve the #include syntax a bit.
David Barts <n5jrn@me.com>
parents: 30
diff changeset
351 self.vname = raw[:equals]
443a0001d841 Improve the #include syntax a bit.
David Barts <n5jrn@me.com>
parents: 30
diff changeset
352 self.fname = raw[equals+1:]
29
2e3ac3d7b0a4 A possible workaround for the drainbamage (needs testing)?
David Barts <n5jrn@me.com>
parents: 26
diff changeset
353 if self.vname == "":
2e3ac3d7b0a4 A possible workaround for the drainbamage (needs testing)?
David Barts <n5jrn@me.com>
parents: 26
diff changeset
354 raise ValueError("empty variable name")
2e3ac3d7b0a4 A possible workaround for the drainbamage (needs testing)?
David Barts <n5jrn@me.com>
parents: 26
diff changeset
355 if self.fname == "":
2e3ac3d7b0a4 A possible workaround for the drainbamage (needs testing)?
David Barts <n5jrn@me.com>
parents: 26
diff changeset
356 raise ValueError("empty file name")
2e3ac3d7b0a4 A possible workaround for the drainbamage (needs testing)?
David Barts <n5jrn@me.com>
parents: 26
diff changeset
357 if not self.fname.endswith(_IEXTEN):
2e3ac3d7b0a4 A possible workaround for the drainbamage (needs testing)?
David Barts <n5jrn@me.com>
parents: 26
diff changeset
358 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
359
34
0fb455b46e5f Add cache.
David Barts <n5jrn@me.com>
parents: 33
diff changeset
360 # Using a cache is likely to help efficiency a lot, since many pages
43
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
361 # will typically #load the same standard stuff. Except if we're
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
362 # multithreading, then we want each page's templates to be private.
34
0fb455b46e5f Add cache.
David Barts <n5jrn@me.com>
parents: 33
diff changeset
363 _tcache = {}
43
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
364 def _get_template_cache(name, direct, coding):
34
0fb455b46e5f Add cache.
David Barts <n5jrn@me.com>
parents: 33
diff changeset
365 aname = os.path.abspath(os.path.join(direct, name))
0fb455b46e5f Add cache.
David Barts <n5jrn@me.com>
parents: 33
diff changeset
366 if aname not in _tcache:
37
ce67eac10fc7 Allow global character encoding specification.
David Barts <n5jrn@me.com>
parents: 36
diff changeset
367 tmpl = ChameleonTemplate(name=name, lookup=[direct], encoding=coding)
34
0fb455b46e5f Add cache.
David Barts <n5jrn@me.com>
parents: 33
diff changeset
368 assert aname == tmpl.filename
0fb455b46e5f Add cache.
David Barts <n5jrn@me.com>
parents: 33
diff changeset
369 _tcache[aname] = tmpl
0fb455b46e5f Add cache.
David Barts <n5jrn@me.com>
parents: 33
diff changeset
370 return _tcache[aname]
0fb455b46e5f Add cache.
David Barts <n5jrn@me.com>
parents: 33
diff changeset
371
43
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
372 def _get_template_nocache(name, direct, coding):
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
373 return ChameleonTemplate(name=name, lookup=[direct], encoding=coding)
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
374
2
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
375 # R o u t e s
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
376 #
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
377 # Represents a route in TinCan. Our launcher creates these on-the-fly based
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
378 # on the files it finds.
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
379
2
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
380 _ERRMIN = 400
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
381 _ERRMAX = 599
29
2e3ac3d7b0a4 A possible workaround for the drainbamage (needs testing)?
David Barts <n5jrn@me.com>
parents: 26
diff changeset
382 _IEXTEN = ".pt"
2
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
383 _PEXTEN = ".py"
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
384 _TEXTEN = ".pspx"
1
94b36e721500 Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents: 0
diff changeset
385 _FLOOP = "tincan.forwards"
94b36e721500 Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents: 0
diff changeset
386 _FORIG = "tincan.origin"
9
75e375b1976a Error pages now can have code-behind.
David Barts <n5jrn@me.com>
parents: 8
diff changeset
387 _FTYPE = "tincan.iserror"
1
94b36e721500 Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents: 0
diff changeset
388
43
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
389 class _TinCanBaseRoute(object):
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
390 """
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
391 The base class for all NON ERROR routes. Error routes are just a little
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
392 bit different.
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
393 """
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
394 def __init__(self, launcher, name, subdir):
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
395 global _get_template_cache, _get_template_nocache
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
396 if launcher.multithread:
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
397 self.lock = Lock()
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
398 self.get_template = _get_template_nocache
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
399 else:
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
400 self.lock = _DummyLock()
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
401 self.get_template = _get_template_cache
45
969f515b505b Make it easy to leave stdout and stderr alone (untested).
David Barts <n5jrn@me.com>
parents: 44
diff changeset
402 self.logger = launcher.logger
43
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
403
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
404 def urljoin(self, *args):
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
405 """
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
406 Normalize a parsed-out URL fragment.
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
407 """
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
408 args = list(args)
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
409 if args[0] == '/':
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
410 args[0] = ''
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
411 return '/'.join(args)
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
412
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
413 def launch(self):
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
414 raise NotImplementedError("This must be overridden.")
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
415
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
416 def __call__(self):
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
417 raise NotImplementedError("This must be overridden.")
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
418
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
419 class _TinCanStaticRoute(_TinCanBaseRoute):
40
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
420 """
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
421 A route to a static file. These are useful for test servers. For
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
422 production servers, one is better off using a real web server and
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
423 a WSGI plugin, and having that handle static files. Much of this
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
424 logic is cribbed from the Bottle source code (we don't call it
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
425 directly because it is undocumented and thus subject to change).
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
426 """
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
427 def __init__(self, launcher, name, subdir):
43
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
428 super().__init__(launcher, name, subdir)
40
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
429 self._app = launcher.app
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
430 self._fspath = os.path.join(launcher.fsroot, *subdir, name)
43
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
431 self._urlpath = self.urljoin(launcher.urlroot, *subdir, name)
40
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
432 self._type = mimetypes.guess_type(name)[0]
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
433 if self._type is None:
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
434 self._type = "application/octet-stream"
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
435 if self._type.startswith("text/"):
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
436 self._encoding = launcher.encoding
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
437 self._type += "; charset=" + launcher.encoding
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
438 else:
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
439 self._encoding = None
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
440
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
441 def launch(self):
45
969f515b505b Make it easy to leave stdout and stderr alone (untested).
David Barts <n5jrn@me.com>
parents: 44
diff changeset
442 self.logger.info("adding static route: %s", self._urlpath)
40
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
443 self._app.route(self._urlpath, 'GET', self)
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
444
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
445 def _parse_date(self, ims):
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
446 """
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
447 Parse rfc1123, rfc850 and asctime timestamps and return UTC epoch.
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
448 """
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
449 try:
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
450 ts = email.utils.parsedate_tz(ims)
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
451 return time.mktime(ts[:8] + (0,)) - (ts[9] or 0) - time.timezone
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
452 except (TypeError, ValueError, IndexError, OverflowError):
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
453 return None
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
454
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
455 def __call__(self):
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
456 # Get file contents and time stamp. If we can't, return an
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
457 # appropriate HTTP error response.
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
458 try:
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
459 with open(self._fspath, "rb") as fp:
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
460 mtime = os.fstat(fp.fileno()).st_mtime
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
461 bytes = fp.read()
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
462 except FileNotFoundError as e:
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
463 return bottle.HTTPError(status=404, exception=e)
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
464 except PermissionError as e:
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
465 return bottle.HTTPError(status=403, exception=e)
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
466 except OSError as e:
45
969f515b505b Make it easy to leave stdout and stderr alone (untested).
David Barts <n5jrn@me.com>
parents: 44
diff changeset
467 self.logger.exception("unexpected exception reading %r", self._fspath)
40
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
468 return bottle.HTTPError(status=500, exception=e)
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
469 # Establish preliminary standard headers.
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
470 headers = {
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
471 "Content-Type": self._type,
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
472 "Last-Modified": time.strftime("%a, %d %b %Y %H:%M:%S GMT", time.gmtime(mtime)),
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
473 }
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
474 if self._encoding:
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
475 headers["Content-Encoding"] = self._encoding
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
476 # Support the If-Modified-Since request header.
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
477 ims = bottle.request.environ.get('HTTP_IF_MODIFIED_SINCE')
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
478 if ims:
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
479 ims = self._parse_date(ims.split(";")[0].strip())
41
9335865ae0bb Fix bug.
David Barts <n5jrn@me.com>
parents: 40
diff changeset
480 if ims is not None and ims >= int(mtime):
40
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
481 headers["Content-Length"] = "0"
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
482 return bottle.HTTPResponse(body=b"", status=304, headers=headers)
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
483 # Standard response.
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
484 headers["Content-Length"] = str(len(bytes))
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
485 return bottle.HTTPResponse(body=bytes, status=200, headers=headers)
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
486
4
0d47859f792a Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents: 3
diff changeset
487 class _TinCanErrorRoute(object):
1
94b36e721500 Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents: 0
diff changeset
488 """
9
75e375b1976a Error pages now can have code-behind.
David Barts <n5jrn@me.com>
parents: 8
diff changeset
489 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
490 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
491 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
492 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
493 """
45
969f515b505b Make it easy to leave stdout and stderr alone (untested).
David Barts <n5jrn@me.com>
parents: 44
diff changeset
494 def __init__(self, template, loads, klass, lock, logger):
1
94b36e721500 Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents: 0
diff changeset
495 self._template = template
23
e8b6ee7e5b6b Well, *that* attempt at includes didn't work. Revert.
David Barts <n5jrn@me.com>
parents: 22
diff changeset
496 self._template.prepare()
35
41da0b3d2156 Rename #include to #load (more descriptive).
David Barts <n5jrn@me.com>
parents: 34
diff changeset
497 self._loads = loads
9
75e375b1976a Error pages now can have code-behind.
David Barts <n5jrn@me.com>
parents: 8
diff changeset
498 self._class = klass
43
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
499 self.lock = lock
45
969f515b505b Make it easy to leave stdout and stderr alone (untested).
David Barts <n5jrn@me.com>
parents: 44
diff changeset
500 self.logger = logger
1
94b36e721500 Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents: 0
diff changeset
501
94b36e721500 Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents: 0
diff changeset
502 def __call__(self, e):
11
8037bad7d5a8 Update documentation, fix some #forward bugs.
David Barts <n5jrn@me.com>
parents: 9
diff changeset
503 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
504 try:
8186de188daf Improve the run-time error handling in code-behinds.
David Barts <n5jrn@me.com>
parents: 16
diff changeset
505 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
506 obj.handle()
35
41da0b3d2156 Rename #include to #load (more descriptive).
David Barts <n5jrn@me.com>
parents: 34
diff changeset
507 tvars = self._loads.copy()
29
2e3ac3d7b0a4 A possible workaround for the drainbamage (needs testing)?
David Barts <n5jrn@me.com>
parents: 26
diff changeset
508 tvars.update(obj.export())
43
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
509 with self.lock:
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
510 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
511 except bottle.HTTPResponse as e:
8186de188daf Improve the run-time error handling in code-behinds.
David Barts <n5jrn@me.com>
parents: 16
diff changeset
512 return e
8186de188daf Improve the run-time error handling in code-behinds.
David Barts <n5jrn@me.com>
parents: 16
diff changeset
513 except Exception as e:
45
969f515b505b Make it easy to leave stdout and stderr alone (untested).
David Barts <n5jrn@me.com>
parents: 44
diff changeset
514 self.logger.exception("unexpected exception in error page")
18
e88ab99914cf More improvements to the error reportage.
David Barts <n5jrn@me.com>
parents: 17
diff changeset
515 # 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
516 # 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
517 # 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
518 # 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
519 # ignored.
17
8186de188daf Improve the run-time error handling in code-behinds.
David Barts <n5jrn@me.com>
parents: 16
diff changeset
520 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
521
43
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
522 class _TinCanRoute(_TinCanBaseRoute):
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
523 """
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
524 A route created by the TinCan launcher.
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
525 """
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
526 def __init__(self, launcher, name, subdir):
43
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
527 super().__init__(launcher, name, subdir)
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
528 self._fsroot = launcher.fsroot
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
529 self._urlroot = launcher.urlroot
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
530 self._name = name
2
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
531 self._python = name + _PEXTEN
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
532 self._fspath = os.path.join(launcher.fsroot, *subdir, name + _TEXTEN)
43
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
533 self._urlpath = self.urljoin(launcher.urlroot, *subdir, name + _TEXTEN)
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
534 self._origin = self._urlpath
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
535 self._subdir = subdir
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
536 self._seen = set()
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
537 self._app = launcher.app
37
ce67eac10fc7 Allow global character encoding specification.
David Barts <n5jrn@me.com>
parents: 36
diff changeset
538 self._encoding = launcher.encoding
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
539
2
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
540 def launch(self):
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
541 """
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
542 Launch a single page.
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
543 """
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
544 # 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
545 oheader = None
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
546 while True:
11
8037bad7d5a8 Update documentation, fix some #forward bugs.
David Barts <n5jrn@me.com>
parents: 9
diff changeset
547 try:
8037bad7d5a8 Update documentation, fix some #forward bugs.
David Barts <n5jrn@me.com>
parents: 9
diff changeset
548 self._template = TemplateFile(self._fspath)
8037bad7d5a8 Update documentation, fix some #forward bugs.
David Barts <n5jrn@me.com>
parents: 9
diff changeset
549 except IOError as e:
12
496d43d551d2 More redirecting fixes and improved error reportage.
David Barts <n5jrn@me.com>
parents: 11
diff changeset
550 if oheader is not None:
496d43d551d2 More redirecting fixes and improved error reportage.
David Barts <n5jrn@me.com>
parents: 11
diff changeset
551 note = "{0}: invalid #forward: ".format(self._origin)
496d43d551d2 More redirecting fixes and improved error reportage.
David Barts <n5jrn@me.com>
parents: 11
diff changeset
552 else:
496d43d551d2 More redirecting fixes and improved error reportage.
David Barts <n5jrn@me.com>
parents: 11
diff changeset
553 note = ""
496d43d551d2 More redirecting fixes and improved error reportage.
David Barts <n5jrn@me.com>
parents: 11
diff changeset
554 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
555 try:
0d47859f792a Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents: 3
diff changeset
556 self._header = TemplateHeader(self._template.header)
9
75e375b1976a Error pages now can have code-behind.
David Barts <n5jrn@me.com>
parents: 8
diff changeset
557 except TemplateHeaderError as e:
4
0d47859f792a Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents: 3
diff changeset
558 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
559 if oheader is None:
8037bad7d5a8 Update documentation, fix some #forward bugs.
David Barts <n5jrn@me.com>
parents: 9
diff changeset
560 oheader = self._header # save original header
8037bad7d5a8 Update documentation, fix some #forward bugs.
David Barts <n5jrn@me.com>
parents: 9
diff changeset
561 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
562 raise TinCanError("{0}: invalid #forward".format(self._origin))
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
563 if self._header.forward is None:
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
564 break
45
969f515b505b Make it easy to leave stdout and stderr alone (untested).
David Barts <n5jrn@me.com>
parents: 44
diff changeset
565 # self.logger.debug("forwarding from: %s", self._urlpath) # debug
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
566 self._redirect()
45
969f515b505b Make it easy to leave stdout and stderr alone (untested).
David Barts <n5jrn@me.com>
parents: 44
diff changeset
567 # self.logger.debug("forwarded to: %s", self._urlpath) # debug
4
0d47859f792a Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents: 3
diff changeset
568 # If this is a #hidden page, we ignore it for now, since hidden pages
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
569 # don't get routes made for them.
11
8037bad7d5a8 Update documentation, fix some #forward bugs.
David Barts <n5jrn@me.com>
parents: 9
diff changeset
570 if oheader.hidden and not oheader.errors:
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
571 return
4
0d47859f792a Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents: 3
diff changeset
572 # 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
573 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
574 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
575 else:
2
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
576 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
577 raise TinCanError("{0}: #python files must end in {1}".format(self._urlpath, _PEXTEN))
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
578 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
579 self._python_specified = True
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
580 # Obtain a class object by importing and introspecting a module.
3
c6902cded64d Corrections and reorg.
David Barts <n5jrn@me.com>
parents: 2
diff changeset
581 self._getclass()
35
41da0b3d2156 Rename #include to #load (more descriptive).
David Barts <n5jrn@me.com>
parents: 34
diff changeset
582 # Build body object (#template) and obtain #loads.
3
c6902cded64d Corrections and reorg.
David Barts <n5jrn@me.com>
parents: 2
diff changeset
583 if self._header.template is not None:
c6902cded64d Corrections and reorg.
David Barts <n5jrn@me.com>
parents: 2
diff changeset
584 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
585 raise TinCanError("{0}: #template files must end in {1}".format(self._urlpath, _TEXTEN))
16
448fc3d534f8 Improve error reportage.
David Barts <n5jrn@me.com>
parents: 15
diff changeset
586 try:
29
2e3ac3d7b0a4 A possible workaround for the drainbamage (needs testing)?
David Barts <n5jrn@me.com>
parents: 26
diff changeset
587 rtpath = self._splitpath(self._header.template)
2e3ac3d7b0a4 A possible workaround for the drainbamage (needs testing)?
David Barts <n5jrn@me.com>
parents: 26
diff changeset
588 tpath = os.path.normpath(os.path.join(self._fsroot, *rtpath))
16
448fc3d534f8 Improve error reportage.
David Barts <n5jrn@me.com>
parents: 15
diff changeset
589 tfile = TemplateFile(tpath)
29
2e3ac3d7b0a4 A possible workaround for the drainbamage (needs testing)?
David Barts <n5jrn@me.com>
parents: 26
diff changeset
590 except OSError as e:
16
448fc3d534f8 Improve error reportage.
David Barts <n5jrn@me.com>
parents: 15
diff changeset
591 raise TinCanError("{0}: invalid #template: {1!s}".format(self._urlpath, e)) from e
448fc3d534f8 Improve error reportage.
David Barts <n5jrn@me.com>
parents: 15
diff changeset
592 except IndexError as e:
448fc3d534f8 Improve error reportage.
David Barts <n5jrn@me.com>
parents: 15
diff changeset
593 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
594 self._body = ChameleonTemplate(source=tfile.body, encoding=self._encoding)
3
c6902cded64d Corrections and reorg.
David Barts <n5jrn@me.com>
parents: 2
diff changeset
595 else:
37
ce67eac10fc7 Allow global character encoding specification.
David Barts <n5jrn@me.com>
parents: 36
diff changeset
596 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
597 self._body.prepare()
35
41da0b3d2156 Rename #include to #load (more descriptive).
David Barts <n5jrn@me.com>
parents: 34
diff changeset
598 # Process loads
41da0b3d2156 Rename #include to #load (more descriptive).
David Barts <n5jrn@me.com>
parents: 34
diff changeset
599 self._loads = {}
41da0b3d2156 Rename #include to #load (more descriptive).
David Barts <n5jrn@me.com>
parents: 34
diff changeset
600 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
601 try:
35
41da0b3d2156 Rename #include to #load (more descriptive).
David Barts <n5jrn@me.com>
parents: 34
diff changeset
602 load = _LoadedFile(load)
29
2e3ac3d7b0a4 A possible workaround for the drainbamage (needs testing)?
David Barts <n5jrn@me.com>
parents: 26
diff changeset
603 except ValueError as e:
35
41da0b3d2156 Rename #include to #load (more descriptive).
David Barts <n5jrn@me.com>
parents: 34
diff changeset
604 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
605 if load.in_lib:
29
2e3ac3d7b0a4 A possible workaround for the drainbamage (needs testing)?
David Barts <n5jrn@me.com>
parents: 26
diff changeset
606 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
607 else:
32
3382799f3905 Refinements.
David Barts <n5jrn@me.com>
parents: 31
diff changeset
608 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
609 try:
43
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
610 tmpl = self.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
611 except Exception as e:
35
41da0b3d2156 Rename #include to #load (more descriptive).
David Barts <n5jrn@me.com>
parents: 34
diff changeset
612 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
613 self._loads[load.vname] = tmpl.tpl
9
75e375b1976a Error pages now can have code-behind.
David Barts <n5jrn@me.com>
parents: 8
diff changeset
614 # 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
615 if oheader.errors is not None:
8037bad7d5a8 Update documentation, fix some #forward bugs.
David Barts <n5jrn@me.com>
parents: 9
diff changeset
616 self._mkerror(oheader.errors)
9
75e375b1976a Error pages now can have code-behind.
David Barts <n5jrn@me.com>
parents: 8
diff changeset
617 return # this implies #hidden
75e375b1976a Error pages now can have code-behind.
David Barts <n5jrn@me.com>
parents: 8
diff changeset
618 # Get #methods for this route
75e375b1976a Error pages now can have code-behind.
David Barts <n5jrn@me.com>
parents: 8
diff changeset
619 if self._header.methods is None:
75e375b1976a Error pages now can have code-behind.
David Barts <n5jrn@me.com>
parents: 8
diff changeset
620 methods = [ 'GET' ]
75e375b1976a Error pages now can have code-behind.
David Barts <n5jrn@me.com>
parents: 8
diff changeset
621 else:
75e375b1976a Error pages now can have code-behind.
David Barts <n5jrn@me.com>
parents: 8
diff changeset
622 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
623 if not methods:
75e375b1976a Error pages now can have code-behind.
David Barts <n5jrn@me.com>
parents: 8
diff changeset
624 raise TinCanError("{0}: no #methods specified".format(self._urlpath))
3
c6902cded64d Corrections and reorg.
David Barts <n5jrn@me.com>
parents: 2
diff changeset
625 # Register this thing with Bottle
45
969f515b505b Make it easy to leave stdout and stderr alone (untested).
David Barts <n5jrn@me.com>
parents: 44
diff changeset
626 self.logger.info("adding route: %s (%s)", self._origin, ','.join(methods))
3
c6902cded64d Corrections and reorg.
David Barts <n5jrn@me.com>
parents: 2
diff changeset
627 self._app.route(self._origin, methods, self)
c6902cded64d Corrections and reorg.
David Barts <n5jrn@me.com>
parents: 2
diff changeset
628
c6902cded64d Corrections and reorg.
David Barts <n5jrn@me.com>
parents: 2
diff changeset
629 def _splitpath(self, unsplit):
c6902cded64d Corrections and reorg.
David Barts <n5jrn@me.com>
parents: 2
diff changeset
630 return _normpath(self._subdir, unsplit)
c6902cded64d Corrections and reorg.
David Barts <n5jrn@me.com>
parents: 2
diff changeset
631
11
8037bad7d5a8 Update documentation, fix some #forward bugs.
David Barts <n5jrn@me.com>
parents: 9
diff changeset
632 def _mkerror(self, rerrors):
3
c6902cded64d Corrections and reorg.
David Barts <n5jrn@me.com>
parents: 2
diff changeset
633 try:
11
8037bad7d5a8 Update documentation, fix some #forward bugs.
David Barts <n5jrn@me.com>
parents: 9
diff changeset
634 errors = [ int(i) for i in rerrors.split() ]
3
c6902cded64d Corrections and reorg.
David Barts <n5jrn@me.com>
parents: 2
diff changeset
635 except ValueError as e:
c6902cded64d Corrections and reorg.
David Barts <n5jrn@me.com>
parents: 2
diff changeset
636 raise TinCanError("{0}: bad #errors line".format(self._urlpath)) from e
c6902cded64d Corrections and reorg.
David Barts <n5jrn@me.com>
parents: 2
diff changeset
637 if not errors:
c6902cded64d Corrections and reorg.
David Barts <n5jrn@me.com>
parents: 2
diff changeset
638 errors = range(_ERRMIN, _ERRMAX+1)
37
ce67eac10fc7 Allow global character encoding specification.
David Barts <n5jrn@me.com>
parents: 36
diff changeset
639 route = _TinCanErrorRoute(
ce67eac10fc7 Allow global character encoding specification.
David Barts <n5jrn@me.com>
parents: 36
diff changeset
640 ChameleonTemplate(source=self._template.body, encoding=self._encoding),
45
969f515b505b Make it easy to leave stdout and stderr alone (untested).
David Barts <n5jrn@me.com>
parents: 44
diff changeset
641 self._loads, self._class, self.lock, self.logger)
3
c6902cded64d Corrections and reorg.
David Barts <n5jrn@me.com>
parents: 2
diff changeset
642 for error in errors:
c6902cded64d Corrections and reorg.
David Barts <n5jrn@me.com>
parents: 2
diff changeset
643 if error < _ERRMIN or error > _ERRMAX:
c6902cded64d Corrections and reorg.
David Barts <n5jrn@me.com>
parents: 2
diff changeset
644 raise TinCanError("{0}: bad #errors code".format(self._urlpath))
5
31bb8400e6e3 Add #end header, fix #errors.
David Barts <n5jrn@me.com>
parents: 4
diff changeset
645 self._app.error_handler[error] = route # XXX
3
c6902cded64d Corrections and reorg.
David Barts <n5jrn@me.com>
parents: 2
diff changeset
646
7
57ec65f527e9 Eliminate a stat() call, allow no code-behind on pages.
David Barts <n5jrn@me.com>
parents: 6
diff changeset
647 def _gettime(self, path):
57ec65f527e9 Eliminate a stat() call, allow no code-behind on pages.
David Barts <n5jrn@me.com>
parents: 6
diff changeset
648 try:
57ec65f527e9 Eliminate a stat() call, allow no code-behind on pages.
David Barts <n5jrn@me.com>
parents: 6
diff changeset
649 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
650 except FileNotFoundError:
57ec65f527e9 Eliminate a stat() call, allow no code-behind on pages.
David Barts <n5jrn@me.com>
parents: 6
diff changeset
651 return 0
8
9aaa91247b14 Fix minor buglet.
David Barts <n5jrn@me.com>
parents: 7
diff changeset
652 except OSError as e:
9
75e375b1976a Error pages now can have code-behind.
David Barts <n5jrn@me.com>
parents: 8
diff changeset
653 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
654
3
c6902cded64d Corrections and reorg.
David Barts <n5jrn@me.com>
parents: 2
diff changeset
655 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
656 try:
560c8fb55e4a Fix bugs in #python directive, make code-behind class loading simpler.
David Barts <n5jrn@me.com>
parents: 14
diff changeset
657 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
658 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
659 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
660 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
661 # 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
662 pytime = self._gettime(pypath)
57ec65f527e9 Eliminate a stat() call, allow no code-behind on pages.
David Barts <n5jrn@me.com>
parents: 6
diff changeset
663 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
664 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
665 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
666 self._class = klass
7
57ec65f527e9 Eliminate a stat() call, allow no code-behind on pages.
David Barts <n5jrn@me.com>
parents: 6
diff changeset
667 return
57ec65f527e9 Eliminate a stat() call, allow no code-behind on pages.
David Barts <n5jrn@me.com>
parents: 6
diff changeset
668 # Else load the code-behind from a .py file
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
669 pycpath = pypath + 'c'
7
57ec65f527e9 Eliminate a stat() call, allow no code-behind on pages.
David Barts <n5jrn@me.com>
parents: 6
diff changeset
670 pyctime = self._gettime(pycpath)
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
671 try:
7
57ec65f527e9 Eliminate a stat() call, allow no code-behind on pages.
David Barts <n5jrn@me.com>
parents: 6
diff changeset
672 if pyctime < pytime:
4
0d47859f792a Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents: 3
diff changeset
673 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
674 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
675 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
676 except Exception as e:
0d47859f792a Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents: 3
diff changeset
677 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
678 try:
0d47859f792a Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents: 3
diff changeset
679 spec = importlib.util.spec_from_file_location(_mangle(self._name), pycpath)
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
680 mod = importlib.util.module_from_spec(spec)
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
681 spec.loader.exec_module(mod)
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
682 except Exception as e:
16
448fc3d534f8 Improve error reportage.
David Barts <n5jrn@me.com>
parents: 15
diff changeset
683 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
684 # 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
685 # we can find in the inheritance tree.
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
686 self._class = None
19
5d9a1b82251a Return the "deepest" subclass; this allows subclassing tincan.Page and
David Barts <n5jrn@me.com>
parents: 18
diff changeset
687 score = -1
5d9a1b82251a Return the "deepest" subclass; this allows subclassing tincan.Page and
David Barts <n5jrn@me.com>
parents: 18
diff changeset
688 ambig = False
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
689 for i in dir(mod):
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
690 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
691 if not isclass(v):
5d9a1b82251a Return the "deepest" subclass; this allows subclassing tincan.Page and
David Barts <n5jrn@me.com>
parents: 18
diff changeset
692 continue
5d9a1b82251a Return the "deepest" subclass; this allows subclassing tincan.Page and
David Barts <n5jrn@me.com>
parents: 18
diff changeset
693 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
694 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
695 self._class = v
19
5d9a1b82251a Return the "deepest" subclass; this allows subclassing tincan.Page and
David Barts <n5jrn@me.com>
parents: 18
diff changeset
696 score = d
5d9a1b82251a Return the "deepest" subclass; this allows subclassing tincan.Page and
David Barts <n5jrn@me.com>
parents: 18
diff changeset
697 ambig = False
5d9a1b82251a Return the "deepest" subclass; this allows subclassing tincan.Page and
David Barts <n5jrn@me.com>
parents: 18
diff changeset
698 elif d == score:
5d9a1b82251a Return the "deepest" subclass; this allows subclassing tincan.Page and
David Barts <n5jrn@me.com>
parents: 18
diff changeset
699 ambig = True
3
c6902cded64d Corrections and reorg.
David Barts <n5jrn@me.com>
parents: 2
diff changeset
700 if self._class is None:
9
75e375b1976a Error pages now can have code-behind.
David Barts <n5jrn@me.com>
parents: 8
diff changeset
701 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
702 if ambig:
5d9a1b82251a Return the "deepest" subclass; this allows subclassing tincan.Page and
David Barts <n5jrn@me.com>
parents: 18
diff changeset
703 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
704
5d9a1b82251a Return the "deepest" subclass; this allows subclassing tincan.Page and
David Barts <n5jrn@me.com>
parents: 18
diff changeset
705 # 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
706 # 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
707 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
708 if klass is object:
5d9a1b82251a Return the "deepest" subclass; this allows subclassing tincan.Page and
David Barts <n5jrn@me.com>
parents: 18
diff changeset
709 # not found
5d9a1b82251a Return the "deepest" subclass; this allows subclassing tincan.Page and
David Barts <n5jrn@me.com>
parents: 18
diff changeset
710 return -1
5d9a1b82251a Return the "deepest" subclass; this allows subclassing tincan.Page and
David Barts <n5jrn@me.com>
parents: 18
diff changeset
711 elif klass is base:
5d9a1b82251a Return the "deepest" subclass; this allows subclassing tincan.Page and
David Barts <n5jrn@me.com>
parents: 18
diff changeset
712 # just found
5d9a1b82251a Return the "deepest" subclass; this allows subclassing tincan.Page and
David Barts <n5jrn@me.com>
parents: 18
diff changeset
713 return count
5d9a1b82251a Return the "deepest" subclass; this allows subclassing tincan.Page and
David Barts <n5jrn@me.com>
parents: 18
diff changeset
714 else:
5d9a1b82251a Return the "deepest" subclass; this allows subclassing tincan.Page and
David Barts <n5jrn@me.com>
parents: 18
diff changeset
715 # must recurse
5d9a1b82251a Return the "deepest" subclass; this allows subclassing tincan.Page and
David Barts <n5jrn@me.com>
parents: 18
diff changeset
716 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
717 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
718 if result > 0:
5d9a1b82251a Return the "deepest" subclass; this allows subclassing tincan.Page and
David Barts <n5jrn@me.com>
parents: 18
diff changeset
719 return result
5d9a1b82251a Return the "deepest" subclass; this allows subclassing tincan.Page and
David Barts <n5jrn@me.com>
parents: 18
diff changeset
720 return -1
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
721
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
722 def _redirect(self):
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
723 try:
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
724 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
725 forw = '/' + '/'.join(rlist)
11
8037bad7d5a8 Update documentation, fix some #forward bugs.
David Barts <n5jrn@me.com>
parents: 9
diff changeset
726 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
727 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
728 self._seen.add(forw)
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
729 rname = rlist.pop()
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
730 except IndexError as e:
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
731 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
732 name, ext = os.path.splitext(rname)
2
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
733 if ext != _TEXTEN:
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
734 raise TinCanError("{0}: invalid #forward".format(self._urlpath))
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
735 self._subdir = rlist
2
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
736 self._python = name + _PEXTEN
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
737 self._fspath = os.path.join(self._fsroot, *self._subdir, rname)
43
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
738 self._urlpath = '/' + self.urljoin(*self._subdir, rname)
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
739
1
94b36e721500 Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents: 0
diff changeset
740 def __call__(self):
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
741 """
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
742 This gets called by the framework AFTER the page is launched.
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
743 """
1
94b36e721500 Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents: 0
diff changeset
744 target = None
94b36e721500 Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents: 0
diff changeset
745 try:
17
8186de188daf Improve the run-time error handling in code-behinds.
David Barts <n5jrn@me.com>
parents: 16
diff changeset
746 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
747 obj.handle()
35
41da0b3d2156 Rename #include to #load (more descriptive).
David Barts <n5jrn@me.com>
parents: 34
diff changeset
748 tvars = self._loads.copy()
29
2e3ac3d7b0a4 A possible workaround for the drainbamage (needs testing)?
David Barts <n5jrn@me.com>
parents: 26
diff changeset
749 tvars.update(obj.export())
43
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
750 with self.lock:
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
751 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
752 except ForwardException as fwd:
94b36e721500 Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents: 0
diff changeset
753 target = fwd.target
17
8186de188daf Improve the run-time error handling in code-behinds.
David Barts <n5jrn@me.com>
parents: 16
diff changeset
754 except bottle.HTTPResponse as e:
8186de188daf Improve the run-time error handling in code-behinds.
David Barts <n5jrn@me.com>
parents: 16
diff changeset
755 return e
8186de188daf Improve the run-time error handling in code-behinds.
David Barts <n5jrn@me.com>
parents: 16
diff changeset
756 except Exception as e:
45
969f515b505b Make it easy to leave stdout and stderr alone (untested).
David Barts <n5jrn@me.com>
parents: 44
diff changeset
757 self.logger.exception("%s: unexpected exception", self._urlpath)
17
8186de188daf Improve the run-time error handling in code-behinds.
David Barts <n5jrn@me.com>
parents: 16
diff changeset
758 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
759 if target is None:
45
969f515b505b Make it easy to leave stdout and stderr alone (untested).
David Barts <n5jrn@me.com>
parents: 44
diff changeset
760 self.logger.error("%s: unexpected null target", self._urlpath)
17
8186de188daf Improve the run-time error handling in code-behinds.
David Barts <n5jrn@me.com>
parents: 16
diff changeset
761 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
762 # 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
763 # forward.
94b36e721500 Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents: 0
diff changeset
764 environ = bottle.request.environ
94b36e721500 Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents: 0
diff changeset
765 if _FORIG not in environ:
94b36e721500 Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents: 0
diff changeset
766 environ[_FORIG] = self._urlpath
2
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
767 if _FLOOP not in environ:
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
768 environ[_FLOOP] = set([self._urlpath])
1
94b36e721500 Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents: 0
diff changeset
769 elif target in environ[_FLOOP]:
45
969f515b505b Make it easy to leave stdout and stderr alone (untested).
David Barts <n5jrn@me.com>
parents: 44
diff changeset
770 self.logger.error("%s: forward loop detected", environ[_FORIG])
17
8186de188daf Improve the run-time error handling in code-behinds.
David Barts <n5jrn@me.com>
parents: 16
diff changeset
771 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
772 environ[_FLOOP].add(target)
94b36e721500 Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents: 0
diff changeset
773 environ['bottle.raw_path'] = target
94b36e721500 Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents: 0
diff changeset
774 environ['PATH_INFO'] = urllib.parse.quote(target)
94b36e721500 Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents: 0
diff changeset
775 route, args = self._app.router.match(environ)
94b36e721500 Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents: 0
diff changeset
776 environ['route.handle'] = environ['bottle.route'] = route
94b36e721500 Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents: 0
diff changeset
777 environ['route.url_args'] = args
94b36e721500 Another check in to back stuff up.
David Barts <n5jrn@me.com>
parents: 0
diff changeset
778 return route.call(**args)
0
e726fafcffac For backup purposes, UNFINISHED!!
David Barts <n5jrn@me.com>
parents:
diff changeset
779
43
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
780 # M u t e x
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
781 #
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
782 # A dummy lock class, which is what we use if we don't need locking.
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
783
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
784 class _DummyLock(object):
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
785 def acquire(self, blocking=True, timeout=-1):
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
786 pass
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
787
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
788 def release(self):
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
789 pass
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
790
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
791 def __enter__(self):
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
792 self.acquire()
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
793 return self
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
794
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
795 def __exit__(self, exc_type, exc_value, traceback):
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
796 self.release()
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
797 return False
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
798
2
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
799 # L a u n c h e r
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
800
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
801 _WINF = "WEB-INF"
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
802 _BANNED = set([_WINF])
40
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
803 _EBANNED = set([_IEXTEN, _TEXTEN, _PEXTEN, _PEXTEN+"c"])
37
ce67eac10fc7 Allow global character encoding specification.
David Barts <n5jrn@me.com>
parents: 36
diff changeset
804 ENCODING = "utf-8"
2
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
805
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
806 class _Launcher(object):
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
807 """
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
808 Helper class for launching webapps.
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
809 """
45
969f515b505b Make it easy to leave stdout and stderr alone (untested).
David Barts <n5jrn@me.com>
parents: 44
diff changeset
810 def __init__(self, fsroot, urlroot, multithread):
2
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
811 """
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
812 Lightweight constructor. The real action happens in .launch() below.
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
813 """
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
814 self.fsroot = fsroot
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
815 self.urlroot = urlroot
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
816 self.app = None
4
0d47859f792a Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents: 3
diff changeset
817 self.errors = 0
0d47859f792a Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents: 3
diff changeset
818 self.debug = False
37
ce67eac10fc7 Allow global character encoding specification.
David Barts <n5jrn@me.com>
parents: 36
diff changeset
819 self.encoding = ENCODING
40
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
820 self.static = False
43
0bd9b9ae9998 Make it thread-safe.
David Barts <n5jrn@me.com>
parents: 42
diff changeset
821 self.multithread = multithread
45
969f515b505b Make it easy to leave stdout and stderr alone (untested).
David Barts <n5jrn@me.com>
parents: 44
diff changeset
822 self.logger = None
2
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
823
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
824 def launch(self):
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
825 """
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
826 Does the actual work of launching something. XXX - modifies sys.path
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
827 and never un-modifies it.
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
828 """
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
829 # Sanity checks
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
830 if not self.urlroot.startswith("/"):
18
e88ab99914cf More improvements to the error reportage.
David Barts <n5jrn@me.com>
parents: 17
diff changeset
831 self.errors = 1
e88ab99914cf More improvements to the error reportage.
David Barts <n5jrn@me.com>
parents: 17
diff changeset
832 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
833 return self
2
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
834 if not os.path.isdir(self.fsroot):
18
e88ab99914cf More improvements to the error reportage.
David Barts <n5jrn@me.com>
parents: 17
diff changeset
835 self.errors = 1
e88ab99914cf More improvements to the error reportage.
David Barts <n5jrn@me.com>
parents: 17
diff changeset
836 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
837 return self
e88ab99914cf More improvements to the error reportage.
David Barts <n5jrn@me.com>
parents: 17
diff changeset
838 # 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
839 # 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
840 # directory trees containing sensitive files.
2
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
841 winf = os.path.join(self.fsroot, _WINF)
18
e88ab99914cf More improvements to the error reportage.
David Barts <n5jrn@me.com>
parents: 17
diff changeset
842 if not os.path.isdir(winf):
e88ab99914cf More improvements to the error reportage.
David Barts <n5jrn@me.com>
parents: 17
diff changeset
843 self.errors = 1
e88ab99914cf More improvements to the error reportage.
David Barts <n5jrn@me.com>
parents: 17
diff changeset
844 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
845 return self
2
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
846 lib = os.path.join(winf, "lib")
18
e88ab99914cf More improvements to the error reportage.
David Barts <n5jrn@me.com>
parents: 17
diff changeset
847 for i in [ lib ]:
2
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
848 if not os.path.isdir(i):
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
849 os.mkdir(i)
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
850 # Add our private lib directory to sys.path
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
851 sys.path.insert(1, os.path.abspath(lib))
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
852 # Do what we gotta do
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
853 self.app = TinCan()
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
854 self._launch([])
4
0d47859f792a Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents: 3
diff changeset
855 return self
2
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
856
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
857 def _launch(self, subdir):
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
858 for entry in os.listdir(os.path.join(self.fsroot, *subdir)):
42
8948020c54fd Remove some debug deadwood, ignore hidden files.
David Barts <n5jrn@me.com>
parents: 41
diff changeset
859 if entry.startswith("."):
8948020c54fd Remove some debug deadwood, ignore hidden files.
David Barts <n5jrn@me.com>
parents: 41
diff changeset
860 continue # hidden file
2
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
861 if not subdir and entry in _BANNED:
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
862 continue
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
863 etype = os.stat(os.path.join(self.fsroot, *subdir, entry)).st_mode
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
864 if S_ISREG(etype):
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
865 ename, eext = os.path.splitext(entry)
40
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
866 if eext == _TEXTEN:
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
867 route = _TinCanRoute(self, ename, subdir)
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
868 else:
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
869 if eext in _EBANNED:
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
870 continue
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
871 if self.static:
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
872 route = _TinCanStaticRoute(self, entry, subdir)
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
873 else:
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
874 continue
4
0d47859f792a Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents: 3
diff changeset
875 try:
0d47859f792a Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents: 3
diff changeset
876 route.launch()
0d47859f792a Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents: 3
diff changeset
877 except TinCanError as e:
45
969f515b505b Make it easy to leave stdout and stderr alone (untested).
David Barts <n5jrn@me.com>
parents: 44
diff changeset
878 if self.logger.getEffectiveLevel() <= logging.DEBUG:
969f515b505b Make it easy to leave stdout and stderr alone (untested).
David Barts <n5jrn@me.com>
parents: 44
diff changeset
879 self.logger.exception(str(e))
969f515b505b Make it easy to leave stdout and stderr alone (untested).
David Barts <n5jrn@me.com>
parents: 44
diff changeset
880 else:
969f515b505b Make it easy to leave stdout and stderr alone (untested).
David Barts <n5jrn@me.com>
parents: 44
diff changeset
881 self.logger.error(str(e))
4
0d47859f792a Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents: 3
diff changeset
882 self.errors += 1
2
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
883 elif S_ISDIR(etype):
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
884 self._launch(subdir + [entry])
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
885
45
969f515b505b Make it easy to leave stdout and stderr alone (untested).
David Barts <n5jrn@me.com>
parents: 44
diff changeset
886 def launch(fsroot=None, urlroot='/', logger=None, debug=False,
44
7261459351fa More multithread support, remove debug writes.
David Barts <n5jrn@me.com>
parents: 43
diff changeset
887 encoding=ENCODING, static=False, multithread=True):
2
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
888 """
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
889 Launch and return a TinCan webapp. Does not run the app; it is the
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
890 caller's responsibility to call app.run()
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
891 """
45
969f515b505b Make it easy to leave stdout and stderr alone (untested).
David Barts <n5jrn@me.com>
parents: 44
diff changeset
892 if logger is None:
969f515b505b Make it easy to leave stdout and stderr alone (untested).
David Barts <n5jrn@me.com>
parents: 44
diff changeset
893 logger = logging.getLogger("{0!s}-{1!s}".format(__name__, uuid.uuid1()))
969f515b505b Make it easy to leave stdout and stderr alone (untested).
David Barts <n5jrn@me.com>
parents: 44
diff changeset
894 logger.addHandler(logging.StreamHandler())
969f515b505b Make it easy to leave stdout and stderr alone (untested).
David Barts <n5jrn@me.com>
parents: 44
diff changeset
895 logger.setLevel(logging.DEBUG if debug else logging.INFO)
2
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
896 if fsroot is None:
ca6f8ca38cf2 Another backup commit.
David Barts <n5jrn@me.com>
parents: 1
diff changeset
897 fsroot = os.getcwd()
45
969f515b505b Make it easy to leave stdout and stderr alone (untested).
David Barts <n5jrn@me.com>
parents: 44
diff changeset
898 launcher = _Launcher(fsroot, urlroot, multithread)
969f515b505b Make it easy to leave stdout and stderr alone (untested).
David Barts <n5jrn@me.com>
parents: 44
diff changeset
899 launcher.logger = logger
37
ce67eac10fc7 Allow global character encoding specification.
David Barts <n5jrn@me.com>
parents: 36
diff changeset
900 launcher.encoding = encoding
40
df27cf08c093 Add support for serving static files.
David Barts <n5jrn@me.com>
parents: 37
diff changeset
901 launcher.static = static
4
0d47859f792a Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents: 3
diff changeset
902 launcher.launch()
0d47859f792a Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents: 3
diff changeset
903 return launcher.app, launcher.errors
0d47859f792a Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents: 3
diff changeset
904
0d47859f792a Finally got "hello, world" working. Still likely many bugs.
David Barts <n5jrn@me.com>
parents: 3
diff changeset
905 # 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
906 # launcher script for why.