-
Notifications
You must be signed in to change notification settings - Fork 226
Expand file tree
/
Copy pathPyServlet.java
More file actions
265 lines (234 loc) · 9.19 KB
/
PyServlet.java
File metadata and controls
265 lines (234 loc) · 9.19 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
package org.python.servlet;
import java.io.File;
import java.io.IOException;
import java.util.Enumeration;
import java.util.Map;
import java.util.Properties;
import java.util.logging.Level;
import java.util.logging.Logger;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import jakarta.servlet.ServletContext;
import jakarta.servlet.ServletException;
import jakarta.servlet.ServletRequest;
import jakarta.servlet.ServletResponse;
import jakarta.servlet.http.HttpServlet;
import jakarta.servlet.http.HttpServletRequest;
import org.python.Version;
import org.python.core.PrePy;
import org.python.core.Py;
import org.python.core.PyException;
import org.python.core.PyObject;
import org.python.core.PyString;
import org.python.core.PySystemState;
import org.python.util.Generic;
import org.python.util.PythonInterpreter;
/**
* This servlet is used to re-serve Jython servlets. It stores bytecode for Jython servlets and
* re-uses it if the underlying .py file has not changed.
* <p>
* e.g. {@code http://localhost:8080/test/hello.py}
* <pre>{@literal
*
* from jakarta.servlet.http import HttpServlet
* class hello(HttpServlet):
* def doGet(self, req, res):
* res.setContentType("text/html");
* out = res.getOutputStream()
* print >>out, "<html>"
* print >>out, "<head><title>Hello World, How are we?</title></head>"
* print >>out, "<body>Hello World, how are we?"
* print >>out, "</body>"
* print >>out, "</html>"
* out.close()
* }</pre>
*
* in web.xml for the PyServlet context:
* <pre>{@literal
* <web-app>
* <servlet>
* <servlet-name>PyServlet</servlet-name>
* <servlet-class>org.python.servlet.PyServlet</servlet-class>
* <init-param>
* <param-name>python.home</param-name>
* <param-value>/usr/home/jython-2.5</param-value>
* </init-param>
* </servlet>
* <servlet-mapping>
* <servlet-name>PyServlet</servlet-name>
* <url-pattern>*.py</url-pattern>
* </servlet-mapping>
* </web-app>
* }</pre>
*/
public class PyServlet extends HttpServlet {
protected static final Logger logger = Logger.getLogger("org.python.servlet");
public static final String SKIP_INIT_NAME = "skip_jython_initialization";
protected static final String INIT_ATTR = "__jython_initialized__";
@Override
public void init() {
logger.log(Level.INFO, "Jython {0} servlet {1}",
new Object[] {Version.PY_VERSION, getServletName()});
// Config parameters
Properties props = new Properties();
Enumeration<?> e = getInitParameterNames();
while (e.hasMoreElements()) {
String name = (String)e.nextElement();
props.put(name, getInitParameter(name));
}
boolean initialize = getServletConfig().getInitParameter(SKIP_INIT_NAME) != null;
if (getServletContext().getAttribute(INIT_ATTR) != null) {
if (initialize) {
logger.log(Level.WARNING, //
"Jython has already been initialized in this context."
+ " Not initializing for ''{0}''."
+ " Add {1} as an init param to this servlet''s configuration"
+ " to indicate this is expected.",
new Object[] {getServletName(), SKIP_INIT_NAME});
}
} else if (initialize) {
init(props, getServletContext());
}
reset();
}
/**
* PyServlet's initialization can be performed as a ServletContextListener or as a regular
* servlet, and this is the shared init code. If both initializations are used in a single
* context, the system state initialization code only runs once.
*/
protected static void init(Properties props, ServletContext context) {
String rootPath = getRootPath(context);
context.setAttribute(INIT_ATTR, true);
Properties baseProps = PrePy.getSystemProperties();
// Context parameters
Enumeration<?> e = context.getInitParameterNames();
while (e.hasMoreElements()) {
String name = (String)e.nextElement();
props.put(name, context.getInitParameter(name));
}
if (props.getProperty("python.home") == null
&& baseProps.getProperty("python.home") == null) {
props.put("python.home", rootPath + "WEB-INF" + File.separator + "lib");
}
PySystemState.initialize(baseProps, props, new String[0]);
PySystemState.add_package("jakarta.servlet");
PySystemState.add_package("jakarta.servlet.http");
PySystemState.add_package("jakarta.servlet.jsp");
PySystemState.add_package("jakarta.servlet.jsp.tagext");
PySystemState.add_classdir(rootPath + "WEB-INF" + File.separator + "classes");
PySystemState.add_extdir(rootPath + "WEB-INF" + File.separator + "lib", true);
}
protected static PythonInterpreter createInterpreter(ServletContext servletContext) {
String rootPath = getRootPath(servletContext);
PySystemState sys = new PySystemState();
PythonInterpreter interp = new PythonInterpreter(Py.newStringMap(), sys);
sys.path.append(new PyString(rootPath));
String modulesDir = rootPath + "WEB-INF" + File.separator + "jython";
sys.path.append(new PyString(modulesDir));
return interp;
}
protected static String getRootPath(ServletContext context) {
String rootPath = context.getRealPath("/");
if (!rootPath.endsWith(File.separator)) {
rootPath += File.separator;
}
return rootPath;
}
@Override
public void service(ServletRequest req, ServletResponse res)
throws ServletException, IOException
{
req.setAttribute("pyservlet", this);
String spath = (String) req.getAttribute("jakarta.servlet.include.servlet_path");
if (spath == null) {
spath = ((HttpServletRequest)req).getServletPath();
if (spath == null || spath.length() == 0) {
// Servlet 2.1 puts the path of an extension-matched servlet in PathInfo.
spath = ((HttpServletRequest)req).getPathInfo();
}
}
String rpath = getServletContext().getRealPath(spath);
getServlet(rpath).service(req, res);
}
@Override
public void destroy() {
super.destroy();
destroyCache();
}
/**
* Clears the cache of loaded servlets and makes a new PythonInterpreter to service further
* requests.
*/
public void reset() {
destroyCache();
interp = createInterpreter(getServletContext());
}
private synchronized HttpServlet getServlet(String path)
throws ServletException, IOException
{
CacheEntry entry = cache.get(path);
if (entry == null || new File(path).lastModified() > entry.date) {
return loadServlet(path);
}
return entry.servlet;
}
private HttpServlet loadServlet(String path)
throws ServletException, IOException
{
File file = new File(path);
HttpServlet servlet = createInstance(interp, file, HttpServlet.class);
try {
servlet.init(getServletConfig());
} catch (PyException e) {
throw new ServletException(e);
}
cache.put(path, new CacheEntry(servlet, file.lastModified()));
return servlet;
}
protected static <T> T createInstance(PythonInterpreter interp, File file, Class<T> type)
throws ServletException {
Matcher m = FIND_NAME.matcher(file.getName());
if (!m.find()) {
throw new ServletException("I can't guess the name of the class from "
+ file.getAbsolutePath());
}
String name = m.group(1);
try {
interp.set("__file__", file.getAbsolutePath());
interp.execfile(file.getAbsolutePath());
PyObject cls = interp.get(name);
if (cls == null) {
throw new ServletException("No callable (class or function) named " + name + " in "
+ file.getAbsolutePath());
}
PyObject pyServlet = cls.__call__();
Object o = pyServlet.__tojava__(type);
if (o == Py.NoConversion) {
throw new ServletException("The value from " + name + " must extend "
+ type.getSimpleName());
}
@SuppressWarnings("unchecked")
T asT = (T)o;
return asT;
} catch (PyException e) {
throw new ServletException(e);
}
}
private void destroyCache() {
for (CacheEntry entry : cache.values()) {
entry.servlet.destroy();
}
cache.clear();
}
private static class CacheEntry {
public long date;
public HttpServlet servlet;
CacheEntry(HttpServlet servlet, long date) {
this.servlet = servlet;
this.date = date;
}
}
private static final Pattern FIND_NAME = Pattern.compile("([^/]+)\\.py$");
private PythonInterpreter interp;
private Map<String, CacheEntry> cache = Generic.map();
}