Update nikiroo-utils, bugfixes:
[nikiroo-utils.git] / src / be / nikiroo / fanfix / supported / BasicSupport.java
index 0ee12fec463cef8b1c6dd31093ad2401c9ef4587..c609c70324dd665313cc07b1de4eaa91ccb48060 100644 (file)
@@ -25,7 +25,7 @@ import be.nikiroo.fanfix.data.MetaData;
 import be.nikiroo.fanfix.data.Paragraph;
 import be.nikiroo.fanfix.data.Paragraph.ParagraphType;
 import be.nikiroo.fanfix.data.Story;
-import be.nikiroo.utils.IOUtils;
+import be.nikiroo.utils.ImageUtils;
 import be.nikiroo.utils.Progress;
 import be.nikiroo.utils.StringUtils;
 
@@ -62,6 +62,8 @@ public abstract class BasicSupport {
                E621,
                /** Furry website with stories */
                YIFFSTAR,
+               /** Comics and images groups, mostly but not only NSFW */
+               E_HENTAI,
                /** CBZ files */
                CBZ,
                /** HTML files */
@@ -104,7 +106,8 @@ public abstract class BasicSupport {
                }
 
                /**
-                * Call {@link SupportType#valueOf(String.toUpperCase())}.
+                * Call {@link SupportType#valueOf(String)} after conversion to upper
+                * case.
                 * 
                 * @param typeName
                 *            the possible type name
@@ -117,8 +120,8 @@ public abstract class BasicSupport {
                }
 
                /**
-                * Call {@link SupportType#valueOf(String.toUpperCase())} but return
-                * NULL for NULL instead of raising exception.
+                * Call {@link SupportType#valueOf(String)} after conversion to upper
+                * case but return NULL for NULL instead of raising exception.
                 * 
                 * @param typeName
                 *            the possible type name
@@ -134,8 +137,9 @@ public abstract class BasicSupport {
                }
 
                /**
-                * Call {@link SupportType#valueOf(String.toUpperCase())} but return
-                * NULL in case of error instead of raising an exception.
+                * Call {@link SupportType#valueOf(String)} after conversion to upper
+                * case but return NULL in case of error instead of raising an
+                * exception.
                 * 
                 * @param typeName
                 *            the possible type name
@@ -190,6 +194,19 @@ public abstract class BasicSupport {
         */
        protected abstract boolean isHtml();
 
+       /**
+        * Return the {@link MetaData} of this story.
+        * 
+        * @param source
+        *            the source of the story
+        * @param in
+        *            the input (the main resource)
+        * 
+        * @return the associated {@link MetaData}
+        * 
+        * @throws IOException
+        *             in case of I/O error
+        */
        protected abstract MetaData getMeta(URL source, InputStream in)
                        throws IOException;
 
@@ -254,8 +271,8 @@ public abstract class BasicSupport {
         * @throws IOException
         *             in case of I/O error
         */
+       @SuppressWarnings("unused")
        public void login() throws IOException {
-
        }
 
        /**
@@ -266,14 +283,20 @@ public abstract class BasicSupport {
         * it.
         * 
         * @return the cookies
-        * 
-        * @throws IOException
-        *             in case of I/O error
         */
-       public Map<String, String> getCookies() throws IOException {
+       public Map<String, String> getCookies() {
                return new HashMap<String, String>();
        }
 
+       /**
+        * OAuth authorisation (aka, "bearer XXXXXXX").
+        * 
+        * @return the OAuth string
+        */
+       public String getOAuth() {
+               return null;
+       }
+
        /**
         * Return the canonical form of the main {@link URL}.
         * 
@@ -285,6 +308,7 @@ public abstract class BasicSupport {
         * @throws IOException
         *             in case of I/O error
         */
+       @SuppressWarnings("unused")
        public URL getCanonicalUrl(URL source) throws IOException {
                return source;
        }
@@ -311,9 +335,10 @@ public abstract class BasicSupport {
         * 
         * @param url
         *            the story resource
-        * 
         * @param close
         *            close "this" and "in" when done
+        * @param getDesc
+        *            retrieve the description of the story, or not
         * @param pg
         *            the optional progress reporter
         * 
@@ -337,11 +362,7 @@ public abstract class BasicSupport {
 
                setCurrentReferer(url);
 
-               in = openInput(url);
-               if (in == null) {
-                       return null;
-               }
-
+               in = openInput(url); // NULL allowed here
                try {
                        preprocess(url, getInput());
                        pg.setProgress(30);
@@ -356,7 +377,7 @@ public abstract class BasicSupport {
 
                        pg.setProgress(50);
 
-                       if (meta != null && meta.getCover() == null) {
+                       if (meta.getCover() == null) {
                                meta.setCover(getDefaultCover(meta.getSubject()));
                        }
 
@@ -377,7 +398,7 @@ public abstract class BasicSupport {
                                try {
                                        close();
                                } catch (IOException e) {
-                                       Instance.syserr(e);
+                                       Instance.getTraceHandler().error(e);
                                }
 
                                if (in != null) {
@@ -447,9 +468,12 @@ public abstract class BasicSupport {
                                int i = 1;
                                for (Entry<String, URL> chap : chapters) {
                                        pgChaps.setName("Extracting chapter " + i);
-                                       setCurrentReferer(chap.getValue());
-                                       InputStream chapIn = Instance.getCache().open(
-                                                       chap.getValue(), this, true);
+                                       InputStream chapIn = null;
+                                       if (chap.getValue() != null) {
+                                               setCurrentReferer(chap.getValue());
+                                               chapIn = Instance.getCache().open(chap.getValue(),
+                                                               this, true);
+                                       }
                                        pgChaps.setProgress(i * 100);
                                        try {
                                                Progress pgGetChapterContent = new Progress();
@@ -476,7 +500,9 @@ public abstract class BasicSupport {
                                                        story.getMeta().setWords(words);
                                                }
                                        } finally {
-                                               chapIn.close();
+                                               if (chapIn != null) {
+                                                       chapIn.close();
+                                               }
                                        }
 
                                        i++;
@@ -493,7 +519,7 @@ public abstract class BasicSupport {
                        try {
                                close();
                        } catch (IOException e) {
-                               Instance.syserr(e);
+                               Instance.getTraceHandler().error(e);
                        }
 
                        if (in != null) {
@@ -558,6 +584,7 @@ public abstract class BasicSupport {
         * @throws IOException
         *             on I/O error
         */
+       @SuppressWarnings("unused")
        protected void preprocess(URL source, InputStream in) throws IOException {
        }
 
@@ -567,6 +594,7 @@ public abstract class BasicSupport {
         * @throws IOException
         *             on I/O error
         */
+       @SuppressWarnings("unused")
        protected void close() throws IOException {
        }
 
@@ -574,6 +602,8 @@ public abstract class BasicSupport {
         * Create a {@link Chapter} object from the given information, formatting
         * the content as it should be.
         * 
+        * @param source
+        *            the source of the story
         * @param number
         *            the chapter number
         * @param name
@@ -591,7 +621,8 @@ public abstract class BasicSupport {
        protected Chapter makeChapter(URL source, int number, String name,
                        String content, Progress pg) throws IOException {
                // Chapter name: process it correctly, then remove the possible
-               // redundant "Chapter x: " in front of it
+               // redundant "Chapter x: " in front of it, or "-" (as in
+               // "Chapter 5: - Fun!" after the ": " was automatically added)
                String chapterName = processPara(name).getContent().trim();
                for (String lang : Instance.getConfig().getString(Config.CHAPTER)
                                .split(",")) {
@@ -609,7 +640,7 @@ public abstract class BasicSupport {
                                        Integer.toString(number).length()).trim();
                }
 
-               if (chapterName.startsWith(":")) {
+               while (chapterName.startsWith(":") || chapterName.startsWith("-")) {
                        chapterName = chapterName.substring(1).trim();
                }
                //
@@ -726,17 +757,17 @@ public abstract class BasicSupport {
         * @return the {@link Paragraph}
         */
        private Paragraph makeParagraph(URL source, String line) {
-               URL image = null;
+               BufferedImage image = null;
                if (line.startsWith("[") && line.endsWith("]")) {
-                       image = getImageUrl(this, source,
-                                       line.substring(1, line.length() - 1).trim());
+                       image = getImage(this, source, line.substring(1, line.length() - 1)
+                                       .trim());
                }
 
                if (image != null) {
                        return new Paragraph(image);
-               } else {
-                       return processPara(line);
                }
+
+               return processPara(line);
        }
 
        /**
@@ -819,9 +850,9 @@ public abstract class BasicSupport {
        static String[] getImageExt(boolean emptyAllowed) {
                if (emptyAllowed) {
                        return new String[] { "", ".png", ".jpg", ".jpeg", ".gif", ".bmp" };
-               } else {
-                       return new String[] { ".png", ".jpg", ".jpeg", ".gif", ".bmp" };
                }
+
+               return new String[] { ".png", ".jpg", ".jpeg", ".gif", ".bmp" };
        }
 
        /**
@@ -842,7 +873,7 @@ public abstract class BasicSupport {
                        InputStream in = null;
                        try {
                                in = Instance.getCache().open(url, getSupport(url), true);
-                               return IOUtils.toImage(in);
+                               return ImageUtils.fromStream(in);
                        } catch (IOException e) {
                        } finally {
                                if (in != null) {
@@ -874,19 +905,35 @@ public abstract class BasicSupport {
 
                if (line != null) {
                        // try for files
-                       String path = null;
                        if (source != null) {
-                               path = new File(source.getFile()).getParent();
                                try {
-                                       String basePath = new File(new File(path), line.trim())
-                                                       .getAbsolutePath();
+
+                                       String relPath = null;
+                                       String absPath = null;
+                                       try {
+                                               String path = new File(source.getFile()).getParent();
+                                               relPath = new File(new File(path), line.trim())
+                                                               .getAbsolutePath();
+                                       } catch (Exception e) {
+                                               // Cannot be converted to path (one possibility to take
+                                               // into account: absolute path on Windows)
+                                       }
+                                       try {
+                                               absPath = new File(line.trim()).getAbsolutePath();
+                                       } catch (Exception e) {
+                                               // Cannot be converted to path (at all)
+                                       }
+
                                        for (String ext : getImageExt(true)) {
-                                               if (new File(basePath + ext).exists()) {
-                                                       url = new File(basePath + ext).toURI().toURL();
+                                               if (absPath != null && new File(absPath + ext).exists()) {
+                                                       url = new File(absPath + ext).toURI().toURL();
+                                               } else if (relPath != null
+                                                               && new File(relPath + ext).exists()) {
+                                                       url = new File(relPath + ext).toURI().toURL();
                                                }
                                        }
                                } catch (Exception e) {
-                                       // Nothing to do here
+                                       // Should not happen since we control the correct arguments
                                }
                        }
 
@@ -894,7 +941,8 @@ public abstract class BasicSupport {
                                // try for URLs
                                try {
                                        for (String ext : getImageExt(true)) {
-                                               if (Instance.getCache().check(new URL(line + ext))) {
+                                               if (Instance.getCache()
+                                                               .check(new URL(line + ext), true)) {
                                                        url = new URL(line + ext);
                                                        break;
                                                }
@@ -934,6 +982,9 @@ public abstract class BasicSupport {
 
        /**
         * Open the input file that will be used through the support.
+        * <p>
+        * Can return NULL, in which case you are supposed to work without an
+        * {@link InputStream}.
         * 
         * @param source
         *            the source {@link URL}
@@ -947,22 +998,6 @@ public abstract class BasicSupport {
                return Instance.getCache().open(source, this, false);
        }
 
-       /**
-        * Reset the given {@link InputStream} and return it.
-        * 
-        * @param in
-        *            the {@link InputStream} to reset
-        * 
-        * @return the same {@link InputStream} after reset
-        */
-       protected InputStream reset(InputStream in) {
-               try {
-                       in.reset();
-               } catch (IOException e) {
-               }
-               return in;
-       }
-
        /**
         * Reset then return {@link BasicSupport#in}.
         * 
@@ -1124,9 +1159,9 @@ public abstract class BasicSupport {
                                        if (prev == car) {
                                                builder.append(closeDoubleQuote);
                                                continue;
-                                       } else {
-                                               builder.append(closeQuote);
                                        }
+
+                                       builder.append(closeQuote);
                                }
                        }
 
@@ -1362,7 +1397,12 @@ public abstract class BasicSupport {
                case INFO_TEXT:
                        return new InfoText().setType(type);
                case FIMFICTION:
-                       return new Fimfiction().setType(type);
+                       try {
+                               // Can fail if no client key or NO in options
+                               return new FimfictionApi().setType(type);
+                       } catch (IOException e) {
+                               return new Fimfiction().setType(type);
+                       }
                case FANFICTION:
                        return new Fanfiction().setType(type);
                case TEXT:
@@ -1373,6 +1413,8 @@ public abstract class BasicSupport {
                        return new E621().setType(type);
                case YIFFSTAR:
                        return new YiffStar().setType(type);
+               case E_HENTAI:
+                       return new EHentai().setType(type);
                case CBZ:
                        return new Cbz().setType(type);
                case HTML:
@@ -1382,6 +1424,25 @@ public abstract class BasicSupport {
                return null;
        }
 
+       /**
+        * Reset the given {@link InputStream} and return it.
+        * 
+        * @param in
+        *            the {@link InputStream} to reset
+        * 
+        * @return the same {@link InputStream} after reset
+        */
+       static protected InputStream reset(InputStream in) {
+               try {
+                       if (in != null) {
+                               in.reset();
+                       }
+               } catch (IOException e) {
+               }
+
+               return in;
+       }
+
        /**
         * Return the first line from the given input which correspond to the given
         * selectors.
@@ -1398,7 +1459,8 @@ public abstract class BasicSupport {
         * 
         * @return the line
         */
-       static String getLine(InputStream in, String needle, int relativeLine) {
+       static protected String getLine(InputStream in, String needle,
+                       int relativeLine) {
                return getLine(in, needle, relativeLine, true);
        }
 
@@ -1421,15 +1483,11 @@ public abstract class BasicSupport {
         * 
         * @return the line
         */
-       static String getLine(InputStream in, String needle, int relativeLine,
-                       boolean first) {
+       static protected String getLine(InputStream in, String needle,
+                       int relativeLine, boolean first) {
                String rep = null;
 
-               try {
-                       in.reset();
-               } catch (IOException e) {
-                       Instance.syserr(e);
-               }
+               reset(in);
 
                List<String> lines = new ArrayList<String>();
                @SuppressWarnings("resource")
@@ -1463,4 +1521,133 @@ public abstract class BasicSupport {
 
                return rep;
        }
+
+       /**
+        * Return the text between the key and the endKey (and optional subKey can
+        * be passed, in this case we will look for the key first, then take the
+        * text between the subKey and the endKey).
+        * <p>
+        * Will only match the first line with the given key if more than one are
+        * possible. Which also means that if the subKey or endKey is not found on
+        * that line, NULL will be returned.
+        * 
+        * @param in
+        *            the input
+        * @param key
+        *            the key to match (also supports "^" at start to say
+        *            "only if it starts with" the key)
+        * @param subKey
+        *            the sub key or NULL if none
+        * @param endKey
+        *            the end key or NULL for "up to the end"
+        * @return the text or NULL if not found
+        */
+       static protected String getKeyLine(InputStream in, String key,
+                       String subKey, String endKey) {
+               return getKeyText(getLine(in, key, 0), key, subKey, endKey);
+       }
+
+       /**
+        * Return the text between the key and the endKey (and optional subKey can
+        * be passed, in this case we will look for the key first, then take the
+        * text between the subKey and the endKey).
+        * 
+        * @param in
+        *            the input
+        * @param key
+        *            the key to match (also supports "^" at start to say
+        *            "only if it starts with" the key)
+        * @param subKey
+        *            the sub key or NULL if none
+        * @param endKey
+        *            the end key or NULL for "up to the end"
+        * @return the text or NULL if not found
+        */
+       static protected String getKeyText(String in, String key, String subKey,
+                       String endKey) {
+               String result = null;
+
+               String line = in;
+               if (line != null && line.contains(key)) {
+                       line = line.substring(line.indexOf(key) + key.length());
+                       if (subKey == null || subKey.isEmpty() || line.contains(subKey)) {
+                               if (subKey != null) {
+                                       line = line.substring(line.indexOf(subKey)
+                                                       + subKey.length());
+                               }
+                               if (endKey == null || line.contains(endKey)) {
+                                       if (endKey != null) {
+                                               line = line.substring(0, line.indexOf(endKey));
+                                               result = line;
+                                       }
+                               }
+                       }
+               }
+
+               return result;
+       }
+
+       /**
+        * Return the text between the key and the endKey (optional subKeys can be
+        * passed, in this case we will look for the subKeys first, then take the
+        * text between the key and the endKey).
+        * 
+        * @param in
+        *            the input
+        * @param key
+        *            the key to match
+        * @param endKey
+        *            the end key or NULL for "up to the end"
+        * @param afters
+        *            the sub-keys to find before checking for key/endKey
+        * 
+        * @return the text or NULL if not found
+        */
+       static protected String getKeyTextAfter(String in, String key,
+                       String endKey, String... afters) {
+
+               if (in != null && !in.isEmpty()) {
+                       int pos = indexOfAfter(in, 0, afters);
+                       if (pos < 0) {
+                               return null;
+                       }
+
+                       in = in.substring(pos);
+               }
+
+               return getKeyText(in, key, null, endKey);
+       }
+
+       /**
+        * Return the first index after all the given "afters" have been found in
+        * the {@link String}, or -1 if it was not possible.
+        * 
+        * @param in
+        *            the input
+        * @param startAt
+        *            start at this position in the string
+        * @param afters
+        *            the sub-keys to find before checking for key/endKey
+        * 
+        * @return the text or NULL if not found
+        */
+       static protected int indexOfAfter(String in, int startAt, String... afters) {
+               int pos = -1;
+               if (in != null && !in.isEmpty()) {
+                       pos = startAt;
+                       if (afters != null) {
+                               for (int i = 0; pos >= 0 && i < afters.length; i++) {
+                                       String subKey = afters[i];
+                                       if (!subKey.isEmpty()) {
+                                               pos = in.indexOf(subKey, pos);
+                                               if (pos >= 0) {
+                                                       pos += subKey.length();
+                                               }
+                                       }
+                               }
+                       }
+               }
+
+               return pos;
+       }
 }