src/main/java/net/pterodactylus/sone/web/WebInterface.java

   1 /*
   2  * FreenetSone - WebInterface.java - Copyright © 2010 David Roden
   3  *
   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.
   8  *
   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.
  13  *
  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/>.
  16  */
  17
  18 package net.pterodactylus.sone.web;
  19
  20 import java.io.InputStream;
  21 import java.io.InputStreamReader;
  22 import java.io.Reader;
  23 import java.io.UnsupportedEncodingException;
  24 import java.net.URI;
  25 import java.net.URISyntaxException;
  26 import java.util.ArrayList;
  27 import java.util.Collection;
  28 import java.util.List;
  29 import java.util.logging.Level;
  30 import java.util.logging.Logger;
  31
  32 import net.pterodactylus.sone.core.Core;
  33 import net.pterodactylus.sone.data.Post;
  34 import net.pterodactylus.sone.data.Reply;
  35 import net.pterodactylus.sone.data.Sone;
  36 import net.pterodactylus.sone.freenet.L10nFilter;
  37 import net.pterodactylus.sone.freenet.wot.Identity;
  38 import net.pterodactylus.sone.main.SonePlugin;
  39 import net.pterodactylus.sone.template.CollectionAccessor;
  40 import net.pterodactylus.sone.template.CssClassNameFilter;
  41 import net.pterodactylus.sone.template.GetPagePlugin;
  42 import net.pterodactylus.sone.template.IdentityAccessor;
  43 import net.pterodactylus.sone.template.NotificationManagerAccessor;
  44 import net.pterodactylus.sone.template.PostAccessor;
  45 import net.pterodactylus.sone.template.ReplyAccessor;
  46 import net.pterodactylus.sone.template.RequestChangeFilter;
  47 import net.pterodactylus.sone.template.SoneAccessor;
  48 import net.pterodactylus.sone.template.SubstringFilter;
  49 import net.pterodactylus.sone.web.ajax.CreateReplyAjaxPage;
  50 import net.pterodactylus.sone.web.ajax.DeletePostAjaxPage;
  51 import net.pterodactylus.sone.web.ajax.DeleteReplyAjaxPage;
  52 import net.pterodactylus.sone.web.ajax.DismissNotificationAjaxPage;
  53 import net.pterodactylus.sone.web.ajax.FollowSoneAjaxPage;
  54 import net.pterodactylus.sone.web.ajax.GetLikesAjaxPage;
  55 import net.pterodactylus.sone.web.ajax.GetReplyAjaxPage;
  56 import net.pterodactylus.sone.web.ajax.GetSoneStatusPage;
  57 import net.pterodactylus.sone.web.ajax.GetTranslationPage;
  58 import net.pterodactylus.sone.web.ajax.LikeAjaxPage;
  59 import net.pterodactylus.sone.web.ajax.UnfollowSoneAjaxPage;
  60 import net.pterodactylus.sone.web.ajax.UnlikeAjaxPage;
  61 import net.pterodactylus.sone.web.page.PageToadlet;
  62 import net.pterodactylus.sone.web.page.PageToadletFactory;
  63 import net.pterodactylus.sone.web.page.StaticPage;
  64 import net.pterodactylus.util.logging.Logging;
  65 import net.pterodactylus.util.notify.NotificationManager;
  66 import net.pterodactylus.util.notify.TemplateNotification;
  67 import net.pterodactylus.util.template.DateFilter;
  68 import net.pterodactylus.util.template.DefaultTemplateFactory;
  69 import net.pterodactylus.util.template.MatchFilter;
  70 import net.pterodactylus.util.template.PaginationPlugin;
  71 import net.pterodactylus.util.template.ReflectionAccessor;
  72 import net.pterodactylus.util.template.Template;
  73 import net.pterodactylus.util.template.TemplateException;
  74 import net.pterodactylus.util.template.TemplateFactory;
  75 import net.pterodactylus.util.template.TemplateProvider;
  76 import net.pterodactylus.util.template.XmlFilter;
  77 import net.pterodactylus.util.thread.Ticker;
  78 import freenet.clients.http.SessionManager;
  79 import freenet.clients.http.ToadletContainer;
  80 import freenet.l10n.BaseL10n;
  81
  82 /**
  83  * Bundles functionality that a web interface of a Freenet plugin needs, e.g.
  84  * references to l10n helpers.
  85  *
  86  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  87  */
  88 public class WebInterface {
  89
  90         /** The logger. */
  91         private static final Logger logger = Logging.getLogger(WebInterface.class);
  92
  93         /** The Sone plugin. */
  94         private final SonePlugin sonePlugin;
  95
  96         /** The registered toadlets. */
  97         private final List<PageToadlet> pageToadlets = new ArrayList<PageToadlet>();
  98
  99         /** The form password. */
 100         private final String formPassword;
 101
 102         /** The template factory. */
 103         private DefaultTemplateFactory templateFactory;
 104
 105         /**
 106          * Creates a new web interface.
 107          *
 108          * @param sonePlugin
 109          *            The Sone plugin
 110          */
 111         public WebInterface(SonePlugin sonePlugin) {
 112                 this.sonePlugin = sonePlugin;
 113                 formPassword = sonePlugin.pluginRespirator().getToadletContainer().getFormPassword();
 114
 115                 templateFactory = new DefaultTemplateFactory();
 116                 templateFactory.addAccessor(Object.class, new ReflectionAccessor());
 117                 templateFactory.addAccessor(Collection.class, new CollectionAccessor());
 118                 templateFactory.addAccessor(Sone.class, new SoneAccessor(getCore()));
 119                 templateFactory.addAccessor(Post.class, new PostAccessor(getCore()));
 120                 templateFactory.addAccessor(Reply.class, new ReplyAccessor(getCore()));
 121                 templateFactory.addAccessor(Identity.class, new IdentityAccessor(getCore()));
 122                 templateFactory.addAccessor(NotificationManager.class, new NotificationManagerAccessor());
 123                 templateFactory.addFilter("date", new DateFilter());
 124                 templateFactory.addFilter("l10n", new L10nFilter(getL10n()));
 125                 templateFactory.addFilter("substring", new SubstringFilter());
 126                 templateFactory.addFilter("xml", new XmlFilter());
 127                 templateFactory.addFilter("change", new RequestChangeFilter());
 128                 templateFactory.addFilter("match", new MatchFilter());
 129                 templateFactory.addFilter("css", new CssClassNameFilter());
 130                 templateFactory.addPlugin("getpage", new GetPagePlugin());
 131                 templateFactory.addPlugin("paginate", new PaginationPlugin());
 132                 templateFactory.setTemplateProvider(new ClassPathTemplateProvider(templateFactory));
 133                 templateFactory.addTemplateObject("formPassword", formPassword);
 134         }
 135
 136         //
 137         // ACCESSORS
 138         //
 139
 140         /**
 141          * Returns the Sone core used by the Sone plugin.
 142          *
 143          * @return The Sone core
 144          */
 145         public Core getCore() {
 146                 return sonePlugin.core();
 147         }
 148
 149         /**
 150          * Returns the l10n helper of the node.
 151          *
 152          * @return The node’s l10n helper
 153          */
 154         public BaseL10n getL10n() {
 155                 return sonePlugin.l10n().getBase();
 156         }
 157
 158         /**
 159          * Returns the session manager of the node.
 160          *
 161          * @return The node’s session manager
 162          */
 163         public SessionManager getSessionManager() {
 164                 try {
 165                         return sonePlugin.pluginRespirator().getSessionManager(new URI("/"));
 166                 } catch (URISyntaxException use1) {
 167                         logger.log(Level.SEVERE, "Could not get Session Manager!", use1);
 168                         return null;
 169                 }
 170         }
 171
 172         /**
 173          * Returns the node’s form password.
 174          *
 175          * @return The form password
 176          */
 177         public String getFormPassword() {
 178                 return formPassword;
 179         }
 180
 181         //
 182         // ACTIONS
 183         //
 184
 185         /**
 186          * Starts the web interface and registers all toadlets.
 187          */
 188         public void start() {
 189                 registerToadlets();
 190
 191                 /* notification templates. */
 192                 Template startupNotificationTemplate = templateFactory.createTemplate(createReader("/templates/notify/startupNotification.html"));
 193
 194                 final TemplateNotification startupNotification = new TemplateNotification(startupNotificationTemplate);
 195                 getCore().getNotifications().addNotification(startupNotification);
 196
 197                 Ticker.getInstance().registerEvent(System.currentTimeMillis() + (120 * 1000), new Runnable() {
 198
 199                         @Override
 200                         public void run() {
 201                                 getCore().getNotifications().removeNotification(startupNotification);
 202                         }
 203                 }, "Sone Startup Notification Remover");
 204         }
 205
 206         /**
 207          * Stops the web interface and unregisters all toadlets.
 208          */
 209         public void stop() {
 210                 unregisterToadlets();
 211         }
 212
 213         //
 214         // PRIVATE METHODS
 215         //
 216
 217         /**
 218          * Register all toadlets.
 219          */
 220         private void registerToadlets() {
 221                 Template loginTemplate = templateFactory.createTemplate(createReader("/templates/login.html"));
 222                 Template indexTemplate = templateFactory.createTemplate(createReader("/templates/index.html"));
 223                 Template knownSonesTemplate = templateFactory.createTemplate(createReader("/templates/knownSones.html"));
 224                 Template createSoneTemplate = templateFactory.createTemplate(createReader("/templates/createSone.html"));
 225                 Template createPostTemplate = templateFactory.createTemplate(createReader("/templates/createPost.html"));
 226                 Template createReplyTemplate = templateFactory.createTemplate(createReader("/templates/createReply.html"));
 227                 Template editProfileTemplate = templateFactory.createTemplate(createReader("/templates/editProfile.html"));
 228                 Template viewSoneTemplate = templateFactory.createTemplate(createReader("/templates/viewSone.html"));
 229                 Template viewPostTemplate = templateFactory.createTemplate(createReader("/templates/viewPost.html"));
 230                 Template likePostTemplate = templateFactory.createTemplate(createReader("/templates/like.html"));
 231                 Template unlikePostTemplate = templateFactory.createTemplate(createReader("/templates/unlike.html"));
 232                 Template deletePostTemplate = templateFactory.createTemplate(createReader("/templates/deletePost.html"));
 233                 Template deleteReplyTemplate = templateFactory.createTemplate(createReader("/templates/deleteReply.html"));
 234                 Template followSoneTemplate = templateFactory.createTemplate(createReader("/templates/followSone.html"));
 235                 Template unfollowSoneTemplate = templateFactory.createTemplate(createReader("/templates/unfollowSone.html"));
 236                 Template deleteSoneTemplate = templateFactory.createTemplate(createReader("/templates/deleteSone.html"));
 237                 Template noPermissionTemplate = templateFactory.createTemplate(createReader("/templates/noPermission.html"));
 238                 Template wotPluginMissingTemplate = templateFactory.createTemplate(createReader("/templates/wotPluginMissing.html"));
 239                 Template dismissNotificationTemplate = templateFactory.createTemplate(createReader("/templates/dismissNotification.html"));
 240                 Template logoutTemplate = templateFactory.createTemplate(createReader("/templates/logout.html"));
 241                 Template optionsTemplate = templateFactory.createTemplate(createReader("/templates/options.html"));
 242                 Template aboutTemplate = templateFactory.createTemplate(createReader("/templates/about.html"));
 243                 Template replyTemplate = templateFactory.createTemplate(createReader("/templates/include/viewReply.html"));
 244
 245                 PageToadletFactory pageToadletFactory = new PageToadletFactory(sonePlugin.pluginRespirator().getHLSimpleClient(), "/Sone/");
 246                 pageToadlets.add(pageToadletFactory.createPageToadlet(new IndexPage(indexTemplate, this), "Index"));
 247                 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreateSonePage(createSoneTemplate, this), "CreateSone"));
 248                 pageToadlets.add(pageToadletFactory.createPageToadlet(new KnownSonesPage(knownSonesTemplate, this), "KnownSones"));
 249                 pageToadlets.add(pageToadletFactory.createPageToadlet(new EditProfilePage(editProfileTemplate, this), "EditProfile"));
 250                 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreatePostPage(createPostTemplate, this)));
 251                 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreateReplyPage(createReplyTemplate, this)));
 252                 pageToadlets.add(pageToadletFactory.createPageToadlet(new ViewSonePage(viewSoneTemplate, this)));
 253                 pageToadlets.add(pageToadletFactory.createPageToadlet(new ViewPostPage(viewPostTemplate, this)));
 254                 pageToadlets.add(pageToadletFactory.createPageToadlet(new LikePage(likePostTemplate, this)));
 255                 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnlikePage(unlikePostTemplate, this)));
 256                 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeletePostPage(deletePostTemplate, this)));
 257                 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteReplyPage(deleteReplyTemplate, this)));
 258                 pageToadlets.add(pageToadletFactory.createPageToadlet(new FollowSonePage(followSoneTemplate, this)));
 259                 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnfollowSonePage(unfollowSoneTemplate, this)));
 260                 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteSonePage(deleteSoneTemplate, this), "DeleteSone"));
 261                 pageToadlets.add(pageToadletFactory.createPageToadlet(new LoginPage(loginTemplate, this), "Login"));
 262                 pageToadlets.add(pageToadletFactory.createPageToadlet(new LogoutPage(logoutTemplate, this), "Logout"));
 263                 pageToadlets.add(pageToadletFactory.createPageToadlet(new OptionsPage(optionsTemplate, this), "Options"));
 264                 pageToadlets.add(pageToadletFactory.createPageToadlet(new AboutPage(aboutTemplate, this, SonePlugin.VERSION), "About"));
 265                 pageToadlets.add(pageToadletFactory.createPageToadlet(new SoneTemplatePage("noPermission.html", noPermissionTemplate, "Page.NoPermission.Title", this)));
 266                 pageToadlets.add(pageToadletFactory.createPageToadlet(new SoneTemplatePage("wotPluginMissing.html", wotPluginMissingTemplate, "Page.WotPluginMissing.Title", this)));
 267                 pageToadlets.add(pageToadletFactory.createPageToadlet(new DismissNotificationPage(dismissNotificationTemplate, this)));
 268                 pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage("css/", "/static/css/", "text/css")));
 269                 pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage("javascript/", "/static/javascript/", "text/javascript")));
 270                 pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage("images/", "/static/images/", "image/png")));
 271                 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetTranslationPage(this)));
 272                 pageToadlets.add(pageToadletFactory.createPageToadlet(new DismissNotificationAjaxPage(this)));
 273                 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetSoneStatusPage(this)));
 274                 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreateReplyAjaxPage(this)));
 275                 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetReplyAjaxPage(this, replyTemplate)));
 276                 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeletePostAjaxPage(this)));
 277                 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteReplyAjaxPage(this)));
 278                 pageToadlets.add(pageToadletFactory.createPageToadlet(new FollowSoneAjaxPage(this)));
 279                 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnfollowSoneAjaxPage(this)));
 280                 pageToadlets.add(pageToadletFactory.createPageToadlet(new LikeAjaxPage(this)));
 281                 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnlikeAjaxPage(this)));
 282                 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetLikesAjaxPage(this)));
 283
 284                 ToadletContainer toadletContainer = sonePlugin.pluginRespirator().getToadletContainer();
 285                 toadletContainer.getPageMaker().addNavigationCategory("/Sone/index.html", "Navigation.Menu.Name", "Navigation.Menu.Tooltip", sonePlugin);
 286                 for (PageToadlet toadlet : pageToadlets) {
 287                         String menuName = toadlet.getMenuName();
 288                         if (menuName != null) {
 289                                 toadletContainer.register(toadlet, "Navigation.Menu.Name", toadlet.path(), true, "Navigation.Menu.Item." + menuName + ".Name", "Navigation.Menu.Item." + menuName + ".Tooltip", false, toadlet);
 290                         } else {
 291                                 toadletContainer.register(toadlet, null, toadlet.path(), true, false);
 292                         }
 293                 }
 294         }
 295
 296         /**
 297          * Unregisters all toadlets.
 298          */
 299         private void unregisterToadlets() {
 300                 ToadletContainer toadletContainer = sonePlugin.pluginRespirator().getToadletContainer();
 301                 for (PageToadlet pageToadlet : pageToadlets) {
 302                         toadletContainer.unregister(pageToadlet);
 303                 }
 304                 toadletContainer.getPageMaker().removeNavigationCategory("Navigation.Menu.Name");
 305         }
 306
 307         /**
 308          * Creates a {@link Reader} from the {@link InputStream} for the resource
 309          * with the given name.
 310          *
 311          * @param resourceName
 312          *            The name of the resource
 313          * @return A {@link Reader} for the resource
 314          */
 315         private Reader createReader(String resourceName) {
 316                 try {
 317                         return new InputStreamReader(getClass().getResourceAsStream(resourceName), "UTF-8");
 318                 } catch (UnsupportedEncodingException uee1) {
 319                         return null;
 320                 }
 321         }
 322
 323         /**
 324          * Template provider implementation that uses
 325          * {@link WebInterface#createReader(String)} to load templates for
 326          * inclusion.
 327          *
 328          * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
 329          */
 330         private class ClassPathTemplateProvider implements TemplateProvider {
 331
 332                 /** The template factory. */
 333                 @SuppressWarnings("hiding")
 334                 private final TemplateFactory templateFactory;
 335
 336                 /**
 337                  * Creates a new template provider that locates templates on the
 338                  * classpath.
 339                  *
 340                  * @param templateFactory
 341                  *            The template factory to create the templates
 342                  */
 343                 public ClassPathTemplateProvider(TemplateFactory templateFactory) {
 344                         this.templateFactory = templateFactory;
 345                 }
 346
 347                 /**
 348                  * {@inheritDoc}
 349                  */
 350                 @Override
 351                 @SuppressWarnings("synthetic-access")
 352                 public Template getTemplate(String templateName) {
 353                         Reader templateReader = createReader("/templates/" + templateName);
 354                         if (templateReader == null) {
 355                                 return null;
 356                         }
 357                         Template template = templateFactory.createTemplate(templateReader);
 358                         try {
 359                                 template.parse();
 360                         } catch (TemplateException te1) {
 361                                 logger.log(Level.WARNING, "Could not parse template “" + templateName + "” for inclusion!", te1);
 362                         }
 363                         return template;
 364                 }
 365
 366         }
 367
 368 }