2 * Sone - ParserFilter.java - Copyright © 2011–2013 David Roden
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.
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.
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/>.
18 package net.pterodactylus.sone.template;
20 import java.io.IOException;
21 import java.io.StringReader;
22 import java.io.StringWriter;
23 import java.io.UnsupportedEncodingException;
24 import java.io.Writer;
25 import java.net.URLEncoder;
26 import java.util.ArrayList;
27 import java.util.List;
30 import net.pterodactylus.sone.core.Core;
31 import net.pterodactylus.sone.data.Sone;
32 import net.pterodactylus.sone.text.FreenetLinkPart;
33 import net.pterodactylus.sone.text.LinkPart;
34 import net.pterodactylus.sone.text.Part;
35 import net.pterodactylus.sone.text.PlainTextPart;
36 import net.pterodactylus.sone.text.PostPart;
37 import net.pterodactylus.sone.text.SonePart;
38 import net.pterodactylus.sone.text.SoneTextParser;
39 import net.pterodactylus.sone.text.SoneTextParserContext;
40 import net.pterodactylus.sone.web.page.FreenetRequest;
41 import net.pterodactylus.util.number.Numbers;
42 import net.pterodactylus.util.template.Filter;
43 import net.pterodactylus.util.template.Template;
44 import net.pterodactylus.util.template.TemplateContext;
45 import net.pterodactylus.util.template.TemplateContextFactory;
46 import net.pterodactylus.util.template.TemplateParser;
49 * Filter that filters a given text through a {@link SoneTextParser}.
51 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
53 public class ParserFilter implements Filter {
56 private final Core core;
58 /** The link parser. */
59 private final SoneTextParser soneTextParser;
61 /** The template context factory. */
62 private final TemplateContextFactory templateContextFactory;
64 /** The template for {@link PlainTextPart}s. */
65 private static final Template plainTextTemplate = TemplateParser.parse(new StringReader("<%text|html>"));
67 /** The template for {@link FreenetLinkPart}s. */
68 private static final Template linkTemplate = TemplateParser.parse(new StringReader("<a class=\"<%cssClass|html>\" href=\"<%link|html>\" title=\"<%title|html>\"><%text|html></a>"));
71 * Creates a new filter that runs its input through a {@link SoneTextParser}
76 * @param templateContextFactory
77 * The context factory for rendering the parts
78 * @param soneTextParser
79 * The Sone text parser
81 public ParserFilter(Core core, TemplateContextFactory templateContextFactory, SoneTextParser soneTextParser) {
83 this.templateContextFactory = templateContextFactory;
84 this.soneTextParser = soneTextParser;
91 public Object format(TemplateContext templateContext, Object data, Map<String, Object> parameters) {
92 String text = String.valueOf(data);
93 int length = Numbers.safeParseInteger(parameters.get("length"), Numbers.safeParseInteger(templateContext.get(String.valueOf(parameters.get("length"))), -1));
94 int cutOffLength = Numbers.safeParseInteger(parameters.get("cut-off-length"), Numbers.safeParseInteger(templateContext.get(String.valueOf(parameters.get("cut-off-length"))), length));
95 Object sone = parameters.get("sone");
96 if (sone instanceof String) {
97 sone = core.getSone((String) sone, false);
99 FreenetRequest request = (FreenetRequest) templateContext.get("request");
100 SoneTextParserContext context = new SoneTextParserContext(request, (Sone) sone);
101 StringWriter parsedTextWriter = new StringWriter();
103 Iterable<Part> parts = soneTextParser.parse(context, new StringReader(text));
105 int allPartsLength = 0;
106 List<Part> shortenedParts = new ArrayList<Part>();
107 for (Part part : parts) {
108 if (part instanceof PlainTextPart) {
109 String longText = ((PlainTextPart) part).getText();
110 if (allPartsLength < cutOffLength) {
111 if ((allPartsLength + longText.length()) > cutOffLength) {
112 shortenedParts.add(new PlainTextPart(longText.substring(0, cutOffLength - allPartsLength) + "…"));
114 shortenedParts.add(part);
117 allPartsLength += longText.length();
118 } else if (part instanceof LinkPart) {
119 if (allPartsLength < cutOffLength) {
120 shortenedParts.add(part);
122 allPartsLength += ((LinkPart) part).getText().length();
124 if (allPartsLength < cutOffLength) {
125 shortenedParts.add(part);
129 if (allPartsLength >= length) {
130 parts = shortenedParts;
133 render(parsedTextWriter, parts);
134 } catch (IOException ioe1) {
135 /* no exceptions in a StringReader or StringWriter, ignore. */
137 return parsedTextWriter.toString();
145 * Renders the given parts.
148 * The writer to render the parts to
150 * The parts to render
152 private void render(Writer writer, Iterable<Part> parts) {
153 for (Part part : parts) {
154 render(writer, part);
159 * Renders the given part.
162 * The writer to render the part to
166 @SuppressWarnings("unchecked")
167 private void render(Writer writer, Part part) {
168 if (part instanceof PlainTextPart) {
169 render(writer, (PlainTextPart) part);
170 } else if (part instanceof FreenetLinkPart) {
171 render(writer, (FreenetLinkPart) part);
172 } else if (part instanceof LinkPart) {
173 render(writer, (LinkPart) part);
174 } else if (part instanceof SonePart) {
175 render(writer, (SonePart) part);
176 } else if (part instanceof PostPart) {
177 render(writer, (PostPart) part);
178 } else if (part instanceof Iterable<?>) {
179 render(writer, (Iterable<Part>) part);
184 * Renders the given plain-text part.
187 * The writer to render the part to
188 * @param plainTextPart
191 private void render(Writer writer, PlainTextPart plainTextPart) {
192 TemplateContext templateContext = templateContextFactory.createTemplateContext();
193 templateContext.set("text", plainTextPart.getText());
194 plainTextTemplate.render(templateContext, writer);
198 * Renders the given freenet link part.
201 * The writer to render the part to
202 * @param freenetLinkPart
205 private void render(Writer writer, FreenetLinkPart freenetLinkPart) {
206 renderLink(writer, "/" + freenetLinkPart.getLink(), freenetLinkPart.getText(), freenetLinkPart.getTitle(), freenetLinkPart.isTrusted() ? "freenet-trusted" : "freenet");
210 * Renders the given link part.
213 * The writer to render the part to
217 private void render(Writer writer, LinkPart linkPart) {
219 renderLink(writer, "/external-link/?_CHECKED_HTTP_=" + URLEncoder.encode(linkPart.getLink(), "UTF-8"), linkPart.getText(), linkPart.getTitle(), "internet");
220 } catch (UnsupportedEncodingException uee1) {
221 /* not possible for UTF-8. */
222 throw new RuntimeException("The JVM does not support UTF-8 encoding!", uee1);
227 * Renders the given Sone part.
230 * The writer to render the part to
234 private void render(Writer writer, SonePart sonePart) {
235 if ((sonePart.getSone() != null) && (sonePart.getSone().getName() != null)) {
236 renderLink(writer, "viewSone.html?sone=" + sonePart.getSone().getId(), SoneAccessor.getNiceName(sonePart.getSone()), SoneAccessor.getNiceName(sonePart.getSone()), "in-sone");
238 renderLink(writer, "/WebOfTrust/ShowIdentity?id=" + sonePart.getSone().getId(), sonePart.getSone().getId(), sonePart.getSone().getId(), "in-sone");
243 * Renders the given post part.
246 * The writer to render the part to
250 private void render(Writer writer, PostPart postPart) {
251 SoneTextParser parser = new SoneTextParser(core, core);
252 SoneTextParserContext parserContext = new SoneTextParserContext(null, postPart.getPost().getSone());
254 Iterable<Part> parts = parser.parse(parserContext, new StringReader(postPart.getPost().getText()));
255 StringBuilder excerpt = new StringBuilder();
256 for (Part part : parts) {
257 excerpt.append(part.getText());
258 if (excerpt.length() > 20) {
259 int lastSpace = excerpt.lastIndexOf(" ", 20);
260 if (lastSpace > -1) {
261 excerpt.setLength(lastSpace);
263 excerpt.setLength(20);
269 renderLink(writer, "viewPost.html?post=" + postPart.getPost().getId(), excerpt.toString(), SoneAccessor.getNiceName(postPart.getPost().getSone()), "in-sone");
270 } catch (IOException ioe1) {
271 /* StringReader shouldn’t throw. */
276 * Renders the given link.
279 * The writer to render the link to
283 * The text of the link
285 * The title of the link
287 * The CSS class of the link
289 private void renderLink(Writer writer, String link, String text, String title, String cssClass) {
290 TemplateContext templateContext = templateContextFactory.createTemplateContext();
291 templateContext.set("cssClass", cssClass);
292 templateContext.set("link", link);
293 templateContext.set("text", text);
294 templateContext.set("title", title);
295 linkTemplate.render(templateContext, writer);