2 * Sone - SoneTemplatePage.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;
20 import java.io.UnsupportedEncodingException;
21 import java.net.URLEncoder;
22 import java.util.ArrayList;
23 import java.util.Arrays;
24 import java.util.Collection;
25 import java.util.Collections;
26 import java.util.List;
29 import javax.annotation.Nonnull;
31 import net.pterodactylus.sone.data.Sone;
32 import net.pterodactylus.sone.main.SonePlugin;
33 import net.pterodactylus.sone.web.page.FreenetRequest;
34 import net.pterodactylus.sone.web.page.FreenetTemplatePage;
35 import net.pterodactylus.util.notify.Notification;
36 import net.pterodactylus.util.template.Template;
37 import net.pterodactylus.util.template.TemplateContext;
39 import freenet.clients.http.SessionManager.Session;
40 import freenet.clients.http.ToadletContext;
41 import freenet.support.api.HTTPRequest;
43 import com.google.common.collect.ImmutableList;
44 import com.google.common.collect.ImmutableMap;
47 * Base page for the Sone web interface.
49 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
51 public class SoneTemplatePage extends FreenetTemplatePage {
54 protected final WebInterface webInterface;
56 /** The page title l10n key. */
57 private final String pageTitleKey;
59 /** Whether to require a login. */
60 private final boolean requireLogin;
63 * Creates a new template page for Sone that does not require the user to be
67 * The path of the page
69 * The template to render
71 * The l10n key of the page title
73 * The Sone web interface
75 public SoneTemplatePage(String path, Template template, String pageTitleKey, WebInterface webInterface) {
76 this(path, template, pageTitleKey, webInterface, false);
80 * Creates a new template page for Sone.
83 * The path of the page
85 * The template to render
87 * The Sone web interface
89 * Whether this page requires a login
91 public SoneTemplatePage(String path, Template template, WebInterface webInterface, boolean requireLogin) {
92 this(path, template, null, webInterface, requireLogin);
96 * Creates a new template page for Sone.
99 * The path of the page
101 * The template to render
102 * @param pageTitleKey
103 * The l10n key of the page title
104 * @param webInterface
105 * The Sone web interface
106 * @param requireLogin
107 * Whether this page requires a login
109 public SoneTemplatePage(String path, Template template, String pageTitleKey, WebInterface webInterface, boolean requireLogin) {
110 super(path, webInterface.getTemplateContextFactory(), template, "noPermission.html");
111 this.pageTitleKey = pageTitleKey;
112 this.webInterface = webInterface;
113 this.requireLogin = requireLogin;
121 * Returns the current session, creating a new session if there is no
124 * @param toadletContenxt
125 * The toadlet context
126 * @return The current session, or {@code null} if there is no current
129 protected Session getCurrentSession(ToadletContext toadletContenxt) {
130 return webInterface.getCurrentSession(toadletContenxt);
134 * Returns the current session, creating a new session if there is no
135 * current session and {@code create} is {@code true}.
137 * @param toadletContenxt
138 * The toadlet context
140 * {@code true} to create a new session if there is no current
141 * session, {@code false} otherwise
142 * @return The current session, or {@code null} if there is no current
145 protected Session getCurrentSession(ToadletContext toadletContenxt, boolean create) {
146 return webInterface.getCurrentSession(toadletContenxt, create);
150 * Returns the currently logged in Sone.
152 * @param toadletContext
153 * The toadlet context
154 * @return The currently logged in Sone, or {@code null} if no Sone is
155 * currently logged in
157 protected Sone getCurrentSone(ToadletContext toadletContext) {
158 return webInterface.getCurrentSone(toadletContext);
162 * Returns the currently logged in Sone.
164 * @param toadletContext
165 * The toadlet context
167 * {@code true} to create a new session if no session exists,
168 * {@code false} to not create a new session
169 * @return The currently logged in Sone, or {@code null} if no Sone is
170 * currently logged in
172 protected Sone getCurrentSone(ToadletContext toadletContext, boolean create) {
173 return webInterface.getCurrentSone(toadletContext, create);
177 * Sets the currently logged in Sone.
179 * @param toadletContext
180 * The toadlet context
182 * The Sone to set as currently logged in
184 protected void setCurrentSone(ToadletContext toadletContext, Sone sone) {
185 webInterface.setCurrentSone(toadletContext, sone);
189 // TEMPLATEPAGE METHODS
196 protected String getPageTitle(FreenetRequest request) {
197 if (pageTitleKey != null) {
198 return webInterface.getL10n().getString(pageTitleKey);
207 protected List<Map<String, String>> getAdditionalLinkNodes(FreenetRequest request) {
208 return ImmutableList.<Map<String, String>> builder().add(ImmutableMap.<String, String> builder().put("rel", "search").put("type", "application/opensearchdescription+xml").put("title", "Sone").put("href", "http://" + request.getHttpRequest().getHeader("host") + "/Sone/OpenSearch.xml").build()).build();
215 protected Collection<String> getStyleSheets() {
216 return Arrays.asList("css/sone.css");
223 protected String getShortcutIcon() {
224 return "images/icon.png";
228 * Returns whether this page requires the user to log in.
230 * @return {@code true} if the user is required to be logged in to use this
231 * page, {@code false} otherwise
233 protected boolean requiresLogin() {
241 protected final void processTemplate(FreenetRequest request, TemplateContext templateContext) throws RedirectException {
242 super.processTemplate(request, templateContext);
243 Sone currentSone = getCurrentSone(request.getToadletContext(), false);
244 templateContext.set("core", webInterface.getCore());
245 templateContext.set("currentSone", currentSone);
246 templateContext.set("localSones", webInterface.getCore().getLocalSones());
247 templateContext.set("request", request);
248 templateContext.set("currentVersion", SonePlugin.getPluginVersion());
249 templateContext.set("hasLatestVersion", webInterface.getCore().getUpdateChecker().hasLatestVersion());
250 templateContext.set("latestEdition", webInterface.getCore().getUpdateChecker().getLatestEdition());
251 templateContext.set("latestVersion", webInterface.getCore().getUpdateChecker().getLatestVersion());
252 templateContext.set("latestVersionTime", webInterface.getCore().getUpdateChecker().getLatestVersionDate());
253 List<Notification> notifications = new ArrayList<Notification>(webInterface.getNotifications(currentSone));
254 Collections.sort(notifications, Notification.CREATED_TIME_SORTER);
255 templateContext.set("notifications", notifications);
256 templateContext.set("notificationHash", notifications.hashCode());
257 handleRequest(request, templateContext);
260 protected void handleRequest(@Nonnull FreenetRequest request, @Nonnull TemplateContext templateContext) throws RedirectException {
267 protected String getRedirectTarget(FreenetRequest request) {
268 if (requiresLogin() && (getCurrentSone(request.getToadletContext(), false) == null)) {
269 HTTPRequest httpRequest = request.getHttpRequest();
270 String originalUrl = httpRequest.getPath();
271 if (httpRequest.hasParameters()) {
272 StringBuilder requestParameters = new StringBuilder();
273 for (String parameterName : httpRequest.getParameterNames()) {
274 if (requestParameters.length() > 0) {
275 requestParameters.append("%26");
277 String[] parameterValues = httpRequest.getMultipleParam(parameterName);
278 for (String parameterValue : parameterValues) {
280 requestParameters.append(URLEncoder.encode(parameterName, "UTF-8")).append("%3d").append(URLEncoder.encode(parameterValue, "UTF-8"));
281 } catch (UnsupportedEncodingException uee1) {
282 /* A JVM without UTF-8? I don’t think so. */
286 originalUrl += "?" + requestParameters.toString();
288 return "login.html?target=" + originalUrl;
297 protected boolean isFullAccessOnly() {
298 return webInterface.getCore().getPreferences().isRequireFullAccess();
305 public boolean isEnabled(ToadletContext toadletContext) {
306 if (webInterface.getCore().getPreferences().isRequireFullAccess() && !toadletContext.isAllowedFullAccess()) {
309 if (requiresLogin()) {
310 return getCurrentSone(toadletContext, false) != null;