/*
- * FreenetSone - WebInterface.java - Copyright © 2010 David Roden
+ * Sone - WebInterface.java - Copyright © 2010–2020 David Roden
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
package net.pterodactylus.sone.web;
+import static com.google.common.collect.FluentIterable.from;
+import static java.util.logging.Logger.getLogger;
+
+import java.util.Collection;
+import java.util.Set;
+import java.util.TimeZone;
+import java.util.UUID;
+import java.util.logging.Logger;
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+import javax.inject.Named;
+
+import net.pterodactylus.sone.core.Core;
+import net.pterodactylus.sone.core.ElementLoader;
+import net.pterodactylus.sone.core.event.*;
+import net.pterodactylus.sone.data.Post;
+import net.pterodactylus.sone.data.PostReply;
+import net.pterodactylus.sone.data.Sone;
+import net.pterodactylus.sone.freenet.L10nFilter;
+import net.pterodactylus.sone.freenet.Translation;
+import net.pterodactylus.sone.main.Loaders;
+import net.pterodactylus.sone.main.PluginHomepage;
+import net.pterodactylus.sone.main.PluginVersion;
+import net.pterodactylus.sone.main.PluginYear;
+import net.pterodactylus.sone.main.SonePlugin;
+import net.pterodactylus.sone.notify.ListNotification;
+import net.pterodactylus.sone.notify.ListNotificationFilter;
+import net.pterodactylus.sone.notify.PostVisibilityFilter;
+import net.pterodactylus.sone.notify.ReplyVisibilityFilter;
+import net.pterodactylus.sone.template.LinkedElementRenderFilter;
+import net.pterodactylus.sone.template.ParserFilter;
+import net.pterodactylus.sone.template.RenderFilter;
+import net.pterodactylus.sone.template.ShortenFilter;
+import net.pterodactylus.sone.text.TimeTextConverter;
+import net.pterodactylus.sone.web.ajax.BookmarkAjaxPage;
+import net.pterodactylus.sone.web.ajax.CreatePostAjaxPage;
+import net.pterodactylus.sone.web.ajax.CreateReplyAjaxPage;
+import net.pterodactylus.sone.web.ajax.DeletePostAjaxPage;
+import net.pterodactylus.sone.web.ajax.DeleteProfileFieldAjaxPage;
+import net.pterodactylus.sone.web.ajax.DeleteReplyAjaxPage;
+import net.pterodactylus.sone.web.ajax.DismissNotificationAjaxPage;
+import net.pterodactylus.sone.web.ajax.EditAlbumAjaxPage;
+import net.pterodactylus.sone.web.ajax.EditImageAjaxPage;
+import net.pterodactylus.sone.web.ajax.EditProfileFieldAjaxPage;
+import net.pterodactylus.sone.web.ajax.FollowSoneAjaxPage;
+import net.pterodactylus.sone.web.ajax.GetLikesAjaxPage;
+import net.pterodactylus.sone.web.ajax.GetLinkedElementAjaxPage;
+import net.pterodactylus.sone.web.ajax.GetNotificationsAjaxPage;
+import net.pterodactylus.sone.web.ajax.GetPostAjaxPage;
+import net.pterodactylus.sone.web.ajax.GetReplyAjaxPage;
+import net.pterodactylus.sone.web.ajax.GetStatusAjaxPage;
+import net.pterodactylus.sone.web.ajax.GetTimesAjaxPage;
+import net.pterodactylus.sone.web.ajax.GetTranslationAjaxPage;
+import net.pterodactylus.sone.web.ajax.LikeAjaxPage;
+import net.pterodactylus.sone.web.ajax.LockSoneAjaxPage;
+import net.pterodactylus.sone.web.ajax.MarkAsKnownAjaxPage;
+import net.pterodactylus.sone.web.ajax.MoveProfileFieldAjaxPage;
+import net.pterodactylus.sone.web.ajax.UnbookmarkAjaxPage;
+import net.pterodactylus.sone.web.ajax.UnfollowSoneAjaxPage;
+import net.pterodactylus.sone.web.ajax.UnlikeAjaxPage;
+import net.pterodactylus.sone.web.ajax.UnlockSoneAjaxPage;
+import net.pterodactylus.sone.web.page.FreenetRequest;
+import net.pterodactylus.sone.web.page.TemplateRenderer;
+import net.pterodactylus.sone.web.pages.*;
+import net.pterodactylus.util.notify.Notification;
+import net.pterodactylus.util.notify.NotificationManager;
+import net.pterodactylus.util.template.Template;
+import net.pterodactylus.util.template.TemplateContextFactory;
+import net.pterodactylus.util.web.RedirectPage;
+import net.pterodactylus.util.web.TemplatePage;
+
import freenet.clients.http.SessionManager;
-import freenet.l10n.BaseL10n;
+import freenet.clients.http.SessionManager.Session;
+import freenet.clients.http.ToadletContext;
+
+import com.codahale.metrics.*;
+import com.google.common.base.Optional;
+import com.google.common.collect.ImmutableSet;
+import com.google.common.eventbus.Subscribe;
+import com.google.inject.Inject;
/**
* Bundles functionality that a web interface of a Freenet plugin needs, e.g.
* references to l10n helpers.
- *
- * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
*/
-public class WebInterface {
+public class WebInterface implements SessionProvider {
- /** The node’s l10n helper. */
- private final BaseL10n l10n;
+ /** The logger. */
+ private static final Logger logger = getLogger(WebInterface.class.getName());
- /** The node’s session manager. */
- private final SessionManager sessionManager;
+ /** The loaders for templates, pages, and classpath providers. */
+ private final Loaders loaders;
- /**
- * Creates a new web interface.
- *
- * @param l10n
- * The node’s l10n helper
- * @param sessionManager
- * The node’s session manager
- */
- public WebInterface(BaseL10n l10n, SessionManager sessionManager) {
- this.l10n = l10n;
- this.sessionManager = sessionManager;
+ /** The notification manager. */
+ private final NotificationManager notificationManager;
+
+ /** The Sone plugin. */
+ private final SonePlugin sonePlugin;
+
+ /** The form password. */
+ private final String formPassword;
+
+ /** The template context factory. */
+ private final TemplateContextFactory templateContextFactory;
+ private final TemplateRenderer templateRenderer;
+
+ /** The parser filter. */
+ private final ParserFilter parserFilter;
+ private final ShortenFilter shortenFilter;
+ private final RenderFilter renderFilter;
+
+ private final ListNotificationFilter listNotificationFilter;
+ private final PostVisibilityFilter postVisibilityFilter;
+ private final ReplyVisibilityFilter replyVisibilityFilter;
+
+ private final ElementLoader elementLoader;
+ private final LinkedElementRenderFilter linkedElementRenderFilter;
+ private final TimeTextConverter timeTextConverter = new TimeTextConverter();
+ private final L10nFilter l10nFilter;
+
+ private final PageToadletRegistry pageToadletRegistry;
+ private final MetricRegistry metricRegistry;
+ private final Translation translation;
+
+ /** The “new post” notification. */
+ private final ListNotification<Post> newPostNotification;
+
+ /** The “new reply” notification. */
+ private final ListNotification<PostReply> newReplyNotification;
+
+ /** The invisible “local post” notification. */
+ private final ListNotification<Post> localPostNotification;
+
+ /** The invisible “local reply” notification. */
+ private final ListNotification<PostReply> localReplyNotification;
+
+ @Inject
+ public WebInterface(SonePlugin sonePlugin, Loaders loaders, ListNotificationFilter listNotificationFilter,
+ PostVisibilityFilter postVisibilityFilter, ReplyVisibilityFilter replyVisibilityFilter,
+ ElementLoader elementLoader, TemplateContextFactory templateContextFactory,
+ TemplateRenderer templateRenderer,
+ ParserFilter parserFilter, ShortenFilter shortenFilter,
+ RenderFilter renderFilter,
+ LinkedElementRenderFilter linkedElementRenderFilter,
+ PageToadletRegistry pageToadletRegistry, MetricRegistry metricRegistry, Translation translation, L10nFilter l10nFilter,
+ NotificationManager notificationManager, @Named("newRemotePost") ListNotification<Post> newPostNotification,
+ @Named("newRemotePostReply") ListNotification<PostReply> newReplyNotification,
+ @Named("localPost") ListNotification<Post> localPostNotification,
+ @Named("localReply") ListNotification<PostReply> localReplyNotification) {
+ this.sonePlugin = sonePlugin;
+ this.loaders = loaders;
+ this.listNotificationFilter = listNotificationFilter;
+ this.postVisibilityFilter = postVisibilityFilter;
+ this.replyVisibilityFilter = replyVisibilityFilter;
+ this.elementLoader = elementLoader;
+ this.templateRenderer = templateRenderer;
+ this.parserFilter = parserFilter;
+ this.shortenFilter = shortenFilter;
+ this.renderFilter = renderFilter;
+ this.linkedElementRenderFilter = linkedElementRenderFilter;
+ this.pageToadletRegistry = pageToadletRegistry;
+ this.metricRegistry = metricRegistry;
+ this.l10nFilter = l10nFilter;
+ this.translation = translation;
+ this.notificationManager = notificationManager;
+ this.newPostNotification = newPostNotification;
+ this.newReplyNotification = newReplyNotification;
+ this.localPostNotification = localPostNotification;
+ this.localReplyNotification = localReplyNotification;
+ formPassword = sonePlugin.pluginRespirator().getToadletContainer().getFormPassword();
+
+ this.templateContextFactory = templateContextFactory;
+ templateContextFactory.addTemplateObject("webInterface", this);
+ templateContextFactory.addTemplateObject("formPassword", formPassword);
}
//
//
/**
- * Returns the l10n helper of the node.
+ * Returns the Sone core used by the Sone plugin.
+ *
+ * @return The Sone core
+ */
+ @Nonnull
+ public Core getCore() {
+ return sonePlugin.core();
+ }
+
+ /**
+ * Returns the template context factory of the web interface.
+ *
+ * @return The template context factory
+ */
+ public TemplateContextFactory getTemplateContextFactory() {
+ return templateContextFactory;
+ }
+
+ private Session getCurrentSessionWithoutCreation(ToadletContext toadletContenxt) {
+ return getSessionManager().useSession(toadletContenxt);
+ }
+
+ private Session getOrCreateCurrentSession(ToadletContext toadletContenxt) {
+ Session session = getCurrentSessionWithoutCreation(toadletContenxt);
+ if (session == null) {
+ session = getSessionManager().createSession(UUID.randomUUID().toString(), toadletContenxt);
+ }
+ return session;
+ }
+
+ public Sone getCurrentSoneCreatingSession(ToadletContext toadletContext) {
+ Collection<Sone> localSones = getCore().getLocalSones();
+ if (localSones.size() == 1) {
+ return localSones.iterator().next();
+ }
+ return getCurrentSone(getOrCreateCurrentSession(toadletContext));
+ }
+
+ public Sone getCurrentSoneWithoutCreatingSession(ToadletContext toadletContext) {
+ Collection<Sone> localSones = getCore().getLocalSones();
+ if (localSones.size() == 1) {
+ return localSones.iterator().next();
+ }
+ return getCurrentSone(getCurrentSessionWithoutCreation(toadletContext));
+ }
+
+ /**
+ * Returns the currently logged in Sone.
+ *
+ * @param session
+ * The session
+ * @return The currently logged in Sone, or {@code null} if no Sone is
+ * currently logged in
+ */
+ private Sone getCurrentSone(Session session) {
+ if (session == null) {
+ return null;
+ }
+ String soneId = (String) session.getAttribute("Sone.CurrentSone");
+ if (soneId == null) {
+ return null;
+ }
+ return getCore().getLocalSone(soneId);
+ }
+
+ @Override
+ @Nullable
+ public Sone getCurrentSone(@Nonnull ToadletContext toadletContext, boolean createSession) {
+ return createSession ? getCurrentSoneCreatingSession(toadletContext) : getCurrentSoneWithoutCreatingSession(toadletContext);
+ }
+
+ /**
+ * Sets the currently logged in Sone.
*
- * @return The node’s l10n helper
+ * @param toadletContext
+ * The toadlet context
+ * @param sone
+ * The Sone to set as currently logged in
*/
- public BaseL10n l10n() {
- return l10n;
+ @Override
+ public void setCurrentSone(@Nonnull ToadletContext toadletContext, @Nullable Sone sone) {
+ Session session = getOrCreateCurrentSession(toadletContext);
+ if (sone == null) {
+ session.removeAttribute("Sone.CurrentSone");
+ } else {
+ session.setAttribute("Sone.CurrentSone", sone.getId());
+ }
+ }
+
+ /**
+ * Returns the notification manager.
+ *
+ * @return The notification manager
+ */
+ public NotificationManager getNotifications() {
+ return notificationManager;
+ }
+
+ @Nonnull
+ public Optional<Notification> getNotification(@Nonnull String notificationId) {
+ return Optional.fromNullable(notificationManager.getNotification(notificationId));
+ }
+
+ @Nonnull
+ public Collection<Notification> getNotifications(@Nullable Sone currentSone) {
+ return listNotificationFilter.filterNotifications(notificationManager.getNotifications(), currentSone);
+ }
+
+ public Translation getTranslation() {
+ return translation;
}
/**
*
* @return The node’s session manager
*/
- public SessionManager sessionManager() {
- return sessionManager;
+ public SessionManager getSessionManager() {
+ return sonePlugin.pluginRespirator().getSessionManager("Sone");
+ }
+
+ /**
+ * Returns the node’s form password.
+ *
+ * @return The form password
+ */
+ public String getFormPassword() {
+ return formPassword;
+ }
+
+ @Nonnull
+ public Collection<Post> getNewPosts(@Nullable Sone currentSone) {
+ Set<Post> allNewPosts = ImmutableSet.<Post> builder()
+ .addAll(newPostNotification.getElements())
+ .addAll(localPostNotification.getElements())
+ .build();
+ return from(allNewPosts).filter(postVisibilityFilter.isVisible(currentSone)).toSet();
+ }
+
+ @Nonnull
+ public Collection<PostReply> getNewReplies(@Nullable Sone currentSone) {
+ Set<PostReply> allNewReplies = ImmutableSet.<PostReply>builder()
+ .addAll(newReplyNotification.getElements())
+ .addAll(localReplyNotification.getElements())
+ .build();
+ return from(allNewReplies).filter(replyVisibilityFilter.isVisible(currentSone)).toSet();
+ }
+
+ //
+ // ACTIONS
+ //
+
+ /**
+ * Starts the web interface and registers all toadlets.
+ */
+ public void start() {
+ registerToadlets();
+ }
+
+ /**
+ * Stops the web interface and unregisters all toadlets.
+ */
+ public void stop() {
+ pageToadletRegistry.unregisterToadlets();
+ }
+
+ //
+ // PRIVATE METHODS
+ //
+
+ /**
+ * Register all toadlets.
+ */
+ private void registerToadlets() {
+ Template postTemplate = loaders.loadTemplate("/templates/include/viewPost.html");
+ Template replyTemplate = loaders.loadTemplate("/templates/include/viewReply.html");
+ Template openSearchTemplate = loaders.loadTemplate("/templates/xml/OpenSearch.xml");
+
+ pageToadletRegistry.addPage(new RedirectPage<FreenetRequest>("", "index.html"));
+ pageToadletRegistry.addPage(new IndexPage(this, loaders, templateRenderer, postVisibilityFilter));
+ pageToadletRegistry.addPage(new NewPage(this, loaders, templateRenderer));
+ pageToadletRegistry.addPage(new CreateSonePage(this, loaders, templateRenderer));
+ pageToadletRegistry.addPage(new KnownSonesPage(this, loaders, templateRenderer));
+ pageToadletRegistry.addPage(new EditProfilePage(this, loaders, templateRenderer));
+ pageToadletRegistry.addPage(new EditProfileFieldPage(this, loaders, templateRenderer));
+ pageToadletRegistry.addPage(new DeleteProfileFieldPage(this, loaders, templateRenderer));
+ pageToadletRegistry.addPage(new CreatePostPage(this, loaders, templateRenderer));
+ pageToadletRegistry.addPage(new CreateReplyPage(this, loaders, templateRenderer));
+ pageToadletRegistry.addPage(new ViewSonePage(this, loaders, templateRenderer));
+ pageToadletRegistry.addPage(new ViewPostPage(this, loaders, templateRenderer));
+ pageToadletRegistry.addPage(new LikePage(this, loaders, templateRenderer));
+ pageToadletRegistry.addPage(new UnlikePage(this, loaders, templateRenderer));
+ pageToadletRegistry.addPage(new DeletePostPage(this, loaders, templateRenderer));
+ pageToadletRegistry.addPage(new DeleteReplyPage(this, loaders, templateRenderer));
+ pageToadletRegistry.addPage(new LockSonePage(this, loaders, templateRenderer));
+ pageToadletRegistry.addPage(new UnlockSonePage(this, loaders, templateRenderer));
+ pageToadletRegistry.addPage(new FollowSonePage(this, loaders, templateRenderer));
+ pageToadletRegistry.addPage(new UnfollowSonePage(this, loaders, templateRenderer));
+ pageToadletRegistry.addPage(new ImageBrowserPage(this, loaders, templateRenderer));
+ pageToadletRegistry.addPage(new CreateAlbumPage(this, loaders, templateRenderer));
+ pageToadletRegistry.addPage(new EditAlbumPage(this, loaders, templateRenderer));
+ pageToadletRegistry.addPage(new DeleteAlbumPage(this, loaders, templateRenderer));
+ pageToadletRegistry.addPage(new UploadImagePage(this, loaders, templateRenderer));
+ pageToadletRegistry.addPage(new EditImagePage(this, loaders, templateRenderer));
+ pageToadletRegistry.addPage(new DeleteImagePage(this, loaders, templateRenderer));
+ pageToadletRegistry.addPage(new MarkAsKnownPage(this, loaders, templateRenderer));
+ pageToadletRegistry.addPage(new BookmarkPage(this, loaders, templateRenderer));
+ pageToadletRegistry.addPage(new UnbookmarkPage(this, loaders, templateRenderer));
+ pageToadletRegistry.addPage(new BookmarksPage(this, loaders, templateRenderer));
+ pageToadletRegistry.addPage(new SearchPage(this, loaders, templateRenderer));
+ pageToadletRegistry.addPage(new DeleteSonePage(this, loaders, templateRenderer));
+ pageToadletRegistry.addPage(new LoginPage(this, loaders, templateRenderer));
+ pageToadletRegistry.addPage(new LogoutPage(this, loaders, templateRenderer));
+ pageToadletRegistry.addPage(new OptionsPage(this, loaders, templateRenderer));
+ pageToadletRegistry.addPage(new RescuePage(this, loaders, templateRenderer));
+ pageToadletRegistry.addPage(new AboutPage(this, loaders, templateRenderer, new PluginVersion(SonePlugin.getPluginVersion()), new PluginYear(sonePlugin.getYear()), new PluginHomepage(sonePlugin.getHomepage())));
+ pageToadletRegistry.addPage(new InvalidPage(this, loaders, templateRenderer));
+ pageToadletRegistry.addPage(new NoPermissionPage(this, loaders, templateRenderer));
+ pageToadletRegistry.addPage(new EmptyImageTitlePage(this, loaders, templateRenderer));
+ pageToadletRegistry.addPage(new EmptyAlbumTitlePage(this, loaders, templateRenderer));
+ pageToadletRegistry.addPage(new DismissNotificationPage(this, loaders, templateRenderer));
+ pageToadletRegistry.addPage(new DebugPage(this, loaders, templateRenderer));
+ pageToadletRegistry.addDebugPage(new MetricsPage(this, loaders, templateRenderer, metricRegistry));
+ pageToadletRegistry.addPage(loaders.<FreenetRequest>loadStaticPage("css/", "/static/css/", "text/css"));
+ pageToadletRegistry.addPage(loaders.<FreenetRequest>loadStaticPage("javascript/", "/static/javascript/", "text/javascript"));
+ pageToadletRegistry.addPage(loaders.<FreenetRequest>loadStaticPage("images/", "/static/images/", "image/png"));
+ pageToadletRegistry.addPage(new TemplatePage<FreenetRequest>("OpenSearch.xml", "application/opensearchdescription+xml", templateContextFactory, openSearchTemplate));
+ pageToadletRegistry.addPage(new GetImagePage(this));
+ pageToadletRegistry.addPage(new GetTranslationAjaxPage(this));
+ pageToadletRegistry.addPage(new GetStatusAjaxPage(this, elementLoader, timeTextConverter, l10nFilter, TimeZone.getDefault()));
+ pageToadletRegistry.addPage(new GetNotificationsAjaxPage(this));
+ pageToadletRegistry.addPage(new DismissNotificationAjaxPage(this));
+ pageToadletRegistry.addPage(new CreatePostAjaxPage(this));
+ pageToadletRegistry.addPage(new CreateReplyAjaxPage(this));
+ pageToadletRegistry.addPage(new GetReplyAjaxPage(this, replyTemplate));
+ pageToadletRegistry.addPage(new GetPostAjaxPage(this, postTemplate));
+ pageToadletRegistry.addPage(new GetLinkedElementAjaxPage(this, elementLoader, linkedElementRenderFilter));
+ pageToadletRegistry.addPage(new GetTimesAjaxPage(this, timeTextConverter, l10nFilter, TimeZone.getDefault()));
+ pageToadletRegistry.addPage(new MarkAsKnownAjaxPage(this));
+ pageToadletRegistry.addPage(new DeletePostAjaxPage(this));
+ pageToadletRegistry.addPage(new DeleteReplyAjaxPage(this));
+ pageToadletRegistry.addPage(new LockSoneAjaxPage(this));
+ pageToadletRegistry.addPage(new UnlockSoneAjaxPage(this));
+ pageToadletRegistry.addPage(new FollowSoneAjaxPage(this));
+ pageToadletRegistry.addPage(new UnfollowSoneAjaxPage(this));
+ pageToadletRegistry.addPage(new EditAlbumAjaxPage(this));
+ pageToadletRegistry.addPage(new EditImageAjaxPage(this, parserFilter, shortenFilter, renderFilter));
+ pageToadletRegistry.addPage(new LikeAjaxPage(this));
+ pageToadletRegistry.addPage(new UnlikeAjaxPage(this));
+ pageToadletRegistry.addPage(new GetLikesAjaxPage(this));
+ pageToadletRegistry.addPage(new BookmarkAjaxPage(this));
+ pageToadletRegistry.addPage(new UnbookmarkAjaxPage(this));
+ pageToadletRegistry.addPage(new EditProfileFieldAjaxPage(this));
+ pageToadletRegistry.addPage(new DeleteProfileFieldAjaxPage(this));
+ pageToadletRegistry.addPage(new MoveProfileFieldAjaxPage(this));
+
+ pageToadletRegistry.registerToadlets();
+ }
+
+ @Subscribe
+ public void debugActivated(@Nonnull DebugActivatedEvent debugActivatedEvent) {
+ pageToadletRegistry.activateDebugMode();
}
}
projects / Sone.git / blobdiff