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

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