1 package be
.nikiroo
.fanfix
.supported
;
3 import java
.io
.BufferedReader
;
4 import java
.io
.ByteArrayInputStream
;
6 import java
.io
.IOException
;
7 import java
.io
.InputStream
;
8 import java
.io
.InputStreamReader
;
9 import java
.net
.MalformedURLException
;
11 import java
.util
.ArrayList
;
12 import java
.util
.Date
;
13 import java
.util
.List
;
14 import java
.util
.Map
.Entry
;
15 import java
.util
.Scanner
;
17 import be
.nikiroo
.fanfix
.Instance
;
18 import be
.nikiroo
.fanfix
.bundles
.Config
;
19 import be
.nikiroo
.fanfix
.bundles
.StringId
;
20 import be
.nikiroo
.fanfix
.data
.Chapter
;
21 import be
.nikiroo
.fanfix
.data
.MetaData
;
22 import be
.nikiroo
.fanfix
.data
.Paragraph
;
23 import be
.nikiroo
.fanfix
.data
.Paragraph
.ParagraphType
;
24 import be
.nikiroo
.fanfix
.data
.Story
;
25 import be
.nikiroo
.utils
.Image
;
26 import be
.nikiroo
.utils
.Progress
;
27 import be
.nikiroo
.utils
.StringUtils
;
30 * DEPRECATED: use the new Jsoup 'Node' system.
32 * This class is the base class used by the other support classes. It can be
33 * used outside of this package, and have static method that you can use to get
34 * access to the correct support class.
36 * It will be used with 'resources' (usually web pages or files).
41 public abstract class BasicSupport_Deprecated
extends BasicSupport
{
42 private InputStream in
;
45 private char openQuote
= Instance
.getInstance().getTrans().getCharacter(StringId
.OPEN_SINGLE_QUOTE
);
46 private char closeQuote
= Instance
.getInstance().getTrans().getCharacter(StringId
.CLOSE_SINGLE_QUOTE
);
47 private char openDoubleQuote
= Instance
.getInstance().getTrans().getCharacter(StringId
.OPEN_DOUBLE_QUOTE
);
48 private char closeDoubleQuote
= Instance
.getInstance().getTrans().getCharacter(StringId
.CLOSE_DOUBLE_QUOTE
);
50 // New methods not used in Deprecated mode
52 protected String
getDesc() throws IOException
{
53 throw new RuntimeException("should not be used by legacy code");
57 protected MetaData
getMeta() throws IOException
{
58 throw new RuntimeException("should not be used by legacy code");
62 protected List
<Entry
<String
, URL
>> getChapters(Progress pg
)
64 throw new RuntimeException("should not be used by legacy code");
68 protected String
getChapterContent(URL chapUrl
, int number
, Progress pg
)
70 throw new RuntimeException("should not be used by legacy code");
74 public Story
process(Progress pg
) throws IOException
{
75 return process(getSource(), pg
);
81 * Return the {@link MetaData} of this story.
84 * the source of the story
86 * the input (the main resource)
88 * @return the associated {@link MetaData}, never NULL
91 * in case of I/O error
93 protected abstract MetaData
getMeta(URL source
, InputStream in
)
97 * Return the story description.
100 * the source of the story
102 * the input (the main resource)
104 * @return the description
106 * @throws IOException
107 * in case of I/O error
109 protected abstract String
getDesc(URL source
, InputStream in
)
113 * Return the list of chapters (name and resource).
116 * the source of the story
118 * the input (the main resource)
120 * the optional progress reporter
122 * @return the chapters
124 * @throws IOException
125 * in case of I/O error
127 protected abstract List
<Entry
<String
, URL
>> getChapters(URL source
,
128 InputStream in
, Progress pg
) throws IOException
;
131 * Return the content of the chapter (possibly HTML encoded, if
132 * {@link BasicSupport_Deprecated#isHtml()} is TRUE).
135 * the source of the story
137 * the input (the main resource)
141 * the optional progress reporter
143 * @return the content
145 * @throws IOException
146 * in case of I/O error
148 protected abstract String
getChapterContent(URL source
, InputStream in
,
149 int number
, Progress pg
) throws IOException
;
152 * Process the given story resource into a partially filled {@link Story}
153 * object containing the name and metadata, except for the description.
158 * @return the {@link Story}
160 * @throws IOException
161 * in case of I/O error
163 public Story
processMeta(URL url
) throws IOException
{
164 return processMeta(url
, true, false, null);
168 * Process the given story resource into a partially filled {@link Story}
169 * object containing the name and metadata.
174 * close "this" and "in" when done
176 * retrieve the description of the story, or not
178 * the optional progress reporter
180 * @return the {@link Story}, never NULL
182 * @throws IOException
183 * in case of I/O error
185 protected Story
processMeta(URL url
, boolean close
, boolean getDesc
,
186 Progress pg
) throws IOException
{
190 pg
.setMinMax(0, 100);
196 url
= getCanonicalUrl(url
);
198 setCurrentReferer(url
);
200 in
= openInput(url
); // NULL allowed here
202 preprocess(url
, getInput());
205 Story story
= new Story();
206 MetaData meta
= getMeta(url
, getInput());
207 if (meta
.getCreationDate() == null
208 || meta
.getCreationDate().trim().isEmpty()) {
209 meta
.setCreationDate(bsHelper
.formatDate(
210 StringUtils
.fromTime(new Date().getTime())));
213 pg
.put("meta", meta
);
217 if (meta
.getCover() == null) {
218 meta
.setCover(getDefaultCover(meta
.getSubject()));
224 String descChapterName
= Instance
.getInstance().getTrans().getString(StringId
.DESCRIPTION
);
225 story
.getMeta().setResume(makeChapter(url
, 0, descChapterName
, getDesc(url
, getInput()), null));
242 * Process the given story resource into a fully filled {@link Story}
248 * the optional progress reporter
250 * @return the {@link Story}, never NULL
252 * @throws IOException
253 * in case of I/O error
255 protected Story
process(URL url
, Progress pg
) throws IOException
{
259 pg
.setMinMax(0, 100);
262 url
= getCanonicalUrl(url
);
265 Progress pgMeta
= new Progress();
266 pg
.addProgress(pgMeta
, 10);
267 Story story
= processMeta(url
, false, true, pgMeta
);
268 pg
.put("meta", story
.getMeta());
269 if (!pgMeta
.isDone()) {
270 pgMeta
.setProgress(pgMeta
.getMax()); // 10%
273 setCurrentReferer(url
);
275 Progress pgGetChapters
= new Progress();
276 pg
.addProgress(pgGetChapters
, 10);
277 story
.setChapters(new ArrayList
<Chapter
>());
278 List
<Entry
<String
, URL
>> chapters
= getChapters(url
, getInput(),
280 if (!pgGetChapters
.isDone()) {
281 pgGetChapters
.setProgress(pgGetChapters
.getMax()); // 20%
284 if (chapters
!= null) {
285 Progress pgChaps
= new Progress("Extracting chapters", 0,
286 chapters
.size() * 300);
287 pg
.addProgress(pgChaps
, 80);
291 for (Entry
<String
, URL
> chap
: chapters
) {
292 pgChaps
.setName("Extracting chapter " + i
);
293 InputStream chapIn
= null;
294 if (chap
.getValue() != null) {
295 setCurrentReferer(chap
.getValue());
296 chapIn
= Instance
.getInstance().getCache().open(chap
.getValue(), this, false);
298 pgChaps
.setProgress(i
* 100);
300 Progress pgGetChapterContent
= new Progress();
301 Progress pgMakeChapter
= new Progress();
302 pgChaps
.addProgress(pgGetChapterContent
, 100);
303 pgChaps
.addProgress(pgMakeChapter
, 100);
305 String content
= getChapterContent(url
, chapIn
, i
,
306 pgGetChapterContent
);
307 if (!pgGetChapterContent
.isDone()) {
308 pgGetChapterContent
.setProgress(pgGetChapterContent
312 Chapter cc
= makeChapter(url
, i
, chap
.getKey(),
313 content
, pgMakeChapter
);
314 if (!pgMakeChapter
.isDone()) {
315 pgMakeChapter
.setProgress(pgMakeChapter
.getMax());
318 words
+= cc
.getWords();
319 story
.getChapters().add(cc
);
320 story
.getMeta().setWords(words
);
322 if (chapIn
!= null) {
330 pgChaps
.setName("Extracting chapters");
347 * Prepare the support if needed before processing.
350 * the source of the story
352 * the input (the main resource)
354 * @throws IOException
357 @SuppressWarnings("unused")
358 protected void preprocess(URL source
, InputStream in
) throws IOException
{
362 * Create a {@link Chapter} object from the given information, formatting
363 * the content as it should be.
366 * the source of the story
372 * the chapter content
374 * the optional progress reporter
376 * @return the {@link Chapter}
378 * @throws IOException
379 * in case of I/O error
381 protected Chapter
makeChapter(URL source
, int number
, String name
,
382 String content
, Progress pg
) throws IOException
{
383 // Chapter name: process it correctly, then remove the possible
384 // redundant "Chapter x: " in front of it, or "-" (as in
385 // "Chapter 5: - Fun!" after the ": " was automatically added)
386 String chapterName
= processPara(name
).getContent().trim();
387 for (String lang
: Instance
.getInstance().getConfig().getList(Config
.CONF_CHAPTER
)) {
388 String chapterWord
= Instance
.getInstance().getConfig().getStringX(Config
.CONF_CHAPTER
, lang
);
389 if (chapterName
.startsWith(chapterWord
)) {
390 chapterName
= chapterName
.substring(chapterWord
.length())
396 if (chapterName
.startsWith(Integer
.toString(number
))) {
397 chapterName
= chapterName
.substring(
398 Integer
.toString(number
).length()).trim();
401 while (chapterName
.startsWith(":") || chapterName
.startsWith("-")) {
402 chapterName
= chapterName
.substring(1).trim();
406 Chapter chap
= new Chapter(number
, chapterName
);
408 if (content
!= null) {
409 List
<Paragraph
> paras
= makeParagraphs(source
, content
, pg
);
411 for (Paragraph para
: paras
) {
412 words
+= para
.getWords();
414 chap
.setParagraphs(paras
);
415 chap
.setWords(words
);
423 * Convert the given content into {@link Paragraph}s.
426 * the source URL of the story
428 * the textual content
430 * the optional progress reporter
432 * @return the {@link Paragraph}s
434 * @throws IOException
435 * in case of I/O error
437 protected List
<Paragraph
> makeParagraphs(URL source
, String content
,
438 Progress pg
) throws IOException
{
444 // Special <HR> processing:
445 content
= content
.replaceAll("(<hr [^>]*>)|(<hr/>)|(<hr>)",
449 List
<Paragraph
> paras
= new ArrayList
<Paragraph
>();
451 if (content
!= null && !content
.trim().isEmpty()) {
453 String
[] tab
= content
.split("(<p>|</p>|<br>|<br/>)");
454 pg
.setMinMax(0, tab
.length
);
456 for (String line
: tab
) {
457 if (line
.startsWith("[") && line
.endsWith("]")) {
458 pg
.setName("Extracting image " + i
);
460 paras
.add(makeParagraph(source
, line
.trim()));
465 List
<String
> lines
= new ArrayList
<String
>();
466 BufferedReader buff
= null;
468 buff
= new BufferedReader(
469 new InputStreamReader(new ByteArrayInputStream(
470 content
.getBytes("UTF-8")), "UTF-8"));
471 for (String line
= buff
.readLine(); line
!= null; line
= buff
473 lines
.add(line
.trim());
481 pg
.setMinMax(0, lines
.size());
483 for (String line
: lines
) {
484 if (line
.startsWith("[") && line
.endsWith("]")) {
485 pg
.setName("Extracting image " + i
);
487 paras
.add(makeParagraph(source
, line
));
493 // Check quotes for "bad" format
494 List
<Paragraph
> newParas
= new ArrayList
<Paragraph
>();
495 for (Paragraph para
: paras
) {
496 newParas
.addAll(requotify(para
));
500 // Remove double blanks/brks
501 fixBlanksBreaks(paras
);
508 * Convert the given line into a single {@link Paragraph}.
511 * the source URL of the story
513 * the textual content of the paragraph
515 * @return the {@link Paragraph}
517 private Paragraph
makeParagraph(URL source
, String line
) {
519 if (line
.startsWith("[") && line
.endsWith("]")) {
520 image
= getImage(this, source
, line
.substring(1, line
.length() - 1)
525 return new Paragraph(image
);
528 return processPara(line
);
532 * Fix the {@link ParagraphType#BLANK}s and {@link ParagraphType#BREAK}s of
533 * those {@link Paragraph}s.
535 * The resulting list will not contain a starting or trailing blank/break
536 * nor 2 blanks or breaks following each other.
539 * the list of {@link Paragraph}s to fix
541 protected void fixBlanksBreaks(List
<Paragraph
> paras
) {
542 boolean space
= false;
544 for (int i
= 0; i
< paras
.size(); i
++) {
545 Paragraph para
= paras
.get(i
);
546 boolean thisSpace
= para
.getType() == ParagraphType
.BLANK
;
547 boolean thisBrk
= para
.getType() == ParagraphType
.BREAK
;
549 if (i
> 0 && space
&& thisBrk
) {
552 } else if ((space
|| brk
) && (thisSpace
|| thisBrk
)) {
561 // Remove blank/brk at start
563 && (paras
.get(0).getType() == ParagraphType
.BLANK
|| paras
.get(
564 0).getType() == ParagraphType
.BREAK
)) {
568 // Remove blank/brk at end
569 int last
= paras
.size() - 1;
571 && (paras
.get(last
).getType() == ParagraphType
.BLANK
|| paras
572 .get(last
).getType() == ParagraphType
.BREAK
)) {
578 * Get the default cover related to this subject (see <tt>.info</tt> files).
583 * @return the cover if any, or NULL
585 static Image
getDefaultCover(String subject
) {
586 if (subject
!= null && !subject
.isEmpty() && Instance
.getInstance().getCoverDir() != null) {
588 File fileCover
= new File(Instance
.getInstance().getCoverDir(), subject
);
589 return getImage(null, fileCover
.toURI().toURL(), subject
);
590 } catch (MalformedURLException e
) {
598 * Return the list of supported image extensions.
600 * @param emptyAllowed
601 * TRUE to allow an empty extension on first place, which can be
602 * used when you may already have an extension in your input but
603 * are not sure about it
605 * @return the extensions
607 static String
[] getImageExt(boolean emptyAllowed
) {
609 return new String
[] { "", ".png", ".jpg", ".jpeg", ".gif", ".bmp" };
612 return new String
[] { ".png", ".jpg", ".jpeg", ".gif", ".bmp" };
616 * Check if the given resource can be a local image or a remote image, then
617 * refresh the cache with it if it is.
622 * the resource to check
624 * @return the image if found, or NULL
627 static Image
getImage(BasicSupport_Deprecated support
, URL source
,
629 URL url
= getImageUrl(support
, source
, line
);
631 if ("file".equals(url
.getProtocol())) {
632 if (new File(url
.getPath()).isDirectory()) {
636 InputStream in
= null;
638 in
= Instance
.getInstance().getCache().open(url
, getSupport(url
), true);
639 return new Image(in
);
640 } catch (IOException e
) {
645 } catch (IOException e
) {
655 * Check if the given resource can be a local image or a remote image, then
656 * refresh the cache with it if it is.
661 * the resource to check
663 * @return the image URL if found, or NULL
666 static URL
getImageUrl(BasicSupport_Deprecated support
, URL source
,
672 if (source
!= null) {
674 String relPath
= null;
675 String absPath
= null;
677 String path
= new File(source
.getFile()).getParent();
678 relPath
= new File(new File(path
), line
.trim())
680 } catch (Exception e
) {
681 // Cannot be converted to path (one possibility to take
682 // into account: absolute path on Windows)
685 absPath
= new File(line
.trim()).getAbsolutePath();
686 } catch (Exception e
) {
687 // Cannot be converted to path (at all)
690 for (String ext
: getImageExt(true)) {
691 File absFile
= new File(absPath
+ ext
);
692 File relFile
= new File(relPath
+ ext
);
693 if (absPath
!= null && absFile
.exists()
694 && absFile
.isFile()) {
695 url
= absFile
.toURI().toURL();
696 } else if (relPath
!= null && relFile
.exists()
697 && relFile
.isFile()) {
698 url
= relFile
.toURI().toURL();
701 } catch (Exception e
) {
702 // Should not happen since we control the correct arguments
709 for (String ext
: getImageExt(true)) {
710 if (Instance
.getInstance().getCache().check(new URL(line
+ ext
), true)) {
711 url
= new URL(line
+ ext
);
718 for (String ext
: getImageExt(true)) {
720 url
= new URL(line
+ ext
);
721 Instance
.getInstance().getCache().refresh(url
, support
, true);
723 } catch (IOException e
) {
724 // no image with this ext
729 } catch (MalformedURLException e
) {
734 // refresh the cached file
737 Instance
.getInstance().getCache().refresh(url
, support
, true);
738 } catch (IOException e
) {
739 // woops, broken image
749 * Open the input file that will be used through the support.
751 * Can return NULL, in which case you are supposed to work without an
752 * {@link InputStream}.
755 * the source {@link URL}
757 * @return the {@link InputStream}
759 * @throws IOException
760 * in case of I/O error
762 protected InputStream
openInput(URL source
) throws IOException
{
763 return Instance
.getInstance().getCache().open(source
, this, false);
767 * Reset then return {@link BasicSupport_Deprecated#in}.
769 * @return {@link BasicSupport_Deprecated#in}
771 protected InputStream
getInput() {
776 * Check quotes for bad format (i.e., quotes with normal paragraphs inside)
777 * and requotify them (i.e., separate them into QUOTE paragraphs and other
778 * paragraphs (quotes or not)).
781 * the paragraph to requotify (not necessarily a quote)
783 * @return the correctly (or so we hope) quotified paragraphs
785 protected List
<Paragraph
> requotify(Paragraph para
) {
786 List
<Paragraph
> newParas
= new ArrayList
<Paragraph
>();
788 if (para
.getType() == ParagraphType
.QUOTE
789 && para
.getContent().length() > 2) {
790 String line
= para
.getContent();
791 boolean singleQ
= line
.startsWith("" + openQuote
);
792 boolean doubleQ
= line
.startsWith("" + openDoubleQuote
);
794 // Do not try when more than one quote at a time
795 // (some stories are not easily readable if we do)
797 && line
.indexOf(closeQuote
, 1) < line
798 .lastIndexOf(closeQuote
)) {
803 && line
.indexOf(closeDoubleQuote
, 1) < line
804 .lastIndexOf(closeDoubleQuote
)) {
810 if (!singleQ
&& !doubleQ
) {
811 line
= openDoubleQuote
+ line
+ closeDoubleQuote
;
812 newParas
.add(new Paragraph(ParagraphType
.QUOTE
, line
, para
815 char open
= singleQ ? openQuote
: openDoubleQuote
;
816 char close
= singleQ ? closeQuote
: closeDoubleQuote
;
819 boolean inQuote
= false;
821 for (char car
: line
.toCharArray()) {
824 } else if (car
== close
) {
826 } else if (car
== '.' && !inQuote
) {
834 String rest
= line
.substring(posDot
+ 1).trim();
835 line
= line
.substring(0, posDot
+ 1).trim();
837 for (char car
: line
.toCharArray()) {
842 newParas
.add(new Paragraph(ParagraphType
.QUOTE
, line
, words
));
843 if (!rest
.isEmpty()) {
844 newParas
.addAll(requotify(processPara(rest
)));
858 * Process a {@link Paragraph} from a raw line of text.
860 * Will also fix quotes and HTML encoding if needed.
865 * @return the processed {@link Paragraph}
867 protected Paragraph
processPara(String line
) {
868 line
= ifUnhtml(line
).trim();
870 boolean space
= true;
872 boolean quote
= false;
873 boolean tentativeCloseQuote
= false;
878 StringBuilder builder
= new StringBuilder();
879 for (char car
: line
.toCharArray()) {
882 // dash, ndash and mdash: - – —
883 // currently: always use mdash
884 builder
.append(dashCount
== 1 ?
'-' : '—');
889 if (tentativeCloseQuote
) {
890 tentativeCloseQuote
= false;
891 if (Character
.isLetterOrDigit(car
)) {
894 // handle double-single quotes as double quotes
896 builder
.append(closeDoubleQuote
);
900 builder
.append(closeQuote
);
905 case ' ': // note: unbreakable space
908 case '\n': // just in case
909 case '\r': // just in case
910 if (builder
.length() > 0
911 && builder
.charAt(builder
.length() - 1) != ' ') {
918 if (space
|| (brk
&& quote
)) {
920 // handle double-single quotes as double quotes
922 builder
.deleteCharAt(builder
.length() - 1);
923 builder
.append(openDoubleQuote
);
925 builder
.append(openQuote
);
927 } else if (prev
== ' ' || prev
== car
) {
928 // handle double-single quotes as double quotes
930 builder
.deleteCharAt(builder
.length() - 1);
931 builder
.append(openDoubleQuote
);
933 builder
.append(openQuote
);
936 // it is a quote ("I'm off") or a 'quote' ("This
937 // 'good' restaurant"...)
938 tentativeCloseQuote
= true;
943 if (space
|| (brk
&& quote
)) {
945 builder
.append(openDoubleQuote
);
946 } else if (prev
== ' ') {
947 builder
.append(openDoubleQuote
);
949 builder
.append(closeDoubleQuote
);
983 if (space
|| (brk
&& quote
)) {
985 builder
.append(openQuote
);
987 // handle double-single quotes as double quotes
989 builder
.deleteCharAt(builder
.length() - 1);
990 builder
.append(openDoubleQuote
);
992 builder
.append(openQuote
);
1006 // handle double-single quotes as double quotes
1008 builder
.deleteCharAt(builder
.length() - 1);
1009 builder
.append(closeDoubleQuote
);
1011 builder
.append(closeQuote
);
1020 if (space
|| (brk
&& quote
)) {
1022 builder
.append(openDoubleQuote
);
1024 builder
.append(openDoubleQuote
);
1037 builder
.append(closeDoubleQuote
);
1043 builder
.append(car
);
1050 if (tentativeCloseQuote
) {
1051 tentativeCloseQuote
= false;
1052 builder
.append(closeQuote
);
1055 line
= builder
.toString().trim();
1057 ParagraphType type
= ParagraphType
.NORMAL
;
1059 type
= ParagraphType
.BLANK
;
1061 type
= ParagraphType
.BREAK
;
1063 type
= ParagraphType
.QUOTE
;
1066 return new Paragraph(type
, line
, words
);
1070 * Remove the HTML from the input <b>if</b>
1071 * {@link BasicSupport_Deprecated#isHtml()} is true.
1076 * @return the no html version if needed
1078 private String
ifUnhtml(String input
) {
1079 if (isHtml() && input
!= null) {
1080 return StringUtils
.unhtml(input
);
1087 * Reset the given {@link InputStream} and return it.
1090 * the {@link InputStream} to reset
1092 * @return the same {@link InputStream} after reset
1094 static protected InputStream
reset(InputStream in
) {
1099 } catch (IOException e
) {
1106 * Return the first line from the given input which correspond to the given
1112 * a string that must be found inside the target line (also
1113 * supports "^" at start to say "only if it starts with" the
1115 * @param relativeLine
1116 * the line to return based upon the target line position (-1 =
1117 * the line before, 0 = the target line...)
1119 * @return the line, or NULL if not found
1121 static protected String
getLine(InputStream in
, String needle
,
1123 return getLine(in
, needle
, relativeLine
, true);
1127 * Return a line from the given input which correspond to the given
1133 * a string that must be found inside the target line (also
1134 * supports "^" at start to say "only if it starts with" the
1136 * @param relativeLine
1137 * the line to return based upon the target line position (-1 =
1138 * the line before, 0 = the target line...)
1140 * takes the first result (as opposed to the last one, which will
1141 * also always spend the input)
1143 * @return the line, or NULL if not found
1145 static protected String
getLine(InputStream in
, String needle
,
1146 int relativeLine
, boolean first
) {
1151 List
<String
> lines
= new ArrayList
<String
>();
1152 @SuppressWarnings("resource")
1153 Scanner scan
= new Scanner(in
, "UTF-8");
1155 scan
.useDelimiter("\\n");
1156 while (scan
.hasNext()) {
1157 lines
.add(scan
.next());
1160 if (needle
.startsWith("^")) {
1161 if (lines
.get(lines
.size() - 1).startsWith(
1162 needle
.substring(1))) {
1163 index
= lines
.size() - 1;
1167 if (lines
.get(lines
.size() - 1).contains(needle
)) {
1168 index
= lines
.size() - 1;
1173 if (index
>= 0 && index
+ relativeLine
< lines
.size()) {
1174 rep
= lines
.get(index
+ relativeLine
);
1185 * Return the text between the key and the endKey (and optional subKey can
1186 * be passed, in this case we will look for the key first, then take the
1187 * text between the subKey and the endKey).
1189 * Will only match the first line with the given key if more than one are
1190 * possible. Which also means that if the subKey or endKey is not found on
1191 * that line, NULL will be returned.
1196 * the key to match (also supports "^" at start to say
1197 * "only if it starts with" the key)
1199 * the sub key or NULL if none
1201 * the end key or NULL for "up to the end"
1202 * @return the text or NULL if not found
1204 static protected String
getKeyLine(InputStream in
, String key
,
1205 String subKey
, String endKey
) {
1206 return getKeyText(getLine(in
, key
, 0), key
, subKey
, endKey
);
1210 * Return the text between the key and the endKey (and optional subKey can
1211 * be passed, in this case we will look for the key first, then take the
1212 * text between the subKey and the endKey).
1217 * the key to match (also supports "^" at start to say
1218 * "only if it starts with" the key)
1220 * the sub key or NULL if none
1222 * the end key or NULL for "up to the end"
1223 * @return the text or NULL if not found
1225 static protected String
getKeyText(String in
, String key
, String subKey
,
1227 String result
= null;
1230 if (line
!= null && line
.contains(key
)) {
1231 line
= line
.substring(line
.indexOf(key
) + key
.length());
1232 if (subKey
== null || subKey
.isEmpty() || line
.contains(subKey
)) {
1233 if (subKey
!= null) {
1234 line
= line
.substring(line
.indexOf(subKey
)
1237 if (endKey
== null || line
.contains(endKey
)) {
1238 if (endKey
!= null) {
1239 line
= line
.substring(0, line
.indexOf(endKey
));
1250 * Return the text between the key and the endKey (optional subKeys can be
1251 * passed, in this case we will look for the subKeys first, then take the
1252 * text between the key and the endKey).
1259 * the end key or NULL for "up to the end"
1261 * the sub-keys to find before checking for key/endKey
1263 * @return the text or NULL if not found
1265 static protected String
getKeyTextAfter(String in
, String key
,
1266 String endKey
, String
... afters
) {
1268 if (in
!= null && !in
.isEmpty()) {
1269 int pos
= indexOfAfter(in
, 0, afters
);
1274 in
= in
.substring(pos
);
1277 return getKeyText(in
, key
, null, endKey
);
1281 * Return the first index after all the given "afters" have been found in
1282 * the {@link String}, or -1 if it was not possible.
1287 * start at this position in the string
1289 * the sub-keys to find before checking for key/endKey
1291 * @return the text or NULL if not found
1293 static protected int indexOfAfter(String in
, int startAt
, String
... afters
) {
1295 if (in
!= null && !in
.isEmpty()) {
1297 if (afters
!= null) {
1298 for (int i
= 0; pos
>= 0 && i
< afters
.length
; i
++) {
1299 String subKey
= afters
[i
];
1300 if (!subKey
.isEmpty()) {
1301 pos
= in
.indexOf(subKey
, pos
);
1303 pos
+= subKey
.length();