code cleanup / jdoc
[nikiroo-utils.git] / src / be / nikiroo / fanfix / supported / Text.java
index 79ee85187abadde363ed1c4fc93c98508f1e2973..252aca0443fbfe0f71db294c0c8c1d3a816deb72 100644 (file)
@@ -5,16 +5,21 @@ import java.io.IOException;
 import java.io.InputStream;
 import java.net.URISyntaxException;
 import java.net.URL;
+import java.util.AbstractMap;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Map.Entry;
 import java.util.Scanner;
 
+import org.jsoup.nodes.Document;
+
 import be.nikiroo.fanfix.Instance;
 import be.nikiroo.fanfix.bundles.Config;
 import be.nikiroo.fanfix.data.MetaData;
 import be.nikiroo.utils.Image;
+import be.nikiroo.utils.ImageUtils;
 import be.nikiroo.utils.Progress;
+import be.nikiroo.utils.streams.MarkableFileInputStream;
 
 /**
  * Support class for local stories encoded in textual format, with a few rules:
@@ -28,58 +33,72 @@ import be.nikiroo.utils.Progress;
  * number</li>
  * <li>A description of the story must be given as chapter number 0</li>
  * <li>A cover may be present, with the same filename but a PNG, JPEG or JPG
- * extension</li<
+ * extension</li>
  * </ul>
  * 
  * @author niki
  */
 class Text extends BasicSupport {
+       private File sourceFile;
+       private InputStream in;
+
+       protected File getSourceFile() {
+               return sourceFile;
+       }
+
+       protected InputStream getInput() {
+               if (in != null) {
+                       try {
+                               in.reset();
+                       } catch (IOException e) {
+                               Instance.getInstance().getTraceHandler().error(new IOException("Cannot reset the Text stream", e));
+                       }
+
+                       return in;
+               }
+
+               return null;
+       }
+
        @Override
        protected boolean isHtml() {
                return false;
        }
 
        @Override
-       public String getSourceName() {
-               return "text";
+       protected Document loadDocument(URL source) throws IOException {
+               try {
+                       sourceFile = new File(source.toURI());
+                       in = new MarkableFileInputStream(sourceFile);
+               } catch (URISyntaxException e) {
+                       throw new IOException("Cannot load the text document: " + source);
+               }
+
+               return null;
        }
 
        @Override
-       protected MetaData getMeta(URL source, InputStream in) throws IOException {
+       protected MetaData getMeta() throws IOException {
                MetaData meta = new MetaData();
 
-               meta.setTitle(getTitle(reset(in)));
-               meta.setAuthor(getAuthor(reset(in)));
-               meta.setDate(getDate(reset(in)));
+               meta.setTitle(getTitle());
+               meta.setAuthor(getAuthor());
+               meta.setDate(bsHelper.formatDate(getDate()));
                meta.setTags(new ArrayList<String>());
-               meta.setSource(getSourceName());
-               meta.setUrl(source.toString());
-               meta.setPublisher("");
-               meta.setUuid(source.toString());
+               meta.setUrl(getSourceFile().toURI().toURL().toString());
+               meta.setUuid(getSourceFile().toString());
                meta.setLuid("");
-               meta.setLang(getLang(reset(in))); // default is EN
-               meta.setSubject(getSubject(source));
-               meta.setType(getType().toString());
+               meta.setLang(getLang()); // default is EN
+               meta.setSubject(getSourceFile().getParentFile().getName());
                meta.setImageDocument(false);
-               meta.setCover(getCover(source));
-
+               meta.setCover(getCover(getSourceFile()));
+               
                return meta;
        }
 
-       private String getSubject(URL source) throws IOException {
-               try {
-                       File file = new File(source.toURI());
-                       return file.getParentFile().getName();
-               } catch (URISyntaxException e) {
-                       throw new IOException("Cannot parse the URL to File: "
-                                       + source.toString(), e);
-               }
-
-       }
-
-       private String getLang(InputStream in) {
-               @SuppressWarnings("resource")
-               Scanner scan = new Scanner(in, "UTF-8");
+       private String getLang() {
+               @SuppressWarnings("resource") // cannot close, or we loose getInput()!
+               Scanner scan = new Scanner(getInput(), "UTF-8");
                scan.useDelimiter("\\n");
                scan.next(); // Title
                scan.next(); // Author (Date)
@@ -95,24 +114,24 @@ class Text extends BasicSupport {
                }
 
                if (lang == null) {
-                       lang = "EN";
+                       lang = "en";
                } else {
-                       lang = lang.toUpperCase();
+                       lang = lang.toLowerCase();
                }
 
                return lang;
        }
 
-       private String getTitle(InputStream in) {
-               @SuppressWarnings("resource")
-               Scanner scan = new Scanner(in, "UTF-8");
+       private String getTitle() {
+               @SuppressWarnings("resource") // cannot close, or we loose getInput()!
+               Scanner scan = new Scanner(getInput(), "UTF-8");
                scan.useDelimiter("\\n");
                return scan.next();
        }
 
-       private String getAuthor(InputStream in) {
-               @SuppressWarnings("resource")
-               Scanner scan = new Scanner(in, "UTF-8");
+       private String getAuthor() {
+               @SuppressWarnings("resource") // cannot close, or we loose getInput()!
+               Scanner scan = new Scanner(getInput(), "UTF-8");
                scan.useDelimiter("\\n");
                scan.next();
                String authorDate = scan.next();
@@ -123,12 +142,12 @@ class Text extends BasicSupport {
                        author = authorDate.substring(0, pos);
                }
 
-               return fixAuthor(author);
+               return bsHelper.fixAuthor(author);
        }
 
-       private String getDate(InputStream in) {
-               @SuppressWarnings("resource")
-               Scanner scan = new Scanner(in, "UTF-8");
+       private String getDate() {
+               @SuppressWarnings("resource") // cannot close, or we loose getInput()!
+               Scanner scan = new Scanner(getInput(), "UTF-8");
                scan.useDelimiter("\\n");
                scan.next();
                String authorDate = scan.next();
@@ -147,18 +166,12 @@ class Text extends BasicSupport {
        }
 
        @Override
-       protected String getDesc(URL source, InputStream in) throws IOException {
-               return getChapterContent(source, in, 0, null);
+       protected String getDesc() throws IOException {
+               return getChapterContent(null, 0, null).trim();
        }
 
-       private Image getCover(URL source) {
-               String path;
-               try {
-                       path = new File(source.toURI()).getPath();
-               } catch (URISyntaxException e) {
-                       Instance.getTraceHandler().error(e);
-                       path = null;
-               }
+       protected Image getCover(File sourceFile) {
+               String path = sourceFile.getName();
 
                for (String ext : new String[] { ".txt", ".text", ".story" }) {
                        if (path.endsWith(ext)) {
@@ -166,66 +179,72 @@ class Text extends BasicSupport {
                        }
                }
 
-               return getImage(this, source, path);
+               Image cover = bsImages.getImage(this, sourceFile.getParentFile(), path);
+               if (cover != null) {
+                       try {
+                               File tmp = Instance.getInstance().getTempFiles().createTempFile("test_cover_image");
+                               ImageUtils.getInstance().saveAsImage(cover, tmp, "png");
+                               tmp.delete();
+                       } catch (IOException e) {
+                               cover = null;
+                       }
+               }
+
+               return cover;
        }
 
        @Override
-       protected List<Entry<String, URL>> getChapters(URL source, InputStream in,
-                       Progress pg) throws IOException {
+       protected List<Entry<String, URL>> getChapters(Progress pg)
+                       throws IOException {
                List<Entry<String, URL>> chaps = new ArrayList<Entry<String, URL>>();
-               @SuppressWarnings("resource")
-               Scanner scan = new Scanner(in, "UTF-8");
+               @SuppressWarnings("resource") // cannot close, or we loose getInput()!
+               Scanner scan = new Scanner(getInput(), "UTF-8");
                scan.useDelimiter("\\n");
-               boolean prevLineEmpty = false;
+               String line = "first is not empty";
                while (scan.hasNext()) {
-                       String line = scan.next();
+                       boolean prevLineEmpty = line.trim().isEmpty();
+                       line = scan.next();
                        if (prevLineEmpty && detectChapter(line, chaps.size() + 1) != null) {
                                String chapName = Integer.toString(chaps.size() + 1);
                                int pos = line.indexOf(':');
                                if (pos >= 0 && pos + 1 < line.length()) {
                                        chapName = line.substring(pos + 1).trim();
                                }
-                               final URL value = source;
-                               final String key = chapName;
-                               chaps.add(new Entry<String, URL>() {
-                                       @Override
-                                       public URL setValue(URL value) {
-                                               return null;
-                                       }
-
-                                       @Override
-                                       public URL getValue() {
-                                               return value;
-                                       }
 
-                                       @Override
-                                       public String getKey() {
-                                               return key;
-                                       }
-                               });
+                               chaps.add(new AbstractMap.SimpleEntry<String, URL>(//
+                                               chapName, //
+                                               getSourceFile().toURI().toURL()));
                        }
-
-                       prevLineEmpty = line.trim().isEmpty();
                }
-
+               
                return chaps;
        }
 
        @Override
-       protected String getChapterContent(URL source, InputStream in, int number,
-                       Progress pg) throws IOException {
+       protected String getChapterContent(URL source, int number, Progress pg)
+                       throws IOException {
                StringBuilder builder = new StringBuilder();
-               @SuppressWarnings("resource")
-               Scanner scan = new Scanner(in, "UTF-8");
+               @SuppressWarnings("resource") // cannot close, or we loose getInput()!
+               Scanner scan = new Scanner(getInput(), "UTF-8");
                scan.useDelimiter("\\n");
-               boolean inChap = false;
+               scan.next(); // title
+               scan.next(); // author
+               scan.next(); // date or empty
+               Boolean inChap = null;
+               String line = "";
                while (scan.hasNext()) {
-                       String line = scan.next();
-                       if (detectChapter(line, number) != null) {
+                       if (number == 0 && !line.trim().isEmpty()) {
+                               // We found pre-chapter content, we are checking for
+                               // Chapter 0 (fake chapter) --> keep the content
+                               if (inChap == null)
+                                       inChap = true;
+                       }
+                       line = scan.next();
+                       if ((inChap == null || !inChap) && detectChapter(line, number) != null) {
                                inChap = true;
-                       } else if (inChap && detectChapter(line, number + 1) != null) {
+                       } else if (detectChapter(line, number + 1) != null) {
                                break;
-                       } else if (inChap) {
+                       } else if (inChap != null && inChap) {
                                builder.append(line);
                                builder.append("\n");
                        }
@@ -235,21 +254,77 @@ class Text extends BasicSupport {
        }
 
        @Override
-       protected boolean supports(URL url) {
-               if ("file".equals(url.getProtocol())) {
-                       File file;
+       protected void close() {
+               InputStream in = getInput();
+               if (in != null) {
                        try {
-                               file = new File(url.toURI());
-                               file = new File(file.getPath() + ".info");
-                       } catch (URISyntaxException e) {
-                               Instance.getTraceHandler().error(e);
-                               file = null;
+                               in.close();
+                       } catch (IOException e) {
+                               Instance.getInstance().getTraceHandler()
+                                               .error(new IOException("Cannot close the text source file input", e));
                        }
+               }
+
+               super.close();
+       }
 
-                       return file == null || !file.exists();
+       @Override
+       protected boolean supports(URL url) {
+               return supports(url, false);
+       }
+
+       /**
+        * Check if we supports this {@link URL}, that is, if the info file can be
+        * found OR not found.
+        * <p>
+        * It must also be a file, not another kind of URL.
+        * 
+        * @param url
+        *            the {@link URL} to check
+        * @param info
+        *            TRUE to require the info file, FALSE to forbid the info file
+        * 
+        * @return TRUE if it is supported
+        */
+       protected boolean supports(URL url, boolean info) {
+               if (!"file".equals(url.getProtocol())) {
+                       return false;
                }
 
-               return false;
+               boolean infoPresent = false;
+               File file;
+               try {
+                       file = new File(url.toURI());
+                       file = assureNoTxt(file);
+                       file = new File(file.getPath() + ".info");
+               } catch (URISyntaxException e) {
+                       Instance.getInstance().getTraceHandler().error(e);
+                       file = null;
+               }
+
+               infoPresent = (file != null && file.exists());
+
+               return infoPresent == info;
+       }
+
+       /**
+        * Remove the ".txt" (or ".text") extension if it is present.
+        * 
+        * @param file
+        *            the file to process
+        * 
+        * @return the same file or a copy of it without the ".txt" extension if it
+        *         was present
+        */
+       protected File assureNoTxt(File file) {
+               for (String ext : new String[] { ".txt", ".text" }) {
+                       if (file.getName().endsWith(ext)) {
+                               file = new File(file.getPath().substring(0,
+                                               file.getPath().length() - ext.length()));
+                       }
+               }
+
+               return file;
        }
 
        /**
@@ -258,21 +333,28 @@ class Text extends BasicSupport {
         * 
         * @param line
         *            the line to check
+        * @param number
+        *            the specific chapter number to check for
         * 
         * @return the language or NULL
         */
-       private String detectChapter(String line, int number) {
+       static private String detectChapter(String line, int number) {
                line = line.toUpperCase();
-               for (String lang : Instance.getConfig().getString(Config.CHAPTER)
-                               .split(",")) {
-                       String chapter = Instance.getConfig().getStringX(Config.CHAPTER,
-                                       lang);
+               for (String lang : Instance.getInstance().getConfig().getList(Config.CONF_CHAPTER)) {
+                       String chapter = Instance.getInstance().getConfig().getStringX(Config.CONF_CHAPTER, lang);
                        if (chapter != null && !chapter.isEmpty()) {
                                chapter = chapter.toUpperCase() + " ";
                                if (line.startsWith(chapter)) {
                                        // We want "[CHAPTER] [number]: [name]", with ": [name]"
                                        // optional
                                        String test = line.substring(chapter.length()).trim();
+
+                                       String possibleNum = test.trim();
+                                       if (possibleNum.indexOf(':') > 0) {
+                                               possibleNum = possibleNum.substring(0,
+                                                               possibleNum.indexOf(':')).trim();
+                                       }
+
                                        if (test.startsWith(Integer.toString(number))) {
                                                test = test
                                                                .substring(Integer.toString(number).length())