2 * Sone - ParserFilter.java - Copyright © 2011–2012 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.Writer;
24 import java.util.ArrayList;
25 import java.util.List;
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;
47 * Filter that filters a given text through a {@link SoneTextParser}.
49 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
51 public class ParserFilter implements Filter {
54 private final Core core;
56 /** The link parser. */
57 private final SoneTextParser soneTextParser;
59 /** The template context factory. */
60 private final TemplateContextFactory templateContextFactory;
62 /** The template for {@link PlainTextPart}s. */
63 private static final Template plainTextTemplate = TemplateParser.parse(new StringReader("<%text|html>"));
65 /** The template for {@link FreenetLinkPart}s. */
66 private static final Template linkTemplate = TemplateParser.parse(new StringReader("<a class=\"<%cssClass|html>\" href=\"<%link|html>\" title=\"<%title|html>\"><%text|html></a>"));
69 * Creates a new filter that runs its input through a {@link SoneTextParser}
74 * @param templateContextFactory
75 * The context factory for rendering the parts
76 * @param soneTextParser
77 * The Sone text parser
79 public ParserFilter(Core core, TemplateContextFactory templateContextFactory, SoneTextParser soneTextParser) {
81 this.templateContextFactory = templateContextFactory;
82 this.soneTextParser = soneTextParser;
89 public Object format(TemplateContext templateContext, Object data, Map<String, Object> parameters) {
90 String text = String.valueOf(data);
91 int length = Numbers.safeParseInteger(parameters.get("length"), Numbers.safeParseInteger(templateContext.get(String.valueOf(parameters.get("length"))), -1));
92 int cutOffLength = Numbers.safeParseInteger(parameters.get("cut-off-length"), Numbers.safeParseInteger(templateContext.get(String.valueOf(parameters.get("cut-off-length"))), length));
93 Object sone = parameters.get("sone");
94 if (sone instanceof String) {
95 sone = core.getSone((String) sone, false);
97 FreenetRequest request = (FreenetRequest) templateContext.get("request");
98 SoneTextParserContext context = new SoneTextParserContext(request, (Sone) sone);
99 StringWriter parsedTextWriter = new StringWriter();
101 Iterable<Part> parts = soneTextParser.parse(context, new StringReader(text));
103 int allPartsLength = 0;
104 List<Part> shortenedParts = new ArrayList<Part>();
105 for (Part part : parts) {
106 if (part instanceof PlainTextPart) {
107 String longText = ((PlainTextPart) part).getText();
108 if (allPartsLength < cutOffLength) {
109 if ((allPartsLength + longText.length()) > cutOffLength) {
110 shortenedParts.add(new PlainTextPart(longText.substring(0, cutOffLength - allPartsLength) + "…"));
112 shortenedParts.add(part);
115 allPartsLength += longText.length();
116 } else if (part instanceof LinkPart) {
117 if (allPartsLength < cutOffLength) {
118 shortenedParts.add(part);
120 allPartsLength += ((LinkPart) part).getText().length();
122 if (allPartsLength < cutOffLength) {
123 shortenedParts.add(part);
127 if (allPartsLength >= length) {
128 parts = shortenedParts;
131 render(parsedTextWriter, parts);
132 } catch (IOException ioe1) {
133 /* no exceptions in a StringReader or StringWriter, ignore. */
135 return parsedTextWriter.toString();
143 * Renders the given parts.
146 * The writer to render the parts to
148 * The parts to render
150 private void render(Writer writer, Iterable<Part> parts) {
151 for (Part part : parts) {
152 render(writer, part);
157 * Renders the given part.
160 * The writer to render the part to
164 @SuppressWarnings("unchecked")
165 private void render(Writer writer, Part part) {
166 if (part instanceof PlainTextPart) {
167 render(writer, (PlainTextPart) part);
168 } else if (part instanceof FreenetLinkPart) {
169 render(writer, (FreenetLinkPart) part);
170 } else if (part instanceof LinkPart) {
171 render(writer, (LinkPart) part);
172 } else if (part instanceof SonePart) {
173 render(writer, (SonePart) part);
174 } else if (part instanceof PostPart) {
175 render(writer, (PostPart) part);
176 } else if (part instanceof Iterable<?>) {
177 render(writer, (Iterable<Part>) part);
182 * Renders the given plain-text part.
185 * The writer to render the part to
186 * @param plainTextPart
189 private void render(Writer writer, PlainTextPart plainTextPart) {
190 TemplateContext templateContext = templateContextFactory.createTemplateContext();
191 templateContext.set("text", plainTextPart.getText());
192 plainTextTemplate.render(templateContext, writer);
196 * Renders the given freenet link part.
199 * The writer to render the part to
200 * @param freenetLinkPart
203 private void render(Writer writer, FreenetLinkPart freenetLinkPart) {
204 renderLink(writer, "/" + freenetLinkPart.getLink(), freenetLinkPart.getText(), freenetLinkPart.getTitle(), freenetLinkPart.isTrusted() ? "freenet-trusted" : "freenet");
208 * Renders the given link part.
211 * The writer to render the part to
215 private void render(Writer writer, LinkPart linkPart) {
216 renderLink(writer, "/?_CHECKED_HTTP_=" + linkPart.getLink(), linkPart.getText(), linkPart.getTitle(), "internet");
220 * Renders the given Sone part.
223 * The writer to render the part to
227 private void render(Writer writer, SonePart sonePart) {
228 if ((sonePart.getSone() != null) && (sonePart.getSone().getName() != null)) {
229 renderLink(writer, "viewSone.html?sone=" + sonePart.getSone().getId(), SoneAccessor.getNiceName(sonePart.getSone()), SoneAccessor.getNiceName(sonePart.getSone()), "in-sone");
231 renderLink(writer, "/WebOfTrust/ShowIdentity?id=" + sonePart.getSone().getId(), sonePart.getSone().getId(), sonePart.getSone().getId(), "in-sone");
236 * Renders the given post part.
239 * The writer to render the part to
243 private void render(Writer writer, PostPart postPart) {
244 SoneTextParser parser = new SoneTextParser(core, core);
245 SoneTextParserContext parserContext = new SoneTextParserContext(null, postPart.getPost().getSone());
247 Iterable<Part> parts = parser.parse(parserContext, new StringReader(postPart.getPost().getText()));
248 StringBuilder excerpt = new StringBuilder();
249 for (Part part : parts) {
250 excerpt.append(part.getText());
251 if (excerpt.length() > 20) {
252 excerpt.setLength(20);
256 renderLink(writer, "viewPost.html?post=" + postPart.getPost().getId(), excerpt.toString(), SoneAccessor.getNiceName(postPart.getPost().getSone()), "in-sone");
257 } catch (IOException ioe1) {
258 /* StringReader shouldn’t throw. */
263 * Renders the given link.
266 * The writer to render the link to
270 * The text of the link
272 * The title of the link
274 * The CSS class of the link
276 private void renderLink(Writer writer, String link, String text, String title, String cssClass) {
277 TemplateContext templateContext = templateContextFactory.createTemplateContext();
278 templateContext.set("cssClass", cssClass);
279 templateContext.set("link", link);
280 templateContext.set("text", text);
281 templateContext.set("title", title);
282 linkTemplate.render(templateContext, writer);
290 * Returns up to {@code length} characters from the given text, appending
291 * “…” if the text is longer.
294 * The text to get an excerpt from
296 * The maximum length of the excerpt (without the ellipsis)
297 * @return The excerpt of the text
299 private static String getExcerpt(String text, int length) {
300 String filteredText = text.replaceAll("(\r\n)+", "\r\n").replaceAll("\n+", "\n").replace("\r\n", " ").replace('\n', ' ');
301 if (filteredText.length() > length) {
302 return filteredText.substring(0, length) + "…";