2 * Freetalk - FreetalkTemplatePage.java - Copyright © 2010 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.util.Arrays;
21 import java.util.Collection;
22 import java.util.UUID;
24 import net.pterodactylus.sone.data.Sone;
25 import net.pterodactylus.sone.web.page.Page;
26 import net.pterodactylus.sone.web.page.TemplatePage;
27 import net.pterodactylus.util.template.Template;
28 import freenet.clients.http.SessionManager.Session;
29 import freenet.clients.http.ToadletContext;
32 * Base page for the Freetalk web interface.
34 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
36 public class SoneTemplatePage extends TemplatePage {
39 protected final WebInterface webInterface;
41 /** Whether to require a login. */
42 private final boolean requireLogin;
45 * Creates a new template page for Freetalk that does not require the user
49 * The path of the page
51 * The template to render
53 * The l10n key of the page title
55 * The Sone web interface
57 public SoneTemplatePage(String path, Template template, String pageTitleKey, WebInterface webInterface) {
58 this(path, template, pageTitleKey, webInterface, false);
62 * Creates a new template page for Freetalk.
65 * The path of the page
67 * The template to render
69 * The l10n key of the page title
71 * The Sone web interface
73 * Whether this page requires a login
75 public SoneTemplatePage(String path, Template template, String pageTitleKey, WebInterface webInterface, boolean requireLogin) {
76 super(path, template, webInterface.getL10n(), pageTitleKey, "noPermission.html");
77 this.webInterface = webInterface;
78 this.requireLogin = requireLogin;
79 template.set("webInterface", webInterface);
87 * Returns the current session, creating a new session if there is no
90 * @param toadletContenxt
92 * @return The current session, or {@code null} if there is no current
95 protected Session getCurrentSession(ToadletContext toadletContenxt) {
96 return getCurrentSession(toadletContenxt, true);
100 * Returns the current session, creating a new session if there is no
101 * current session and {@code create} is {@code true}.
103 * @param toadletContenxt
104 * The toadlet context
106 * {@code true} to create a new session if there is no current
107 * session, {@code false} otherwise
108 * @return The current session, or {@code null} if there is no current
111 protected Session getCurrentSession(ToadletContext toadletContenxt, boolean create) {
113 Session session = webInterface.getSessionManager().useSession(toadletContenxt);
114 if (create && (session == null)) {
115 session = webInterface.getSessionManager().createSession(UUID.randomUUID().toString(), toadletContenxt);
118 } catch (freenet.clients.http.RedirectException re1) {
124 * Returns the currently logged in Sone.
126 * @param toadletContext
127 * The toadlet context
128 * @return The currently logged in Sone, or {@code null} if no Sone is
129 * currently logged in
131 protected Sone getCurrentSone(ToadletContext toadletContext) {
132 Session session = getCurrentSession(toadletContext);
133 if (session == null) {
136 String soneId = (String) session.getAttribute("Sone.CurrentSone");
137 if (soneId == null) {
140 return webInterface.getCore().getLocalSone(soneId);
144 * Sets the currently logged in Sone.
146 * @param toadletContext
147 * The toadlet context
149 * The Sone to set as currently logged in
151 protected void setCurrentSone(ToadletContext toadletContext, Sone sone) {
152 Session session = getCurrentSession(toadletContext);
154 session.removeAttribute("Sone.CurrentSone");
156 session.setAttribute("Sone.CurrentSone", sone.getId());
161 // TEMPLATEPAGE METHODS
168 protected Collection<String> getStyleSheets() {
169 return Arrays.asList("css/sone.css");
176 protected String getShortcutIcon() {
177 return "images/icon.png";
181 * Returns whether this page requires the user to log in.
183 * @return {@code true} if the user is required to be logged in to use this
184 * page, {@code false} otherwise
186 protected boolean requiresLogin() {
194 protected void processTemplate(Request request, Template template) throws RedirectException {
195 super.processTemplate(request, template);
196 template.set("currentSone", getCurrentSone(request.getToadletContext()));
197 template.set("request", request);
204 protected String getRedirectTarget(Page.Request request) {
205 if (requiresLogin() && (getCurrentSone(request.getToadletContext()) == null)) {
215 public boolean isEnabled(ToadletContext toadletContext) {
216 if (requiresLogin()) {
217 return getCurrentSone(toadletContext) != null;