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 javax.annotation.Nonnull;
32 import net.pterodactylus.sone.data.Sone;
33 import net.pterodactylus.sone.web.SessionProvider;
34 import net.pterodactylus.sone.web.WebInterface;
35 import net.pterodactylus.sone.web.page.FreenetPage;
36 import net.pterodactylus.sone.web.page.FreenetRequest;
37 import net.pterodactylus.util.io.Closer;
38 import net.pterodactylus.util.web.Page;
39 import net.pterodactylus.util.web.Response;
41 import com.fasterxml.jackson.databind.ObjectMapper;
42 import freenet.clients.http.ToadletContext;
45 * A JSON page is a specialized {@link Page} that will always return a JSON
46 * object to the browser, e.g. for use with AJAX or other scripting frameworks.
48 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
50 public abstract class JsonPage implements FreenetPage {
53 private static final Logger logger = getLogger(JsonPage.class.getName());
55 /** The JSON serializer. */
56 private static final ObjectMapper objectMapper = new ObjectMapper();
58 /** The path of the page. */
59 private final String path;
61 /** The Sone web interface. */
62 protected final WebInterface webInterface;
63 private final SessionProvider sessionProvider;
66 * Creates a new JSON page at the given path.
69 * The path of the page
71 * The Sone web interface
73 public JsonPage(String path, WebInterface webInterface) {
75 this.webInterface = webInterface;
76 this.sessionProvider = webInterface;
83 protected Sone getCurrentSone(ToadletContext toadletContext) {
84 return sessionProvider.getCurrentSone(toadletContext, true);
87 protected Sone getCurrentSone(ToadletContext toadletContext, boolean createSession) {
88 return sessionProvider.getCurrentSone(toadletContext, createSession);
92 // METHODS FOR SUBCLASSES TO OVERRIDE
96 * This method is called to create the JSON object that is returned back to
100 * The request to handle
101 * @return The created JSON object
104 protected abstract JsonReturnObject createJsonObject(@Nonnull FreenetRequest request);
107 * Returns whether this command needs the form password for authentication
108 * and to prevent abuse.
110 * @return {@code true} if the form password (given as “formPassword”) is
111 * required, {@code false} otherwise
113 @SuppressWarnings("static-method")
114 protected boolean needsFormPassword() {
119 * Returns whether this page requires the user to be logged in.
121 * @return {@code true} if the user needs to be logged in to use this page,
122 * {@code false} otherwise
124 @SuppressWarnings("static-method")
125 protected boolean requiresLogin() {
134 * Creates a success reply.
136 * @return A reply signaling success
139 protected static JsonReturnObject createSuccessJsonObject() {
140 return new JsonReturnObject(true);
144 * Creates an error reply.
147 * The error that has occured
148 * @return The JSON object, signalling failure and the error code
151 protected static JsonReturnObject createErrorJsonObject(String error) {
152 return new JsonErrorReturnObject(error);
163 public String getPath() {
171 public boolean isPrefixPage() {
179 public Response handleRequest(FreenetRequest request, Response response) throws IOException {
180 if (webInterface.getCore().getPreferences().isRequireFullAccess() && !request.getToadletContext().isAllowedFullAccess()) {
181 return response.setStatusCode(403).setStatusText("Forbidden").setContentType("application/json").write(objectMapper.writeValueAsString(new JsonErrorReturnObject("auth-required")));
183 if (needsFormPassword()) {
184 String formPassword = request.getHttpRequest().getParam("formPassword");
185 if (!webInterface.getFormPassword().equals(formPassword)) {
186 return response.setStatusCode(403).setStatusText("Forbidden").setContentType("application/json").write(objectMapper.writeValueAsString(new JsonErrorReturnObject("auth-required")));
189 if (requiresLogin()) {
190 if (getCurrentSone(request.getToadletContext(), false) == null) {
191 return response.setStatusCode(403).setStatusText("Forbidden").setContentType("application/json").write(objectMapper.writeValueAsString(new JsonErrorReturnObject("auth-required")));
195 JsonReturnObject jsonObject = createJsonObject(request);
196 return response.setStatusCode(200).setStatusText("OK").setContentType("application/json").write(objectMapper.writeValueAsString(jsonObject));
197 } catch (Exception e1) {
198 logger.log(Level.WARNING, "Error executing JSON page!", e1);
199 return response.setStatusCode(500).setStatusText(e1.getMessage()).setContentType("text/plain").write(dumpStackTrace(e1));
207 public boolean isLinkExcepted(URI link) {
216 * Returns a byte array containing the stack trace of the given throwable.
219 * The throwable whose stack trace to dump into an array
220 * @return The array with the stack trace, or an empty array if the stack
221 * trace could not be dumped
223 private static byte[] dumpStackTrace(Throwable t) {
224 ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
225 OutputStreamWriter writer = null;
226 PrintWriter printWriter = null;
228 writer = new OutputStreamWriter(byteArrayOutputStream, "uTF-8");
229 printWriter = new PrintWriter(writer);
230 t.printStackTrace(printWriter);
231 byteArrayOutputStream.flush();
232 return byteArrayOutputStream.toByteArray();
233 } catch (IOException ioe1) {
234 /* quite not possible. */
237 Closer.close(printWriter);
238 Closer.close(writer);
239 Closer.close(byteArrayOutputStream);