2 * Sone - ParserFilter.java - Copyright © 2011 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.template.Filter;
40 import net.pterodactylus.util.template.Template;
41 import net.pterodactylus.util.template.TemplateContext;
42 import net.pterodactylus.util.template.TemplateContextFactory;
43 import net.pterodactylus.util.template.TemplateParser;
46 * Filter that filters a given text through a {@link SoneTextParser}.
48 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
50 public class ParserFilter implements Filter {
53 private final Core core;
55 /** The link parser. */
56 private final SoneTextParser soneTextParser;
58 /** The template context factory. */
59 private final TemplateContextFactory templateContextFactory;
61 /** The template for {@link PlainTextPart}s. */
62 private final Template plainTextTemplate = TemplateParser.parse(new StringReader("<%text|html>"));
64 /** The template for {@link FreenetLinkPart}s. */
65 private final Template linkTemplate = TemplateParser.parse(new StringReader("<a class=\"<%cssClass|html>\" href=\"<%link|html>\" title=\"<%title|html>\"><%text|html></a>"));
68 * Creates a new filter that runs its input through a {@link SoneTextParser}
73 * @param templateContextFactory
74 * The context factory for rendering the parts
75 * @param soneTextParser
76 * The Sone text parser
78 public ParserFilter(Core core, TemplateContextFactory templateContextFactory, SoneTextParser soneTextParser) {
80 this.templateContextFactory = templateContextFactory;
81 this.soneTextParser = soneTextParser;
88 public Object format(TemplateContext templateContext, Object data, Map<String, String> parameters) {
89 String text = String.valueOf(data);
92 length = Integer.parseInt(parameters.get("length"));
93 } catch (NumberFormatException nfe1) {
96 if ((length == -1) && (parameters.get("length") != null)) {
98 length = Integer.parseInt(String.valueOf(templateContext.get(parameters.get("length"))));
99 } catch (NumberFormatException nfe1) {
103 String soneKey = parameters.get("sone");
104 if (soneKey == null) {
107 Sone sone = (Sone) templateContext.get(soneKey);
109 sone = core.getSone(soneKey, false);
111 FreenetRequest request = (FreenetRequest) templateContext.get("request");
112 SoneTextParserContext context = new SoneTextParserContext(request, sone);
113 StringWriter parsedTextWriter = new StringWriter();
115 Iterable<Part> parts = soneTextParser.parse(context, new StringReader(text));
117 List<Part> shortenedParts = new ArrayList<Part>();
118 for (Part part : parts) {
119 if (part instanceof PlainTextPart) {
120 String longText = ((PlainTextPart) part).getText();
121 if (length >= longText.length()) {
122 shortenedParts.add(part);
124 shortenedParts.add(new PlainTextPart(longText.substring(0, length) + "…"));
126 length -= longText.length();
127 } else if (part instanceof LinkPart) {
128 shortenedParts.add(part);
129 length -= ((LinkPart) part).getText().length();
131 shortenedParts.add(part);
137 parts = shortenedParts;
139 render(parsedTextWriter, parts);
140 } catch (IOException ioe1) {
141 /* no exceptions in a StringReader or StringWriter, ignore. */
143 return parsedTextWriter.toString();
151 * Renders the given parts.
154 * The writer to render the parts to
156 * The parts to render
158 private void render(Writer writer, Iterable<Part> parts) {
159 for (Part part : parts) {
160 render(writer, part);
165 * Renders the given part.
168 * The writer to render the part to
172 @SuppressWarnings("unchecked")
173 private void render(Writer writer, Part part) {
174 if (part instanceof PlainTextPart) {
175 render(writer, (PlainTextPart) part);
176 } else if (part instanceof FreenetLinkPart) {
177 render(writer, (FreenetLinkPart) part);
178 } else if (part instanceof LinkPart) {
179 render(writer, (LinkPart) part);
180 } else if (part instanceof SonePart) {
181 render(writer, (SonePart) part);
182 } else if (part instanceof PostPart) {
183 render(writer, (PostPart) part);
184 } else if (part instanceof Iterable<?>) {
185 render(writer, (Iterable<Part>) part);
190 * Renders the given plain-text part.
193 * The writer to render the part to
194 * @param plainTextPart
197 private void render(Writer writer, PlainTextPart plainTextPart) {
198 TemplateContext templateContext = templateContextFactory.createTemplateContext();
199 templateContext.set("text", plainTextPart.getText());
200 plainTextTemplate.render(templateContext, writer);
204 * Renders the given freenet link part.
207 * The writer to render the part to
208 * @param freenetLinkPart
211 private void render(Writer writer, FreenetLinkPart freenetLinkPart) {
212 renderLink(writer, "/" + freenetLinkPart.getLink(), freenetLinkPart.getText(), freenetLinkPart.getTitle(), freenetLinkPart.isTrusted() ? "freenet-trusted" : "freenet");
216 * Renders the given link part.
219 * The writer to render the part to
223 private void render(Writer writer, LinkPart linkPart) {
224 renderLink(writer, "/?_CHECKED_HTTP_=" + linkPart.getLink(), linkPart.getText(), linkPart.getTitle(), "internet");
228 * Renders the given Sone part.
231 * The writer to render the part to
235 private void render(Writer writer, SonePart sonePart) {
236 renderLink(writer, "viewSone.html?sone=" + sonePart.getSone().getId(), SoneAccessor.getNiceName(sonePart.getSone()), SoneAccessor.getNiceName(sonePart.getSone()), "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 renderLink(writer, "viewPost.html?post=" + postPart.getPost().getId(), getExcerpt(postPart.getPost().getText(), 20), SoneAccessor.getNiceName(postPart.getPost().getSone()), "in-sone");
252 * Renders the given link.
255 * The writer to render the link to
259 * The text of the link
261 * The title of the link
263 * The CSS class of the link
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);
279 * Returns up to {@code length} characters from the given text, appending
280 * “…” if the text is longer.
283 * The text to get an excerpt from
285 * The maximum length of the excerpt (without the ellipsis)
286 * @return The excerpt of the text
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) + "…";