code cleanup / jdoc
[nikiroo-utils.git] / src / be / nikiroo / fanfix / supported / Text.java
index 5a4188a2fe6bfa431ccca2cc6eb57904740d42be..252aca0443fbfe0f71db294c0c8c1d3a816deb72 100644 (file)
@@ -1,7 +1,6 @@
 package be.nikiroo.fanfix.supported;
 
 import java.io.File;
-import java.io.FileInputStream;
 import java.io.IOException;
 import java.io.InputStream;
 import java.net.URISyntaxException;
@@ -19,8 +18,8 @@ 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.streams.MarkableFileInputStream;
 import be.nikiroo.utils.Progress;
+import be.nikiroo.utils.streams.MarkableFileInputStream;
 
 /**
  * Support class for local stories encoded in textual format, with a few rules:
@@ -52,8 +51,7 @@ class Text extends BasicSupport {
                        try {
                                in.reset();
                        } catch (IOException e) {
-                               Instance.getTraceHandler().error(
-                                               new IOException("Cannot reset the Text stream", e));
+                               Instance.getInstance().getTraceHandler().error(new IOException("Cannot reset the Text stream", e));
                        }
 
                        return in;
@@ -85,24 +83,21 @@ class Text extends BasicSupport {
 
                meta.setTitle(getTitle());
                meta.setAuthor(getAuthor());
-               meta.setDate(getDate());
+               meta.setDate(bsHelper.formatDate(getDate()));
                meta.setTags(new ArrayList<String>());
-               meta.setSource(getType().getSourceName());
                meta.setUrl(getSourceFile().toURI().toURL().toString());
-               meta.setPublisher("");
                meta.setUuid(getSourceFile().toString());
                meta.setLuid("");
                meta.setLang(getLang()); // default is EN
                meta.setSubject(getSourceFile().getParentFile().getName());
-               meta.setType(getType().toString());
                meta.setImageDocument(false);
                meta.setCover(getCover(getSourceFile()));
-
+               
                return meta;
        }
 
        private String getLang() {
-               @SuppressWarnings("resource")
+               @SuppressWarnings("resource") // cannot close, or we loose getInput()!
                Scanner scan = new Scanner(getInput(), "UTF-8");
                scan.useDelimiter("\\n");
                scan.next(); // Title
@@ -128,14 +123,14 @@ class Text extends BasicSupport {
        }
 
        private String getTitle() {
-               @SuppressWarnings("resource")
+               @SuppressWarnings("resource") // cannot close, or we loose getInput()!
                Scanner scan = new Scanner(getInput(), "UTF-8");
                scan.useDelimiter("\\n");
                return scan.next();
        }
 
        private String getAuthor() {
-               @SuppressWarnings("resource")
+               @SuppressWarnings("resource") // cannot close, or we loose getInput()!
                Scanner scan = new Scanner(getInput(), "UTF-8");
                scan.useDelimiter("\\n");
                scan.next();
@@ -147,11 +142,11 @@ class Text extends BasicSupport {
                        author = authorDate.substring(0, pos);
                }
 
-               return BasicSupportHelper.fixAuthor(author);
+               return bsHelper.fixAuthor(author);
        }
 
        private String getDate() {
-               @SuppressWarnings("resource")
+               @SuppressWarnings("resource") // cannot close, or we loose getInput()!
                Scanner scan = new Scanner(getInput(), "UTF-8");
                scan.useDelimiter("\\n");
                scan.next();
@@ -172,10 +167,10 @@ class Text extends BasicSupport {
 
        @Override
        protected String getDesc() throws IOException {
-               return getChapterContent(null, 0, null);
+               return getChapterContent(null, 0, null).trim();
        }
 
-       private Image getCover(File sourceFile) {
+       protected Image getCover(File sourceFile) {
                String path = sourceFile.getName();
 
                for (String ext : new String[] { ".txt", ".text", ".story" }) {
@@ -184,12 +179,10 @@ class Text extends BasicSupport {
                        }
                }
 
-               Image cover = BasicSupportImages.getImage(this,
-                               sourceFile.getParentFile(), path);
+               Image cover = bsImages.getImage(this, sourceFile.getParentFile(), path);
                if (cover != null) {
                        try {
-                               File tmp = Instance.getTempFiles().createTempFile(
-                                               "test_cover_image");
+                               File tmp = Instance.getInstance().getTempFiles().createTempFile("test_cover_image");
                                ImageUtils.getInstance().saveAsImage(cover, tmp, "png");
                                tmp.delete();
                        } catch (IOException e) {
@@ -204,12 +197,13 @@ class Text extends BasicSupport {
        protected List<Entry<String, URL>> getChapters(Progress pg)
                        throws IOException {
                List<Entry<String, URL>> chaps = new ArrayList<Entry<String, URL>>();
-               @SuppressWarnings("resource")
+               @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(':');
@@ -221,10 +215,8 @@ class Text extends BasicSupport {
                                                chapName, //
                                                getSourceFile().toURI().toURL()));
                        }
-
-                       prevLineEmpty = line.trim().isEmpty();
                }
-
+               
                return chaps;
        }
 
@@ -232,17 +224,27 @@ class Text extends BasicSupport {
        protected String getChapterContent(URL source, int number, Progress pg)
                        throws IOException {
                StringBuilder builder = new StringBuilder();
-               @SuppressWarnings("resource")
+               @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");
                        }
@@ -258,9 +260,8 @@ class Text extends BasicSupport {
                        try {
                                in.close();
                        } catch (IOException e) {
-                               Instance.getTraceHandler().error(
-                                               new IOException(
-                                                               "Cannot close the text source file input", e));
+                               Instance.getInstance().getTraceHandler()
+                                               .error(new IOException("Cannot close the text source file input", e));
                        }
                }
 
@@ -275,6 +276,8 @@ class Text extends BasicSupport {
        /**
         * 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
@@ -284,26 +287,28 @@ class Text extends BasicSupport {
         * @return TRUE if it is supported
         */
        protected boolean supports(URL url, boolean info) {
-               boolean infoPresent = false;
-               if ("file".equals(url.getProtocol())) {
-                       File file;
-                       try {
-                               file = new File(url.toURI());
-                               file = assureNoTxt(file);
-                               file = new File(file.getPath() + ".info");
-                       } catch (URISyntaxException e) {
-                               Instance.getTraceHandler().error(e);
-                               file = null;
-                       }
+               if (!"file".equals(url.getProtocol())) {
+                       return false;
+               }
 
-                       infoPresent = (file != null && file.exists());
+               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" extension if it is present.
+        * Remove the ".txt" (or ".text") extension if it is present.
         * 
         * @param file
         *            the file to process
@@ -312,9 +317,11 @@ class Text extends BasicSupport {
         *         was present
         */
        protected File assureNoTxt(File file) {
-               if (file.getName().endsWith(".txt")) {
-                       file = new File(file.getPath().substring(0,
-                                       file.getPath().length() - 4));
+               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;
@@ -326,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
         */
        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())