2 * Sone - ParserFilter.java - Copyright © 2011–2016 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 static java.lang.String.valueOf;
21 import static net.pterodactylus.sone.utils.NumberParsers.parseInt;
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;
32 import net.pterodactylus.sone.core.Core;
33 import net.pterodactylus.sone.data.Sone;
34 import net.pterodactylus.sone.text.FreenetLinkPart;
35 import net.pterodactylus.sone.text.LinkPart;
36 import net.pterodactylus.sone.text.Part;
37 import net.pterodactylus.sone.text.PlainTextPart;
38 import net.pterodactylus.sone.text.PostPart;
39 import net.pterodactylus.sone.text.SonePart;
40 import net.pterodactylus.sone.text.SoneTextParser;
41 import net.pterodactylus.sone.text.SoneTextParserContext;
42 import net.pterodactylus.sone.web.page.FreenetRequest;
43 import net.pterodactylus.util.template.Filter;
44 import net.pterodactylus.util.template.Template;
45 import net.pterodactylus.util.template.TemplateContext;
46 import net.pterodactylus.util.template.TemplateContextFactory;
47 import net.pterodactylus.util.template.TemplateParser;
50 * Filter that filters a given text through a {@link SoneTextParser}.
52 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
54 public class ParserFilter implements Filter {
57 private final Core core;
59 /** The link parser. */
60 private final SoneTextParser soneTextParser;
62 /** The template context factory. */
63 private final TemplateContextFactory templateContextFactory;
65 /** The template for {@link PlainTextPart}s. */
66 private static final Template plainTextTemplate = TemplateParser.parse(new StringReader("<%text|html>"));
68 /** The template for {@link FreenetLinkPart}s. */
69 private static final Template linkTemplate = TemplateParser.parse(new StringReader("<a class=\"<%cssClass|html>\" href=\"<%link|html>\" title=\"<%title|html>\"><%text|html></a>"));
72 * Creates a new filter that runs its input through a {@link SoneTextParser}
77 * @param templateContextFactory
78 * The context factory for rendering the parts
79 * @param soneTextParser
80 * The Sone text parser
82 public ParserFilter(Core core, TemplateContextFactory templateContextFactory, SoneTextParser soneTextParser) {
84 this.templateContextFactory = templateContextFactory;
85 this.soneTextParser = soneTextParser;
92 public Object format(TemplateContext templateContext, Object data, Map<String, Object> parameters) {
93 String text = valueOf(data);
94 int length = parseInt(valueOf(parameters.get("length")), -1);
95 int cutOffLength = parseInt(valueOf(parameters.get("cut-off-length")), length);
96 Object sone = parameters.get("sone");
97 if (sone instanceof String) {
98 sone = core.getSone((String) sone).orNull();
100 FreenetRequest request = (FreenetRequest) templateContext.get("request");
101 SoneTextParserContext context = new SoneTextParserContext(request, (Sone) sone);
102 StringWriter parsedTextWriter = new StringWriter();
103 Iterable<Part> parts = soneTextParser.parse(text, context);
105 int allPartsLength = 0;
106 List<Part> shortenedParts = new ArrayList<Part>();
107 for (Part part : parts) {
108 if (part instanceof PlainTextPart) {
109 String longText = 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 += part.getText().length();
124 if (allPartsLength < cutOffLength) {
125 shortenedParts.add(part);
129 if (allPartsLength >= length) {
130 parts = shortenedParts;
133 render(parsedTextWriter, parts);
134 return parsedTextWriter.toString();
142 * Renders the given parts.
145 * The writer to render the parts to
147 * The parts to render
149 private void render(Writer writer, Iterable<Part> parts) {
150 for (Part part : parts) {
151 render(writer, part);
156 * Renders the given part.
159 * The writer to render the part to
163 @SuppressWarnings("unchecked")
164 private void render(Writer writer, Part part) {
165 if (part instanceof PlainTextPart) {
166 render(writer, (PlainTextPart) part);
167 } else if (part instanceof FreenetLinkPart) {
168 render(writer, (FreenetLinkPart) part);
169 } else if (part instanceof LinkPart) {
170 render(writer, (LinkPart) part);
171 } else if (part instanceof SonePart) {
172 render(writer, (SonePart) part);
173 } else if (part instanceof PostPart) {
174 render(writer, (PostPart) part);
175 } else if (part instanceof Iterable<?>) {
176 render(writer, (Iterable<Part>) part);
181 * Renders the given plain-text part.
184 * The writer to render the part to
185 * @param plainTextPart
188 private void render(Writer writer, PlainTextPart plainTextPart) {
189 TemplateContext templateContext = templateContextFactory.createTemplateContext();
190 templateContext.set("text", plainTextPart.getText());
191 plainTextTemplate.render(templateContext, writer);
195 * Renders the given freenet link part.
198 * The writer to render the part to
199 * @param freenetLinkPart
202 private void render(Writer writer, FreenetLinkPart freenetLinkPart) {
203 renderLink(writer, "/" + freenetLinkPart.getLink(), freenetLinkPart.getText(), freenetLinkPart.getTitle(), freenetLinkPart.isTrusted() ? "freenet-trusted" : "freenet");
207 * Renders the given link part.
210 * The writer to render the part to
214 private void render(Writer writer, LinkPart linkPart) {
216 renderLink(writer, "/external-link/?_CHECKED_HTTP_=" + URLEncoder.encode(linkPart.getLink(), "UTF-8"), linkPart.getText(), linkPart.getTitle(), "internet");
217 } catch (UnsupportedEncodingException uee1) {
218 /* not possible for UTF-8. */
219 throw new RuntimeException("The JVM does not support UTF-8 encoding!", uee1);
224 * Renders the given Sone part.
227 * The writer to render the part to
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");
235 renderLink(writer, "/WebOfTrust/ShowIdentity?id=" + sonePart.getSone().getId(), sonePart.getSone().getId(), sonePart.getSone().getId(), "in-sone");
240 * Renders the given post part.
243 * The writer to render the part to
247 private void render(Writer writer, PostPart postPart) {
248 SoneTextParser parser = new SoneTextParser(core, core);
249 SoneTextParserContext parserContext = new SoneTextParserContext(null, postPart.getPost().getSone());
250 Iterable<Part> parts = parser.parse(postPart.getPost().getText(), parserContext);
251 StringBuilder excerpt = new StringBuilder();
252 for (Part part : parts) {
253 excerpt.append(part.getText());
254 if (excerpt.length() > 20) {
255 int lastSpace = excerpt.lastIndexOf(" ", 20);
256 if (lastSpace > -1) {
257 excerpt.setLength(lastSpace);
259 excerpt.setLength(20);
265 renderLink(writer, "viewPost.html?post=" + postPart.getPost().getId(), excerpt.toString(), SoneAccessor.getNiceName(postPart.getPost().getSone()), "in-sone");
269 * Renders the given link.
272 * The writer to render the link to
276 * The text of the link
278 * The title of the link
280 * The CSS class of the link
282 private void renderLink(Writer writer, String link, String text, String title, String cssClass) {
283 TemplateContext templateContext = templateContextFactory.createTemplateContext();
284 templateContext.set("cssClass", cssClass);
285 templateContext.set("link", link);
286 templateContext.set("text", text);
287 templateContext.set("title", title);
288 linkTemplate.render(templateContext, writer);