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.StringReader;
  24 import java.io.UnsupportedEncodingException;
  25 import java.util.ArrayList;
  26 import java.util.Collection;
  27 import java.util.Collections;
  28 import java.util.HashMap;
  29 import java.util.HashSet;
  30 import java.util.List;
  31 import java.util.Map;
  32 import java.util.Set;
  33 import java.util.UUID;
  34 import java.util.logging.Level;
  35 import java.util.logging.Logger;
  36
  37 import net.pterodactylus.sone.core.Core;
  38 import net.pterodactylus.sone.core.CoreListener;
  39 import net.pterodactylus.sone.data.Post;
  40 import net.pterodactylus.sone.data.Reply;
  41 import net.pterodactylus.sone.data.Sone;
  42 import net.pterodactylus.sone.freenet.L10nFilter;
  43 import net.pterodactylus.sone.freenet.wot.Identity;
  44 import net.pterodactylus.sone.freenet.wot.Trust;
  45 import net.pterodactylus.sone.main.SonePlugin;
  46 import net.pterodactylus.sone.notify.ListNotification;
  47 import net.pterodactylus.sone.template.CollectionAccessor;
  48 import net.pterodactylus.sone.template.CssClassNameFilter;
  49 import net.pterodactylus.sone.template.GetPagePlugin;
  50 import net.pterodactylus.sone.template.IdentityAccessor;
  51 import net.pterodactylus.sone.template.JavascriptFilter;
  52 import net.pterodactylus.sone.template.NotificationManagerAccessor;
  53 import net.pterodactylus.sone.template.ParserFilter;
  54 import net.pterodactylus.sone.template.PostAccessor;
  55 import net.pterodactylus.sone.template.ReplyAccessor;
  56 import net.pterodactylus.sone.template.RequestChangeFilter;
  57 import net.pterodactylus.sone.template.SoneAccessor;
  58 import net.pterodactylus.sone.template.SubstringFilter;
  59 import net.pterodactylus.sone.template.TrustAccessor;
  60 import net.pterodactylus.sone.template.UnknownDateFilter;
  61 import net.pterodactylus.sone.web.ajax.BookmarkAjaxPage;
  62 import net.pterodactylus.sone.web.ajax.CreatePostAjaxPage;
  63 import net.pterodactylus.sone.web.ajax.CreateReplyAjaxPage;
  64 import net.pterodactylus.sone.web.ajax.DeletePostAjaxPage;
  65 import net.pterodactylus.sone.web.ajax.DeleteProfileFieldAjaxPage;
  66 import net.pterodactylus.sone.web.ajax.DeleteReplyAjaxPage;
  67 import net.pterodactylus.sone.web.ajax.DismissNotificationAjaxPage;
  68 import net.pterodactylus.sone.web.ajax.DistrustAjaxPage;
  69 import net.pterodactylus.sone.web.ajax.EditProfileFieldAjaxPage;
  70 import net.pterodactylus.sone.web.ajax.FollowSoneAjaxPage;
  71 import net.pterodactylus.sone.web.ajax.GetLikesAjaxPage;
  72 import net.pterodactylus.sone.web.ajax.GetPostAjaxPage;
  73 import net.pterodactylus.sone.web.ajax.GetReplyAjaxPage;
  74 import net.pterodactylus.sone.web.ajax.GetStatusAjaxPage;
  75 import net.pterodactylus.sone.web.ajax.GetTranslationPage;
  76 import net.pterodactylus.sone.web.ajax.LikeAjaxPage;
  77 import net.pterodactylus.sone.web.ajax.LockSoneAjaxPage;
  78 import net.pterodactylus.sone.web.ajax.MarkAsKnownAjaxPage;
  79 import net.pterodactylus.sone.web.ajax.MoveProfileFieldAjaxPage;
  80 import net.pterodactylus.sone.web.ajax.TrustAjaxPage;
  81 import net.pterodactylus.sone.web.ajax.UnbookmarkAjaxPage;
  82 import net.pterodactylus.sone.web.ajax.UnfollowSoneAjaxPage;
  83 import net.pterodactylus.sone.web.ajax.UnlikeAjaxPage;
  84 import net.pterodactylus.sone.web.ajax.UnlockSoneAjaxPage;
  85 import net.pterodactylus.sone.web.ajax.UntrustAjaxPage;
  86 import net.pterodactylus.sone.web.page.PageToadlet;
  87 import net.pterodactylus.sone.web.page.PageToadletFactory;
  88 import net.pterodactylus.sone.web.page.StaticPage;
  89 import net.pterodactylus.util.cache.Cache;
  90 import net.pterodactylus.util.cache.CacheException;
  91 import net.pterodactylus.util.cache.CacheItem;
  92 import net.pterodactylus.util.cache.DefaultCacheItem;
  93 import net.pterodactylus.util.cache.MemoryCache;
  94 import net.pterodactylus.util.cache.ValueRetriever;
  95 import net.pterodactylus.util.logging.Logging;
  96 import net.pterodactylus.util.notify.Notification;
  97 import net.pterodactylus.util.notify.NotificationManager;
  98 import net.pterodactylus.util.notify.TemplateNotification;
  99 import net.pterodactylus.util.template.CollectionSortFilter;
 100 import net.pterodactylus.util.template.DateFilter;
 101 import net.pterodactylus.util.template.FormatFilter;
 102 import net.pterodactylus.util.template.HtmlFilter;
 103 import net.pterodactylus.util.template.MatchFilter;
 104 import net.pterodactylus.util.template.PaginationPlugin;
 105 import net.pterodactylus.util.template.Provider;
 106 import net.pterodactylus.util.template.ReflectionAccessor;
 107 import net.pterodactylus.util.template.ReplaceFilter;
 108 import net.pterodactylus.util.template.StoreFilter;
 109 import net.pterodactylus.util.template.Template;
 110 import net.pterodactylus.util.template.TemplateContext;
 111 import net.pterodactylus.util.template.TemplateContextFactory;
 112 import net.pterodactylus.util.template.TemplateException;
 113 import net.pterodactylus.util.template.TemplateParser;
 114 import net.pterodactylus.util.template.XmlFilter;
 115 import net.pterodactylus.util.thread.Ticker;
 116 import net.pterodactylus.util.version.Version;
 117 import freenet.clients.http.SessionManager;
 118 import freenet.clients.http.SessionManager.Session;
 119 import freenet.clients.http.ToadletContainer;
 120 import freenet.clients.http.ToadletContext;
 121 import freenet.l10n.BaseL10n;
 122
 123 /**
 124  * Bundles functionality that a web interface of a Freenet plugin needs, e.g.
 125  * references to l10n helpers.
 126  *
 127  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
 128  */
 129 public class WebInterface implements CoreListener {
 130
 131         /** The logger. */
 132         private static final Logger logger = Logging.getLogger(WebInterface.class);
 133
 134         /** The notification manager. */
 135         private final NotificationManager notificationManager = new NotificationManager();
 136
 137         /** The Sone plugin. */
 138         private final SonePlugin sonePlugin;
 139
 140         /** The registered toadlets. */
 141         private final List<PageToadlet> pageToadlets = new ArrayList<PageToadlet>();
 142
 143         /** The form password. */
 144         private final String formPassword;
 145
 146         /** The template context factory. */
 147         private final TemplateContextFactory templateContextFactory;
 148
 149         /** The “new Sone” notification. */
 150         private final ListNotification<Sone> newSoneNotification;
 151
 152         /** The “new post” notification. */
 153         private final ListNotification<Post> newPostNotification;
 154
 155         /** The “new reply” notification. */
 156         private final ListNotification<Reply> newReplyNotification;
 157
 158         /** The “rescuing Sone” notification. */
 159         private final ListNotification<Sone> rescuingSonesNotification;
 160
 161         /** The “Sone rescued” notification. */
 162         private final ListNotification<Sone> sonesRescuedNotification;
 163
 164         /** Sone locked notification ticker objects. */
 165         private final Map<Sone, Object> lockedSonesTickerObjects = Collections.synchronizedMap(new HashMap<Sone, Object>());
 166
 167         /** The “Sone locked” notification. */
 168         private final ListNotification<Sone> lockedSonesNotification;
 169
 170         /** The “new version” notification. */
 171         private final TemplateNotification newVersionNotification;
 172
 173         /**
 174          * Creates a new web interface.
 175          *
 176          * @param sonePlugin
 177          *            The Sone plugin
 178          */
 179         @SuppressWarnings("synthetic-access")
 180         public WebInterface(SonePlugin sonePlugin) {
 181                 this.sonePlugin = sonePlugin;
 182                 formPassword = sonePlugin.pluginRespirator().getToadletContainer().getFormPassword();
 183
 184                 templateContextFactory = new TemplateContextFactory();
 185                 templateContextFactory.addAccessor(Object.class, new ReflectionAccessor());
 186                 templateContextFactory.addAccessor(Collection.class, new CollectionAccessor());
 187                 templateContextFactory.addAccessor(Sone.class, new SoneAccessor(getCore()));
 188                 templateContextFactory.addAccessor(Post.class, new PostAccessor(getCore()));
 189                 templateContextFactory.addAccessor(Reply.class, new ReplyAccessor(getCore()));
 190                 templateContextFactory.addAccessor(Identity.class, new IdentityAccessor(getCore()));
 191                 templateContextFactory.addAccessor(NotificationManager.class, new NotificationManagerAccessor());
 192                 templateContextFactory.addAccessor(Trust.class, new TrustAccessor());
 193                 templateContextFactory.addFilter("date", new DateFilter());
 194                 templateContextFactory.addFilter("html", new HtmlFilter());
 195                 templateContextFactory.addFilter("replace", new ReplaceFilter());
 196                 templateContextFactory.addFilter("store", new StoreFilter());
 197                 templateContextFactory.addFilter("l10n", new L10nFilter(getL10n()));
 198                 templateContextFactory.addFilter("substring", new SubstringFilter());
 199                 templateContextFactory.addFilter("xml", new XmlFilter());
 200                 templateContextFactory.addFilter("change", new RequestChangeFilter());
 201                 templateContextFactory.addFilter("match", new MatchFilter());
 202                 templateContextFactory.addFilter("css", new CssClassNameFilter());
 203                 templateContextFactory.addFilter("js", new JavascriptFilter());
 204                 templateContextFactory.addFilter("parse", new ParserFilter(getCore(), templateContextFactory));
 205                 templateContextFactory.addFilter("unknown", new UnknownDateFilter(getL10n(), "View.Sone.Text.UnknownDate"));
 206                 templateContextFactory.addFilter("format", new FormatFilter());
 207                 templateContextFactory.addFilter("sort", new CollectionSortFilter());
 208                 templateContextFactory.addPlugin("getpage", new GetPagePlugin());
 209                 templateContextFactory.addPlugin("paginate", new PaginationPlugin());
 210                 templateContextFactory.addProvider(Provider.TEMPLATE_CONTEXT_PROVIDER);
 211                 templateContextFactory.addProvider(new ClassPathTemplateProvider());
 212                 templateContextFactory.addTemplateObject("formPassword", formPassword);
 213
 214                 /* create notifications. */
 215                 Template newSoneNotificationTemplate = TemplateParser.parse(createReader("/templates/notify/newSoneNotification.html"));
 216                 newSoneNotification = new ListNotification<Sone>("new-sone-notification", "sones", newSoneNotificationTemplate);
 217
 218                 Template newPostNotificationTemplate = TemplateParser.parse(createReader("/templates/notify/newPostNotification.html"));
 219                 newPostNotification = new ListNotification<Post>("new-post-notification", "posts", newPostNotificationTemplate);
 220
 221                 Template newReplyNotificationTemplate = TemplateParser.parse(createReader("/templates/notify/newReplyNotification.html"));
 222                 newReplyNotification = new ListNotification<Reply>("new-replies-notification", "replies", newReplyNotificationTemplate);
 223
 224                 Template rescuingSonesTemplate = TemplateParser.parse(createReader("/templates/notify/rescuingSonesNotification.html"));
 225                 rescuingSonesNotification = new ListNotification<Sone>("sones-being-rescued-notification", "sones", rescuingSonesTemplate);
 226
 227                 Template sonesRescuedTemplate = TemplateParser.parse(createReader("/templates/notify/sonesRescuedNotification.html"));
 228                 sonesRescuedNotification = new ListNotification<Sone>("sones-rescued-notification", "sones", sonesRescuedTemplate);
 229
 230                 Template lockedSonesTemplate = TemplateParser.parse(createReader("/templates/notify/lockedSonesNotification.html"));
 231                 lockedSonesNotification = new ListNotification<Sone>("sones-locked-notification", "sones", lockedSonesTemplate);
 232
 233                 Template newVersionTemplate = TemplateParser.parse(createReader("/templates/notify/newVersionNotification.html"));
 234                 newVersionNotification = new TemplateNotification("new-version-notification", newVersionTemplate);
 235         }
 236
 237         //
 238         // ACCESSORS
 239         //
 240
 241         /**
 242          * Returns the Sone core used by the Sone plugin.
 243          *
 244          * @return The Sone core
 245          */
 246         public Core getCore() {
 247                 return sonePlugin.core();
 248         }
 249
 250         /**
 251          * Returns the template context factory of the web interface.
 252          *
 253          * @return The template context factory
 254          */
 255         public TemplateContextFactory getTemplateContextFactory() {
 256                 return templateContextFactory;
 257         }
 258
 259         /**
 260          * Returns the current session, creating a new session if there is no
 261          * current session.
 262          *
 263          * @param toadletContenxt
 264          *            The toadlet context
 265          * @return The current session, or {@code null} if there is no current
 266          *         session
 267          */
 268         public Session getCurrentSession(ToadletContext toadletContenxt) {
 269                 return getCurrentSession(toadletContenxt, true);
 270         }
 271
 272         /**
 273          * Returns the current session, creating a new session if there is no
 274          * current session and {@code create} is {@code true}.
 275          *
 276          * @param toadletContenxt
 277          *            The toadlet context
 278          * @param create
 279          *            {@code true} to create a new session if there is no current
 280          *            session, {@code false} otherwise
 281          * @return The current session, or {@code null} if there is no current
 282          *         session
 283          */
 284         public Session getCurrentSession(ToadletContext toadletContenxt, boolean create) {
 285                 Session session = getSessionManager().useSession(toadletContenxt);
 286                 if (create && (session == null)) {
 287                         session = getSessionManager().createSession(UUID.randomUUID().toString(), toadletContenxt);
 288                 }
 289                 return session;
 290         }
 291
 292         /**
 293          * Returns the currently logged in Sone.
 294          *
 295          * @param toadletContext
 296          *            The toadlet context
 297          * @return The currently logged in Sone, or {@code null} if no Sone is
 298          *         currently logged in
 299          */
 300         public Sone getCurrentSone(ToadletContext toadletContext) {
 301                 return getCurrentSone(toadletContext, true);
 302         }
 303
 304         /**
 305          * Returns the currently logged in Sone.
 306          *
 307          * @param toadletContext
 308          *            The toadlet context
 309          * @param create
 310          *            {@code true} to create a new session if no session exists,
 311          *            {@code false} to not create a new session
 312          * @return The currently logged in Sone, or {@code null} if no Sone is
 313          *         currently logged in
 314          */
 315         public Sone getCurrentSone(ToadletContext toadletContext, boolean create) {
 316                 Set<Sone> localSones = getCore().getLocalSones();
 317                 if (localSones.size() == 1) {
 318                         return localSones.iterator().next();
 319                 }
 320                 return getCurrentSone(getCurrentSession(toadletContext, create));
 321         }
 322
 323         /**
 324          * Returns the currently logged in Sone.
 325          *
 326          * @param session
 327          *            The session
 328          * @return The currently logged in Sone, or {@code null} if no Sone is
 329          *         currently logged in
 330          */
 331         public Sone getCurrentSone(Session session) {
 332                 if (session == null) {
 333                         return null;
 334                 }
 335                 String soneId = (String) session.getAttribute("Sone.CurrentSone");
 336                 if (soneId == null) {
 337                         return null;
 338                 }
 339                 return getCore().getLocalSone(soneId, false);
 340         }
 341
 342         /**
 343          * Sets the currently logged in Sone.
 344          *
 345          * @param toadletContext
 346          *            The toadlet context
 347          * @param sone
 348          *            The Sone to set as currently logged in
 349          */
 350         public void setCurrentSone(ToadletContext toadletContext, Sone sone) {
 351                 Session session = getCurrentSession(toadletContext);
 352                 if (sone == null) {
 353                         session.removeAttribute("Sone.CurrentSone");
 354                 } else {
 355                         session.setAttribute("Sone.CurrentSone", sone.getId());
 356                 }
 357         }
 358
 359         /**
 360          * Returns the notification manager.
 361          *
 362          * @return The notification manager
 363          */
 364         public NotificationManager getNotifications() {
 365                 return notificationManager;
 366         }
 367
 368         /**
 369          * Returns the l10n helper of the node.
 370          *
 371          * @return The node’s l10n helper
 372          */
 373         public BaseL10n getL10n() {
 374                 return sonePlugin.l10n().getBase();
 375         }
 376
 377         /**
 378          * Returns the session manager of the node.
 379          *
 380          * @return The node’s session manager
 381          */
 382         public SessionManager getSessionManager() {
 383                 return sonePlugin.pluginRespirator().getSessionManager("Sone");
 384         }
 385
 386         /**
 387          * Returns the node’s form password.
 388          *
 389          * @return The form password
 390          */
 391         public String getFormPassword() {
 392                 return formPassword;
 393         }
 394
 395         /**
 396          * Returns the posts that have been announced as new in the
 397          * {@link #newPostNotification}.
 398          *
 399          * @return The new posts
 400          */
 401         public Set<Post> getNewPosts() {
 402                 return new HashSet<Post>(newPostNotification.getElements());
 403         }
 404
 405         /**
 406          * Returns the replies that have been announced as new in the
 407          * {@link #newReplyNotification}.
 408          *
 409          * @return The new replies
 410          */
 411         public Set<Reply> getNewReplies() {
 412                 return new HashSet<Reply>(newReplyNotification.getElements());
 413         }
 414
 415         /**
 416          * Sets whether the current start of the plugin is the first start. It is
 417          * considered a first start if the configuration file does not exist.
 418          *
 419          * @param firstStart
 420          *            {@code true} if no configuration file existed when Sone was
 421          *            loaded, {@code false} otherwise
 422          */
 423         public void setFirstStart(boolean firstStart) {
 424                 if (firstStart) {
 425                         Template firstStartNotificationTemplate = TemplateParser.parse(createReader("/templates/notify/firstStartNotification.html"));
 426                         Notification firstStartNotification = new TemplateNotification("first-start-notification", firstStartNotificationTemplate);
 427                         notificationManager.addNotification(firstStartNotification);
 428                 }
 429         }
 430
 431         /**
 432          * Sets whether Sone was started with a fresh configuration file.
 433          *
 434          * @param newConfig
 435          *            {@code true} if Sone was started with a fresh configuration,
 436          *            {@code false} if the existing configuration could be read
 437          */
 438         public void setNewConfig(boolean newConfig) {
 439                 if (newConfig && !hasFirstStartNotification()) {
 440                         Template configNotReadNotificationTemplate = TemplateParser.parse(createReader("/templates/notify/configNotReadNotification.html"));
 441                         Notification configNotReadNotification = new TemplateNotification("config-not-read-notification", configNotReadNotificationTemplate);
 442                         notificationManager.addNotification(configNotReadNotification);
 443                 }
 444         }
 445
 446         //
 447         // PRIVATE ACCESSORS
 448         //
 449
 450         /**
 451          * Returns whether the first start notification is currently displayed.
 452          *
 453          * @return {@code true} if the first-start notification is currently
 454          *         displayed, {@code false} otherwise
 455          */
 456         private boolean hasFirstStartNotification() {
 457                 return notificationManager.getNotification("first-start-notification") != null;
 458         }
 459
 460         //
 461         // ACTIONS
 462         //
 463
 464         /**
 465          * Starts the web interface and registers all toadlets.
 466          */
 467         public void start() {
 468                 registerToadlets();
 469
 470                 /* notification templates. */
 471                 Template startupNotificationTemplate = TemplateParser.parse(createReader("/templates/notify/startupNotification.html"));
 472
 473                 final TemplateNotification startupNotification = new TemplateNotification("startup-notification", startupNotificationTemplate);
 474                 notificationManager.addNotification(startupNotification);
 475
 476                 Ticker.getInstance().registerEvent(System.currentTimeMillis() + (120 * 1000), new Runnable() {
 477
 478                         @Override
 479                         public void run() {
 480                                 startupNotification.dismiss();
 481                         }
 482                 }, "Sone Startup Notification Remover");
 483
 484                 Template wotMissingNotificationTemplate = TemplateParser.parse(createReader("/templates/notify/wotMissingNotification.html"));
 485                 final TemplateNotification wotMissingNotification = new TemplateNotification("wot-missing-notification", wotMissingNotificationTemplate);
 486                 Ticker.getInstance().registerEvent(System.currentTimeMillis() + (15 * 1000), new Runnable() {
 487
 488                         @Override
 489                         @SuppressWarnings("synthetic-access")
 490                         public void run() {
 491                                 if (getCore().getIdentityManager().isConnected()) {
 492                                         wotMissingNotification.dismiss();
 493                                 } else {
 494                                         notificationManager.addNotification(wotMissingNotification);
 495                                 }
 496                                 Ticker.getInstance().registerEvent(System.currentTimeMillis() + (15 * 1000), this, "Sone WoT Connector Checker");
 497                         }
 498
 499                 }, "Sone WoT Connector Checker");
 500         }
 501
 502         /**
 503          * Stops the web interface and unregisters all toadlets.
 504          */
 505         public void stop() {
 506                 unregisterToadlets();
 507                 Ticker.getInstance().stop();
 508         }
 509
 510         //
 511         // PRIVATE METHODS
 512         //
 513
 514         /**
 515          * Register all toadlets.
 516          */
 517         private void registerToadlets() {
 518                 Template emptyTemplate = TemplateParser.parse(new StringReader(""));
 519                 Template loginTemplate = TemplateParser.parse(createReader("/templates/login.html"));
 520                 Template indexTemplate = TemplateParser.parse(createReader("/templates/index.html"));
 521                 Template knownSonesTemplate = TemplateParser.parse(createReader("/templates/knownSones.html"));
 522                 Template createSoneTemplate = TemplateParser.parse(createReader("/templates/createSone.html"));
 523                 Template createPostTemplate = TemplateParser.parse(createReader("/templates/createPost.html"));
 524                 Template createReplyTemplate = TemplateParser.parse(createReader("/templates/createReply.html"));
 525                 Template bookmarksTemplate = TemplateParser.parse(createReader("/templates/bookmarks.html"));
 526                 Template editProfileTemplate = TemplateParser.parse(createReader("/templates/editProfile.html"));
 527                 Template editProfileFieldTemplate = TemplateParser.parse(createReader("/templates/editProfileField.html"));
 528                 Template deleteProfileFieldTemplate = TemplateParser.parse(createReader("/templates/deleteProfileField.html"));
 529                 Template viewSoneTemplate = TemplateParser.parse(createReader("/templates/viewSone.html"));
 530                 Template viewPostTemplate = TemplateParser.parse(createReader("/templates/viewPost.html"));
 531                 Template deletePostTemplate = TemplateParser.parse(createReader("/templates/deletePost.html"));
 532                 Template deleteReplyTemplate = TemplateParser.parse(createReader("/templates/deleteReply.html"));
 533                 Template deleteSoneTemplate = TemplateParser.parse(createReader("/templates/deleteSone.html"));
 534                 Template noPermissionTemplate = TemplateParser.parse(createReader("/templates/noPermission.html"));
 535                 Template optionsTemplate = TemplateParser.parse(createReader("/templates/options.html"));
 536                 Template aboutTemplate = TemplateParser.parse(createReader("/templates/about.html"));
 537                 Template invalidTemplate = TemplateParser.parse(createReader("/templates/invalid.html"));
 538                 Template postTemplate = TemplateParser.parse(createReader("/templates/include/viewPost.html"));
 539                 Template replyTemplate = TemplateParser.parse(createReader("/templates/include/viewReply.html"));
 540
 541                 PageToadletFactory pageToadletFactory = new PageToadletFactory(sonePlugin.pluginRespirator().getHLSimpleClient(), "/Sone/");
 542                 pageToadlets.add(pageToadletFactory.createPageToadlet(new IndexPage(indexTemplate, this), "Index"));
 543                 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreateSonePage(createSoneTemplate, this), "CreateSone"));
 544                 pageToadlets.add(pageToadletFactory.createPageToadlet(new KnownSonesPage(knownSonesTemplate, this), "KnownSones"));
 545                 pageToadlets.add(pageToadletFactory.createPageToadlet(new EditProfilePage(editProfileTemplate, this), "EditProfile"));
 546                 pageToadlets.add(pageToadletFactory.createPageToadlet(new EditProfileFieldPage(editProfileFieldTemplate, this)));
 547                 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteProfileFieldPage(deleteProfileFieldTemplate, this)));
 548                 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreatePostPage(createPostTemplate, this)));
 549                 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreateReplyPage(createReplyTemplate, this)));
 550                 pageToadlets.add(pageToadletFactory.createPageToadlet(new ViewSonePage(viewSoneTemplate, this)));
 551                 pageToadlets.add(pageToadletFactory.createPageToadlet(new ViewPostPage(viewPostTemplate, this)));
 552                 pageToadlets.add(pageToadletFactory.createPageToadlet(new LikePage(emptyTemplate, this)));
 553                 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnlikePage(emptyTemplate, this)));
 554                 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeletePostPage(deletePostTemplate, this)));
 555                 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteReplyPage(deleteReplyTemplate, this)));
 556                 pageToadlets.add(pageToadletFactory.createPageToadlet(new LockSonePage(emptyTemplate, this)));
 557                 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnlockSonePage(emptyTemplate, this)));
 558                 pageToadlets.add(pageToadletFactory.createPageToadlet(new FollowSonePage(emptyTemplate, this)));
 559                 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnfollowSonePage(emptyTemplate, this)));
 560                 pageToadlets.add(pageToadletFactory.createPageToadlet(new TrustPage(emptyTemplate, this)));
 561                 pageToadlets.add(pageToadletFactory.createPageToadlet(new DistrustPage(emptyTemplate, this)));
 562                 pageToadlets.add(pageToadletFactory.createPageToadlet(new UntrustPage(emptyTemplate, this)));
 563                 pageToadlets.add(pageToadletFactory.createPageToadlet(new MarkAsKnownPage(emptyTemplate, this)));
 564                 pageToadlets.add(pageToadletFactory.createPageToadlet(new BookmarkPage(emptyTemplate, this)));
 565                 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnbookmarkPage(emptyTemplate, this)));
 566                 pageToadlets.add(pageToadletFactory.createPageToadlet(new BookmarksPage(bookmarksTemplate, this), "Bookmarks"));
 567                 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteSonePage(deleteSoneTemplate, this), "DeleteSone"));
 568                 pageToadlets.add(pageToadletFactory.createPageToadlet(new LoginPage(loginTemplate, this), "Login"));
 569                 pageToadlets.add(pageToadletFactory.createPageToadlet(new LogoutPage(emptyTemplate, this), "Logout"));
 570                 pageToadlets.add(pageToadletFactory.createPageToadlet(new OptionsPage(optionsTemplate, this), "Options"));
 571                 pageToadlets.add(pageToadletFactory.createPageToadlet(new AboutPage(aboutTemplate, this, SonePlugin.VERSION), "About"));
 572                 pageToadlets.add(pageToadletFactory.createPageToadlet(new SoneTemplatePage("noPermission.html", noPermissionTemplate, "Page.NoPermission.Title", this)));
 573                 pageToadlets.add(pageToadletFactory.createPageToadlet(new DismissNotificationPage(emptyTemplate, this)));
 574                 pageToadlets.add(pageToadletFactory.createPageToadlet(new SoneTemplatePage("invalid.html", invalidTemplate, "Page.Invalid.Title", this)));
 575                 pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage("css/", "/static/css/", "text/css")));
 576                 pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage("javascript/", "/static/javascript/", "text/javascript")));
 577                 pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage("images/", "/static/images/", "image/png")));
 578                 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetTranslationPage(this)));
 579                 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetStatusAjaxPage(this)));
 580                 pageToadlets.add(pageToadletFactory.createPageToadlet(new DismissNotificationAjaxPage(this)));
 581                 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreatePostAjaxPage(this)));
 582                 pageToadlets.add(pageToadletFactory.createPageToadlet(new CreateReplyAjaxPage(this)));
 583                 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetReplyAjaxPage(this, replyTemplate)));
 584                 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetPostAjaxPage(this, postTemplate)));
 585                 pageToadlets.add(pageToadletFactory.createPageToadlet(new MarkAsKnownAjaxPage(this)));
 586                 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeletePostAjaxPage(this)));
 587                 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteReplyAjaxPage(this)));
 588                 pageToadlets.add(pageToadletFactory.createPageToadlet(new LockSoneAjaxPage(this)));
 589                 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnlockSoneAjaxPage(this)));
 590                 pageToadlets.add(pageToadletFactory.createPageToadlet(new FollowSoneAjaxPage(this)));
 591                 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnfollowSoneAjaxPage(this)));
 592                 pageToadlets.add(pageToadletFactory.createPageToadlet(new TrustAjaxPage(this)));
 593                 pageToadlets.add(pageToadletFactory.createPageToadlet(new DistrustAjaxPage(this)));
 594                 pageToadlets.add(pageToadletFactory.createPageToadlet(new UntrustAjaxPage(this)));
 595                 pageToadlets.add(pageToadletFactory.createPageToadlet(new LikeAjaxPage(this)));
 596                 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnlikeAjaxPage(this)));
 597                 pageToadlets.add(pageToadletFactory.createPageToadlet(new GetLikesAjaxPage(this)));
 598                 pageToadlets.add(pageToadletFactory.createPageToadlet(new BookmarkAjaxPage(this)));
 599                 pageToadlets.add(pageToadletFactory.createPageToadlet(new UnbookmarkAjaxPage(this)));
 600                 pageToadlets.add(pageToadletFactory.createPageToadlet(new EditProfileFieldAjaxPage(this)));
 601                 pageToadlets.add(pageToadletFactory.createPageToadlet(new DeleteProfileFieldAjaxPage(this)));
 602                 pageToadlets.add(pageToadletFactory.createPageToadlet(new MoveProfileFieldAjaxPage(this)));
 603
 604                 ToadletContainer toadletContainer = sonePlugin.pluginRespirator().getToadletContainer();
 605                 toadletContainer.getPageMaker().addNavigationCategory("/Sone/index.html", "Navigation.Menu.Name", "Navigation.Menu.Tooltip", sonePlugin);
 606                 for (PageToadlet toadlet : pageToadlets) {
 607                         String menuName = toadlet.getMenuName();
 608                         if (menuName != null) {
 609                                 toadletContainer.register(toadlet, "Navigation.Menu.Name", toadlet.path(), true, "Navigation.Menu.Item." + menuName + ".Name", "Navigation.Menu.Item." + menuName + ".Tooltip", false, toadlet);
 610                         } else {
 611                                 toadletContainer.register(toadlet, null, toadlet.path(), true, false);
 612                         }
 613                 }
 614         }
 615
 616         /**
 617          * Unregisters all toadlets.
 618          */
 619         private void unregisterToadlets() {
 620                 ToadletContainer toadletContainer = sonePlugin.pluginRespirator().getToadletContainer();
 621                 for (PageToadlet pageToadlet : pageToadlets) {
 622                         toadletContainer.unregister(pageToadlet);
 623                 }
 624                 toadletContainer.getPageMaker().removeNavigationCategory("Navigation.Menu.Name");
 625         }
 626
 627         /**
 628          * Creates a {@link Reader} from the {@link InputStream} for the resource
 629          * with the given name.
 630          *
 631          * @param resourceName
 632          *            The name of the resource
 633          * @return A {@link Reader} for the resource
 634          */
 635         private Reader createReader(String resourceName) {
 636                 try {
 637                         return new InputStreamReader(getClass().getResourceAsStream(resourceName), "UTF-8");
 638                 } catch (UnsupportedEncodingException uee1) {
 639                         System.out.println("  fail.");
 640                         return null;
 641                 }
 642         }
 643
 644         //
 645         // CORELISTENER METHODS
 646         //
 647
 648         /**
 649          * {@inheritDoc}
 650          */
 651         @Override
 652         public void rescuingSone(Sone sone) {
 653                 rescuingSonesNotification.add(sone);
 654                 notificationManager.addNotification(rescuingSonesNotification);
 655         }
 656
 657         /**
 658          * {@inheritDoc}
 659          */
 660         @Override
 661         public void rescuedSone(Sone sone) {
 662                 rescuingSonesNotification.remove(sone);
 663                 sonesRescuedNotification.add(sone);
 664                 notificationManager.addNotification(sonesRescuedNotification);
 665         }
 666
 667         /**
 668          * {@inheritDoc}
 669          */
 670         @Override
 671         public void newSoneFound(Sone sone) {
 672                 newSoneNotification.add(sone);
 673                 if (!hasFirstStartNotification()) {
 674                         notificationManager.addNotification(newSoneNotification);
 675                 }
 676         }
 677
 678         /**
 679          * {@inheritDoc}
 680          */
 681         @Override
 682         public void newPostFound(Post post) {
 683                 newPostNotification.add(post);
 684                 if (!hasFirstStartNotification()) {
 685                         notificationManager.addNotification(newPostNotification);
 686                 } else {
 687                         getCore().markPostKnown(post);
 688                 }
 689         }
 690
 691         /**
 692          * {@inheritDoc}
 693          */
 694         @Override
 695         public void newReplyFound(Reply reply) {
 696                 if (reply.getPost().getSone() == null) {
 697                         return;
 698                 }
 699                 newReplyNotification.add(reply);
 700                 if (!hasFirstStartNotification()) {
 701                         notificationManager.addNotification(newReplyNotification);
 702                 } else {
 703                         getCore().markReplyKnown(reply);
 704                 }
 705         }
 706
 707         /**
 708          * {@inheritDoc}
 709          */
 710         @Override
 711         public void markSoneKnown(Sone sone) {
 712                 newSoneNotification.remove(sone);
 713         }
 714
 715         /**
 716          * {@inheritDoc}
 717          */
 718         @Override
 719         public void markPostKnown(Post post) {
 720                 newPostNotification.remove(post);
 721         }
 722
 723         /**
 724          * {@inheritDoc}
 725          */
 726         @Override
 727         public void markReplyKnown(Reply reply) {
 728                 newReplyNotification.remove(reply);
 729         }
 730
 731         /**
 732          * {@inheritDoc}
 733          */
 734         @Override
 735         public void postRemoved(Post post) {
 736                 newPostNotification.remove(post);
 737         }
 738
 739         /**
 740          * {@inheritDoc}
 741          */
 742         @Override
 743         public void replyRemoved(Reply reply) {
 744                 newReplyNotification.remove(reply);
 745         }
 746
 747         /**
 748          * {@inheritDoc}
 749          */
 750         @Override
 751         public void soneLocked(final Sone sone) {
 752                 Object tickerObject = Ticker.getInstance().registerEvent(System.currentTimeMillis() + (5 * 60) * 1000, new Runnable() {
 753
 754                         @Override
 755                         @SuppressWarnings("synthetic-access")
 756                         public void run() {
 757                                 lockedSonesNotification.add(sone);
 758                                 lockedSonesTickerObjects.remove(sone);
 759                                 notificationManager.addNotification(lockedSonesNotification);
 760                         }
 761                 }, "Sone Locked Notification");
 762                 lockedSonesTickerObjects.put(sone, tickerObject);
 763         }
 764
 765         /**
 766          * {@inheritDoc}
 767          */
 768         @Override
 769         public void soneUnlocked(Sone sone) {
 770                 lockedSonesNotification.remove(sone);
 771                 Ticker.getInstance().deregisterEvent(lockedSonesTickerObjects.remove(sone));
 772         }
 773
 774         /**
 775          * {@inheritDoc}
 776          */
 777         @Override
 778         public void updateFound(Version version, long releaseTime, long latestEdition) {
 779                 newVersionNotification.getTemplateContext().set("latestVersion", version);
 780                 newVersionNotification.getTemplateContext().set("latestEdition", latestEdition);
 781                 newVersionNotification.getTemplateContext().set("releaseTime", releaseTime);
 782                 notificationManager.addNotification(newVersionNotification);
 783         }
 784
 785         /**
 786          * Template provider implementation that uses
 787          * {@link WebInterface#createReader(String)} to load templates for
 788          * inclusion.
 789          *
 790          * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
 791          */
 792         private class ClassPathTemplateProvider implements Provider {
 793
 794                 /** Cache for templates. */
 795                 private final Cache<String, Template> templateCache = new MemoryCache<String, Template>(new ValueRetriever<String, Template>() {
 796
 797                         @Override
 798                         @SuppressWarnings("synthetic-access")
 799                         public CacheItem<Template> retrieve(String key) throws CacheException {
 800                                 Template template = findTemplate(key);
 801                                 if (template != null) {
 802                                         return new DefaultCacheItem<Template>(template);
 803                                 }
 804                                 return null;
 805                         }
 806                 });
 807
 808                 /**
 809                  * {@inheritDoc}
 810                  */
 811                 @Override
 812                 @SuppressWarnings("synthetic-access")
 813                 public Template getTemplate(TemplateContext templateContext, String templateName) {
 814                         try {
 815                                 return templateCache.get(templateName);
 816                         } catch (CacheException ce1) {
 817                                 logger.log(Level.WARNING, "Could not get template for " + templateName + "!", ce1);
 818                                 return null;
 819                         }
 820                 }
 821
 822                 /**
 823                  * Locates a template in the class path.
 824                  *
 825                  * @param templateName
 826                  *            The name of the template to load
 827                  * @return The loaded template, or {@code null} if no template could be
 828                  *         found
 829                  */
 830                 @SuppressWarnings("synthetic-access")
 831                 private Template findTemplate(String templateName) {
 832                         Reader templateReader = createReader("/templates/" + templateName);
 833                         if (templateReader == null) {
 834                                 return null;
 835                         }
 836                         Template template = null;
 837                         try {
 838                                 template = TemplateParser.parse(templateReader);
 839                         } catch (TemplateException te1) {
 840                                 logger.log(Level.WARNING, "Could not parse template “" + templateName + "” for inclusion!", te1);
 841                         }
 842                         return template;
 843                 }
 844
 845         }
 846
 847 }