src/main/java/net/pterodactylus/sone/template/ParserFilter.java

   1 /*
   2  * Sone - ParserFilter.java - Copyright © 2011–2016 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.template;
  19
  20 import static java.lang.String.valueOf;
  21 import static net.pterodactylus.sone.utils.NumberParsers.parseInt;
  22
  23 import java.io.StringReader;
  24 import java.io.StringWriter;
  25 import java.io.UnsupportedEncodingException;
  26 import java.io.Writer;
  27 import java.net.URLEncoder;
  28 import java.util.ArrayList;
  29 import java.util.List;
  30 import java.util.Map;
  31
  32 import javax.annotation.Nonnull;
  33
  34 import net.pterodactylus.sone.core.Core;
  35 import net.pterodactylus.sone.data.Sone;
  36 import net.pterodactylus.sone.text.FreemailPart;
  37 import net.pterodactylus.sone.text.FreenetLinkPart;
  38 import net.pterodactylus.sone.text.LinkPart;
  39 import net.pterodactylus.sone.text.Part;
  40 import net.pterodactylus.sone.text.PlainTextPart;
  41 import net.pterodactylus.sone.text.PostPart;
  42 import net.pterodactylus.sone.text.SonePart;
  43 import net.pterodactylus.sone.text.SoneTextParser;
  44 import net.pterodactylus.sone.text.SoneTextParserContext;
  45 import net.pterodactylus.util.template.Filter;
  46 import net.pterodactylus.util.template.Template;
  47 import net.pterodactylus.util.template.TemplateContext;
  48 import net.pterodactylus.util.template.TemplateContextFactory;
  49 import net.pterodactylus.util.template.TemplateParser;
  50
  51 import com.google.common.base.Function;
  52 import com.google.common.base.Optional;
  53
  54 /**
  55  * Filter that filters a given text through a {@link SoneTextParser}.
  56  *
  57  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  58  */
  59 public class ParserFilter implements Filter {
  60
  61         /** The core. */
  62         private final Core core;
  63
  64         /** The link parser. */
  65         private final SoneTextParser soneTextParser;
  66
  67         /** The template context factory. */
  68         private final TemplateContextFactory templateContextFactory;
  69
  70         /** The template for {@link PlainTextPart}s. */
  71         private static final Template plainTextTemplate = TemplateParser.parse(new StringReader("<%text|html>"));
  72
  73         /** The template for {@link FreenetLinkPart}s. */
  74         private static final Template linkTemplate = TemplateParser.parse(new StringReader("<a class=\"<%cssClass|html>\" href=\"<%link|html>\" title=\"<%title|html>\"><%text|html></a>"));
  75
  76         /**
  77          * Creates a new filter that runs its input through a {@link SoneTextParser}
  78          * .
  79          *
  80          * @param core
  81          *            The core
  82          * @param templateContextFactory
  83          *            The context factory for rendering the parts
  84          * @param soneTextParser
  85          *            The Sone text parser
  86          */
  87         public ParserFilter(Core core, TemplateContextFactory templateContextFactory, SoneTextParser soneTextParser) {
  88                 this.core = core;
  89                 this.templateContextFactory = templateContextFactory;
  90                 this.soneTextParser = soneTextParser;
  91         }
  92
  93         /**
  94          * {@inheritDoc}
  95          */
  96         @Override
  97         public Object format(TemplateContext templateContext, Object data, Map<String, Object> parameters) {
  98                 String text = valueOf(data);
  99                 int length = parseInt(valueOf(parameters.get("length")), -1);
 100                 int cutOffLength = parseInt(valueOf(parameters.get("cut-off-length")), length);
 101                 Object sone = parameters.get("sone");
 102                 if (sone instanceof String) {
 103                         sone = core.getSone((String) sone).orNull();
 104                 }
 105                 SoneTextParserContext context = new SoneTextParserContext((Sone) sone);
 106                 StringWriter parsedTextWriter = new StringWriter();
 107                 Iterable<Part> parts = soneTextParser.parse(text, context);
 108                 if (length > -1) {
 109                         int allPartsLength = 0;
 110                         List<Part> shortenedParts = new ArrayList<Part>();
 111                         for (Part part : parts) {
 112                                 if (part instanceof PlainTextPart) {
 113                                         String longText = part.getText();
 114                                         if (allPartsLength < cutOffLength) {
 115                                                 if ((allPartsLength + longText.length()) > cutOffLength) {
 116                                                         shortenedParts.add(new PlainTextPart(longText.substring(0, cutOffLength - allPartsLength) + "…"));
 117                                                 } else {
 118                                                         shortenedParts.add(part);
 119                                                 }
 120                                         }
 121                                         allPartsLength += longText.length();
 122                                 } else if (part instanceof LinkPart) {
 123                                         if (allPartsLength < cutOffLength) {
 124                                                 shortenedParts.add(part);
 125                                         }
 126                                         allPartsLength += part.getText().length();
 127                                 } else {
 128                                         if (allPartsLength < cutOffLength) {
 129                                                 shortenedParts.add(part);
 130                                         }
 131                                 }
 132                         }
 133                         if (allPartsLength >= length) {
 134                                 parts = shortenedParts;
 135                         }
 136                 }
 137                 render(parsedTextWriter, parts);
 138                 return parsedTextWriter.toString();
 139         }
 140
 141         //
 142         // PRIVATE METHODS
 143         //
 144
 145         /**
 146          * Renders the given parts.
 147          *
 148          * @param writer
 149          *            The writer to render the parts to
 150          * @param parts
 151          *            The parts to render
 152          */
 153         private void render(Writer writer, Iterable<Part> parts) {
 154                 for (Part part : parts) {
 155                         render(writer, part);
 156                 }
 157         }
 158
 159         /**
 160          * Renders the given part.
 161          *
 162          * @param writer
 163          *            The writer to render the part to
 164          * @param part
 165          *            The part to render
 166          */
 167         @SuppressWarnings("unchecked")
 168         private void render(Writer writer, Part part) {
 169                 if (part instanceof PlainTextPart) {
 170                         render(writer, (PlainTextPart) part);
 171                 } else if (part instanceof FreenetLinkPart) {
 172                         render(writer, (FreenetLinkPart) part);
 173                 } else if (part instanceof LinkPart) {
 174                         render(writer, (LinkPart) part);
 175                 } else if (part instanceof SonePart) {
 176                         render(writer, (SonePart) part);
 177                 } else if (part instanceof PostPart) {
 178                         render(writer, (PostPart) part);
 179                 } else if (part instanceof FreemailPart) {
 180                         render(writer, (FreemailPart) part);
 181                 } else if (part instanceof Iterable<?>) {
 182                         render(writer, (Iterable<Part>) part);
 183                 }
 184         }
 185
 186         /**
 187          * Renders the given plain-text part.
 188          *
 189          * @param writer
 190          *            The writer to render the part to
 191          * @param plainTextPart
 192          *            The part to render
 193          */
 194         private void render(Writer writer, PlainTextPart plainTextPart) {
 195                 TemplateContext templateContext = templateContextFactory.createTemplateContext();
 196                 templateContext.set("text", plainTextPart.getText());
 197                 plainTextTemplate.render(templateContext, writer);
 198         }
 199
 200         /**
 201          * Renders the given freenet link part.
 202          *
 203          * @param writer
 204          *            The writer to render the part to
 205          * @param freenetLinkPart
 206          *            The part to render
 207          */
 208         private void render(Writer writer, FreenetLinkPart freenetLinkPart) {
 209                 renderLink(writer, "/" + freenetLinkPart.getLink(), freenetLinkPart.getText(), freenetLinkPart.getTitle(), freenetLinkPart.isTrusted() ? "freenet-trusted" : "freenet");
 210         }
 211
 212         /**
 213          * Renders the given link part.
 214          *
 215          * @param writer
 216          *            The writer to render the part to
 217          * @param linkPart
 218          *            The part to render
 219          */
 220         private void render(Writer writer, LinkPart linkPart) {
 221                 try {
 222                         renderLink(writer, "/external-link/?_CHECKED_HTTP_=" + URLEncoder.encode(linkPart.getLink(), "UTF-8"), linkPart.getText(), linkPart.getTitle(), "internet");
 223                 } catch (UnsupportedEncodingException uee1) {
 224                         /* not possible for UTF-8. */
 225                         throw new RuntimeException("The JVM does not support UTF-8 encoding!", uee1);
 226                 }
 227         }
 228
 229         /**
 230          * Renders the given Sone part.
 231          *
 232          * @param writer
 233          *            The writer to render the part to
 234          * @param sonePart
 235          *            The part to render
 236          */
 237         private void render(Writer writer, SonePart sonePart) {
 238                 if ((sonePart.getSone() != null) && (sonePart.getSone().getName() != null)) {
 239                         renderLink(writer, "viewSone.html?sone=" + sonePart.getSone().getId(), SoneAccessor.getNiceName(sonePart.getSone()), SoneAccessor.getNiceName(sonePart.getSone()), "in-sone");
 240                 } else {
 241                         renderLink(writer, "/WebOfTrust/ShowIdentity?id=" + sonePart.getSone().getId(), sonePart.getSone().getId(), sonePart.getSone().getId(), "in-sone");
 242                 }
 243         }
 244
 245         /**
 246          * Renders the given post part.
 247          *
 248          * @param writer
 249          *            The writer to render the part to
 250          * @param postPart
 251          *            The part to render
 252          */
 253         private void render(Writer writer, PostPart postPart) {
 254                 SoneTextParser parser = new SoneTextParser(core, core);
 255                 SoneTextParserContext parserContext = new SoneTextParserContext(postPart.getPost().getSone());
 256                 Iterable<Part> parts = parser.parse(postPart.getPost().getText(), parserContext);
 257                 StringBuilder excerpt = new StringBuilder();
 258                 for (Part part : parts) {
 259                         excerpt.append(part.getText());
 260                         if (excerpt.length() > 20) {
 261                                 int lastSpace = excerpt.lastIndexOf(" ", 20);
 262                                 if (lastSpace > -1) {
 263                                         excerpt.setLength(lastSpace);
 264                                 } else {
 265                                         excerpt.setLength(20);
 266                                 }
 267                                 excerpt.append("…");
 268                                 break;
 269                         }
 270                 }
 271                 renderLink(writer, "viewPost.html?post=" + postPart.getPost().getId(), excerpt.toString(), SoneAccessor.getNiceName(postPart.getPost().getSone()), "in-sone");
 272         }
 273
 274         private void render(@Nonnull Writer writer, @Nonnull FreemailPart freemailPart) {
 275                 Optional<Sone> sone = core.getSone(freemailPart.getIdentityId());
 276                 String soneName = sone.transform(new Function<Sone, String>() {
 277                         @Nonnull
 278                         @Override
 279                         public String apply(Sone input) {
 280                                 return SoneAccessor.getNiceName(input);
 281                         }
 282                 }).or(freemailPart.getIdentityId());
 283                 renderLink(writer,
 284                                 "/Freemail/NewMessage?to=" + freemailPart.getIdentityId(),
 285                                 String.format("%s@%s.freemail", freemailPart.getEmailLocalPart(), soneName),
 286                                 String.format("%s\n%s@%s.freemail", soneName, freemailPart.getEmailLocalPart(), freemailPart.getFreemailId()),
 287                                 "in-sone");
 288         }
 289
 290         /**
 291          * Renders the given link.
 292          *
 293          * @param writer
 294          *            The writer to render the link to
 295          * @param link
 296          *            The link to render
 297          * @param text
 298          *            The text of the link
 299          * @param title
 300          *            The title of the link
 301          * @param cssClass
 302          *            The CSS class of the link
 303          */
 304         private void renderLink(Writer writer, String link, String text, String title, String cssClass) {
 305                 TemplateContext templateContext = templateContextFactory.createTemplateContext();
 306                 templateContext.set("cssClass", cssClass);
 307                 templateContext.set("link", link);
 308                 templateContext.set("text", text);
 309                 templateContext.set("title", title);
 310                 linkTemplate.render(templateContext, writer);
 311         }
 312
 313 }