X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;f=src%2Fbe%2Fnikiroo%2Fgofetch%2Fsupport%2FBasicSupport.java;h=b7eaca3cfe8e6917e3507212cfbb24d29657be5b;hb=d28c4aac3f42d9de93e3969e86a7c84e2d2e963a;hp=daa0ed16b4cfe52889665fb9a5caaddd7aa2a6f8;hpb=2d95a873f4dc858d9ed55fa1889b1cf29a78f5eb;p=gofetch.git diff --git a/src/be/nikiroo/gofetch/support/BasicSupport.java b/src/be/nikiroo/gofetch/support/BasicSupport.java index daa0ed1..b7eaca3 100644 --- a/src/be/nikiroo/gofetch/support/BasicSupport.java +++ b/src/be/nikiroo/gofetch/support/BasicSupport.java @@ -1,27 +1,134 @@ package be.nikiroo.gofetch.support; import java.io.IOException; -import java.io.InputStream; -import java.net.URL; -import java.net.URLConnection; +import java.util.ArrayList; import java.util.List; -import java.util.zip.GZIPInputStream; -import be.nikiroo.gofetch.data.Comment; +import org.jsoup.helper.StringUtil; +import org.jsoup.nodes.Element; +import org.jsoup.nodes.Node; +import org.jsoup.nodes.TextNode; +import org.jsoup.select.Elements; +import org.jsoup.select.NodeTraversor; +import org.jsoup.select.NodeVisitor; + import be.nikiroo.gofetch.data.Story; +import be.nikiroo.utils.Downloader; public abstract class BasicSupport { + protected static Downloader downloader = new Downloader("gofetcher"); + public enum Type { - SLASHDOT, PIPEDOT, + SLASHDOT, PIPEDOT, LWN, LEMONDE, REGISTER, + } + + /** + * Used to process an element into lines. + * + * @author niki + */ + public interface ElementProcessor { + /** + * Detect if this node is a quote and should be trated as such. + * + * @param node + * the node to check + * @return TRUE if it is + */ + public boolean detectQuote(Node node); + + /** + * Process text content (will be called on each text element, allowing + * you to modify it if needed). + * + * @param text + * the text to process + * @return + */ + public String processText(String text); + + /** + * Ignore this node. + * + * @param node + * the node to ignore + * @return TRUE if it has to be ignored + */ + public boolean ignoreNode(Node node); + + /** + * Manually process this node (and return the manual processing value) + * if so desired. + *

+ * If the node is manually processed, it and its children will not be + * automatically processed. + * + * @param node + * the node to optionally process + * + * @return NULL if not processed (will thus be automatically processed + * as usual), a {@link String} (may be empty) if we process it + * manually -- the given {@link String} will be used instead of + * the usual automatic processing if not NULL + */ + public String manualProcessing(Node node); + } + + /** + * A default {@link ElementProcessor} (will not detect or process anything + * manually). + * + * @author niki + */ + public class BasicElementProcessor implements ElementProcessor { + @Override + public boolean detectQuote(Node node) { + return false; + } + + @Override + public String processText(String text) { + return text; + } + + @Override + public boolean ignoreNode(Node node) { + return false; + } + + @Override + public String manualProcessing(Node node) { + return null; + } } static private String preselector; private Type type; + /** + * List all the recent items, but only assure the ID and internal URL to + * fetch it later on (until it has been fetched, the rest of the + * {@link Story} is not confirmed). + * + * @return the list of new stories + * + * @throws IOException + * in case of I/O + */ abstract public List list() throws IOException; - abstract public List getComments(Story story) throws IOException; + /** + * Fetch the full article content as well as all the comments associated to + * this {@link Story}, if any (can be empty, but not NULL). + * + * @param story + * the story to fetch the comments of + * + * @throws IOException + * in case of I/O error + */ + abstract public void fetch(Story story) throws IOException; abstract public String getDescription(); @@ -45,6 +152,15 @@ public abstract class BasicSupport { BasicSupport.preselector = preselector; } + /** + * Return a {@link BasicSupport} that is compatible with the given + * {@link Type} if it exists (or NULL if not). + * + * @param type + * the type + * + * @return a compatible {@link BasicSupport} if it exists (or NULL if not) + */ static public BasicSupport getSupport(Type type) { BasicSupport support = null; @@ -56,6 +172,15 @@ public abstract class BasicSupport { case PIPEDOT: support = new Pipedot(); break; + case LWN: + support = new LWN(); + break; + case LEMONDE: + support = new LeMonde(); + break; + case REGISTER: + support = new TheRegister(); + break; } if (support != null) { @@ -70,15 +195,157 @@ public abstract class BasicSupport { return preselector + "/" + type + "/"; } - // TODO: check Downloader.java? - static protected InputStream open(URL url) throws IOException { - URLConnection conn = url.openConnection(); - conn.connect(); - InputStream in = conn.getInputStream(); - if ("gzip".equals(conn.getContentEncoding())) { - in = new GZIPInputStream(in); + /** + * Get the first {@link Element} of the given class, or an empty span + * {@link Element} if none found. + * + * @param element + * the element to look in + * @param className + * the class to look for + * + * @return the value or an empty span {@link Element} + */ + static protected Element firstOrEmpty(Element element, String className) { + Elements subElements = element.getElementsByClass(className); + if (subElements.size() > 0) { + return subElements.get(0); + } + + return new Element("span"); + } + + /** + * Get the first {@link Element} of the given tag, or an empty span + * {@link Element} if none found. + * + * @param element + * the element to look in + * @param tagName + * the tag to look for + * + * @return the value or an empty span {@link Element} + */ + static protected Element firstOrEmptyTag(Element element, String tagName) { + Elements subElements = element.getElementsByTag(tagName); + if (subElements.size() > 0) { + return subElements.get(0); + } + + return new Element("span"); + } + + /** + * Process the given element into text (each line is a text paragraph and + * can be prepended with ">" signs to indicate a quote or sub-quote or + * sub-sub-quote...). + * + * @param element + * the element to process + * @param elementProcessor + * the element processor, must not be NULL + * + * @return text lines, each line is a paragraph + */ + static protected List toLines(Element element, + final ElementProcessor elementProcessor) { + final List lines = new ArrayList(); + final StringBuilder currentLine = new StringBuilder(); + final List quoted = new ArrayList(); + final List ignoredNodes = new ArrayList(); + + if (element != null) { + new NodeTraversor(new NodeVisitor() { + @Override + public void head(Node node, int depth) { + String manual = null; + boolean ignore = elementProcessor.ignoreNode(node) + || ignoredNodes.contains(node.parentNode()); + if (!ignore) { + manual = elementProcessor.manualProcessing(node); + if (manual != null) { + currentLine.append(manual); + ignore = true; + } + } + + if (ignore) { + ignoredNodes.add(node); + return; + } + + String prep = ""; + for (int i = 0; i < quoted.size(); i++) { + prep += ">"; + } + prep += " "; + + boolean enterQuote = elementProcessor.detectQuote(node); + boolean leaveQuote = quoted.contains(depth); + + if (enterQuote) { + quoted.add(depth); + } + + if (leaveQuote) { + quoted.remove(Integer.valueOf(depth)); + } + + if (enterQuote || leaveQuote) { + if (currentLine.length() > 0) { + if (currentLine.charAt(currentLine.length() - 1) == '\n') { + currentLine.setLength(currentLine.length() - 1); + } + for (String l : currentLine.toString().split("\n")) { + lines.add(prep + l); + } + } + currentLine.setLength(0); + } + + if (node instanceof Element) { + Element element = (Element) node; + boolean block = element.isBlock() + || element.tagName().equalsIgnoreCase("br"); + if (block && currentLine.length() > 0) { + currentLine.append("\n"); + } + } else if (node instanceof TextNode) { + TextNode textNode = (TextNode) node; + String line = StringUtil.normaliseWhitespace(textNode + .getWholeText()); + + currentLine.append(elementProcessor.processText(line)); + currentLine.append(" "); + } + } + + @Override + public void tail(Node node, int depth) { + } + }).traverse(element); + } + + if (currentLine.length() > 0) { + String prep = ""; + for (int i = 0; i < quoted.size(); i++) { + prep += ">"; + } + prep += " "; + if (currentLine.length() > 0) { + if (currentLine.charAt(currentLine.length() - 1) == '\n') { + currentLine.setLength(currentLine.length() - 1); + } + for (String l : currentLine.toString().split("\n")) { + lines.add(prep + l); + } + } + } + + for (int i = 0; i < lines.size(); i++) { + lines.set(i, lines.get(i).replace(" ", " ").trim()); } - return in; + return lines; } }