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