2 * Sone - JsonPage.java - Copyright © 2010–2016 David Roden
4 * This program is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation, either version 3 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 package net.pterodactylus.sone.web.ajax;
20 import static java.util.logging.Logger.getLogger;
22 import java.io.ByteArrayOutputStream;
23 import java.io.IOException;
24 import java.io.OutputStreamWriter;
25 import java.io.PrintWriter;
27 import java.util.logging.Level;
28 import java.util.logging.Logger;
30 import net.pterodactylus.sone.data.Sone;
31 import net.pterodactylus.sone.web.WebInterface;
32 import net.pterodactylus.sone.web.page.FreenetPage;
33 import net.pterodactylus.sone.web.page.FreenetRequest;
34 import net.pterodactylus.util.io.Closer;
35 import net.pterodactylus.util.web.Page;
36 import net.pterodactylus.util.web.Response;
38 import com.fasterxml.jackson.databind.ObjectMapper;
39 import freenet.clients.http.SessionManager.Session;
40 import freenet.clients.http.ToadletContext;
43 * A JSON page is a specialized {@link Page} that will always return a JSON
44 * object to the browser, e.g. for use with AJAX or other scripting frameworks.
46 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
48 public abstract class JsonPage implements FreenetPage {
51 private static final Logger logger = getLogger(JsonPage.class.getName());
53 /** The JSON serializer. */
54 private static final ObjectMapper objectMapper = new ObjectMapper();
56 /** The path of the page. */
57 private final String path;
59 /** The Sone web interface. */
60 protected final WebInterface webInterface;
63 * Creates a new JSON page at the given path.
66 * The path of the page
68 * The Sone web interface
70 public JsonPage(String path, WebInterface webInterface) {
72 this.webInterface = webInterface;
80 * Returns the current session, creating a new session if there is no
83 * @param toadletContenxt
85 * @return The current session, or {@code null} if there is no current
88 protected Session getCurrentSession(ToadletContext toadletContenxt) {
89 return webInterface.getCurrentSession(toadletContenxt);
93 * Returns the current session, creating a new session if there is no
94 * current session and {@code create} is {@code true}.
96 * @param toadletContenxt
99 * {@code true} to create a new session if there is no current
100 * session, {@code false} otherwise
101 * @return The current session, or {@code null} if there is no current
104 protected Session getCurrentSession(ToadletContext toadletContenxt, boolean create) {
105 return webInterface.getCurrentSession(toadletContenxt, create);
109 * Returns the currently logged in Sone.
111 * @param toadletContext
112 * The toadlet context
113 * @return The currently logged in Sone, or {@code null} if no Sone is
114 * currently logged in
116 protected Sone getCurrentSone(ToadletContext toadletContext) {
117 return webInterface.getCurrentSone(toadletContext);
121 * Returns the currently logged in Sone.
123 * @param toadletContext
124 * The toadlet context
126 * {@code true} to create a new session if no session exists,
127 * {@code false} to not create a new session
128 * @return The currently logged in Sone, or {@code null} if no Sone is
129 * currently logged in
131 protected Sone getCurrentSone(ToadletContext toadletContext, boolean create) {
132 return webInterface.getCurrentSone(toadletContext, create);
136 // METHODS FOR SUBCLASSES TO OVERRIDE
140 * This method is called to create the JSON object that is returned back to
144 * The request to handle
145 * @return The created JSON object
147 protected abstract JsonReturnObject createJsonObject(FreenetRequest request);
150 * Returns whether this command needs the form password for authentication
151 * and to prevent abuse.
153 * @return {@code true} if the form password (given as “formPassword”) is
154 * required, {@code false} otherwise
156 @SuppressWarnings("static-method")
157 protected boolean needsFormPassword() {
162 * Returns whether this page requires the user to be logged in.
164 * @return {@code true} if the user needs to be logged in to use this page,
165 * {@code false} otherwise
167 @SuppressWarnings("static-method")
168 protected boolean requiresLogin() {
177 * Creates a success reply.
179 * @return A reply signaling success
181 protected static JsonReturnObject createSuccessJsonObject() {
182 return new JsonReturnObject(true);
186 * Creates an error reply.
189 * The error that has occured
190 * @return The JSON object, signalling failure and the error code
192 protected static JsonReturnObject createErrorJsonObject(String error) {
193 return new JsonErrorReturnObject(error);
204 public String getPath() {
212 public boolean isPrefixPage() {
220 public Response handleRequest(FreenetRequest request, Response response) throws IOException {
221 if (webInterface.getCore().getPreferences().isRequireFullAccess() && !request.getToadletContext().isAllowedFullAccess()) {
222 return response.setStatusCode(403).setStatusText("Forbidden").setContentType("application/json").write(objectMapper.writeValueAsString(new JsonErrorReturnObject("auth-required")));
224 if (needsFormPassword()) {
225 String formPassword = request.getHttpRequest().getParam("formPassword");
226 if (!webInterface.getFormPassword().equals(formPassword)) {
227 return response.setStatusCode(403).setStatusText("Forbidden").setContentType("application/json").write(objectMapper.writeValueAsString(new JsonErrorReturnObject("auth-required")));
230 if (requiresLogin()) {
231 if (getCurrentSone(request.getToadletContext(), false) == null) {
232 return response.setStatusCode(403).setStatusText("Forbidden").setContentType("application/json").write(objectMapper.writeValueAsString(new JsonErrorReturnObject("auth-required")));
236 JsonReturnObject jsonObject = createJsonObject(request);
237 return response.setStatusCode(200).setStatusText("OK").setContentType("application/json").write(objectMapper.writeValueAsString(jsonObject));
238 } catch (Exception e1) {
239 logger.log(Level.WARNING, "Error executing JSON page!", e1);
240 return response.setStatusCode(500).setStatusText(e1.getMessage()).setContentType("text/plain").write(dumpStackTrace(e1));
248 public boolean isLinkExcepted(URI link) {
257 * Returns a byte array containing the stack trace of the given throwable.
260 * The throwable whose stack trace to dump into an array
261 * @return The array with the stack trace, or an empty array if the stack
262 * trace could not be dumped
264 private static byte[] dumpStackTrace(Throwable t) {
265 ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
266 OutputStreamWriter writer = null;
267 PrintWriter printWriter = null;
269 writer = new OutputStreamWriter(byteArrayOutputStream, "uTF-8");
270 printWriter = new PrintWriter(writer);
271 t.printStackTrace(printWriter);
272 byteArrayOutputStream.flush();
273 return byteArrayOutputStream.toByteArray();
274 } catch (IOException ioe1) {
275 /* quite not possible. */
278 Closer.close(printWriter);
279 Closer.close(writer);
280 Closer.close(byteArrayOutputStream);