1 package be
.nikiroo
.fanfix
.supported
;
3 import java
.io
.IOException
;
4 import java
.io
.InputStream
;
5 import java
.net
.MalformedURLException
;
7 import java
.util
.ArrayList
;
9 import java
.util
.HashMap
;
10 import java
.util
.List
;
12 import java
.util
.Scanner
;
13 import java
.util
.Map
.Entry
;
15 import org
.json
.JSONObject
;
16 import org
.jsoup
.helper
.DataUtil
;
17 import org
.jsoup
.nodes
.Document
;
18 import org
.jsoup
.nodes
.Element
;
19 import org
.jsoup
.nodes
.Node
;
21 import be
.nikiroo
.fanfix
.Instance
;
22 import be
.nikiroo
.fanfix
.bundles
.StringId
;
23 import be
.nikiroo
.fanfix
.data
.Chapter
;
24 import be
.nikiroo
.fanfix
.data
.MetaData
;
25 import be
.nikiroo
.fanfix
.data
.Story
;
26 import be
.nikiroo
.utils
.Progress
;
27 import be
.nikiroo
.utils
.StringUtils
;
30 * This class is the base class used by the other support classes. It can be
31 * used outside of this package, and have static method that you can use to get
32 * access to the correct support class.
34 * It will be used with 'resources' (usually web pages or files).
38 public abstract class BasicSupport
{
39 private Document sourceNode
;
41 private SupportType type
;
42 private URL currentReferer
; // with only one 'r', as in 'HTTP'...
44 static protected BasicSupportHelper bsHelper
= new BasicSupportHelper();
45 static protected BasicSupportImages bsImages
= new BasicSupportImages();
46 static protected BasicSupportPara bsPara
= new BasicSupportPara(new BasicSupportHelper(), new BasicSupportImages());
49 * Check if the given resource is supported by this {@link BasicSupport}.
52 * the resource to check for
54 * @return TRUE if it is
56 protected abstract boolean supports(URL url
);
59 * Return TRUE if the support will return HTML encoded content values for
60 * the chapters content.
62 * @return TRUE for HTML
64 protected abstract boolean isHtml();
67 * Return the {@link MetaData} of this story.
69 * @return the associated {@link MetaData}, never NULL
72 * in case of I/O error
74 protected abstract MetaData
getMeta() throws IOException
;
77 * Return the story description.
79 * @return the description
82 * in case of I/O error
84 protected abstract String
getDesc() throws IOException
;
87 * Return the list of chapters (name and resource).
89 * Can be NULL if this {@link BasicSupport} do no use chapters.
92 * the optional progress reporter
94 * @return the chapters or NULL
97 * in case of I/O error
99 protected abstract List
<Entry
<String
, URL
>> getChapters(Progress pg
)
103 * Return the content of the chapter (possibly HTML encoded, if
104 * {@link BasicSupport#isHtml()} is TRUE).
107 * the chapter {@link URL}
111 * the optional progress reporter
113 * @return the content
115 * @throws IOException
116 * in case of I/O error
118 protected abstract String
getChapterContent(URL chapUrl
, int number
,
119 Progress pg
) throws IOException
;
122 * Return the list of cookies (values included) that must be used to
123 * correctly fetch the resources.
125 * You are expected to call the super method implementation if you override
128 * @return the cookies
130 public Map
<String
, String
> getCookies() {
131 return new HashMap
<String
, String
>();
135 * OAuth authorisation (aka, "bearer XXXXXXX").
137 * @return the OAuth string
139 public String
getOAuth() {
144 * Return the canonical form of the main {@link URL}.
147 * the source {@link URL}, which can be NULL
149 * @return the canonical form of this {@link URL} or NULL if the source was
152 protected URL
getCanonicalUrl(URL source
) {
157 * The main {@link Node} for this {@link Story}.
161 protected Element
getSourceNode() {
166 * The main {@link URL} for this {@link Story}.
170 protected URL
getSource() {
175 * The current referer {@link URL} (only one 'r', as in 'HTML'...), i.e.,
176 * the current {@link URL} we work on.
178 * @return the referer
180 public URL
getCurrentReferer() {
181 return currentReferer
;
185 * The current referer {@link URL} (only one 'r', as in 'HTML'...), i.e.,
186 * the current {@link URL} we work on.
188 * @param currentReferer
191 protected void setCurrentReferer(URL currentReferer
) {
192 this.currentReferer
= currentReferer
;
200 public SupportType
getType() {
210 protected void setType(SupportType type
) {
215 * Open an input link that will be used for the support.
217 * Can return NULL, in which case you are supposed to work without a source
221 * the source {@link URL}
223 * @return the {@link InputStream}
225 * @throws IOException
226 * in case of I/O error
228 protected Document
loadDocument(URL source
) throws IOException
{
229 String url
= getCanonicalUrl(source
).toString();
230 return DataUtil
.load(Instance
.getInstance().getCache().open(source
, this, false), "UTF-8", url
.toString());
234 * Log into the support (can be a no-op depending upon the support).
236 * @throws IOException
237 * in case of I/O error
239 protected void login() throws IOException
{
243 * Now that we have processed the {@link Story}, close the resources if any.
245 protected void close() {
246 setCurrentReferer(null);
250 * Process the given story resource into a partially filled {@link Story}
251 * object containing the name and metadata.
254 * retrieve the description of the story, or not
256 * the optional progress reporter
258 * @return the {@link Story}, never NULL
260 * @throws IOException
261 * in case of I/O error
263 protected Story
processMeta(boolean getDesc
, Progress pg
)
268 pg
.setMinMax(0, 100);
273 Story story
= new Story();
274 MetaData meta
= getMeta();
275 if (meta
.getCreationDate() == null
276 || meta
.getCreationDate().trim().isEmpty()) {
277 meta
.setCreationDate(bsHelper
278 .formatDate(StringUtils
.fromTime(new Date().getTime())));
281 pg
.put("meta", meta
);
285 if (meta
.getCover() == null) {
286 meta
.setCover(bsHelper
.getDefaultCover(meta
.getSubject()));
292 String descChapterName
= Instance
.getInstance().getTrans().getString(StringId
.DESCRIPTION
);
293 story
.getMeta().setResume(bsPara
.makeChapter(this, source
, 0, descChapterName
, //
294 getDesc(), isHtml(), null));
302 * Utility method to convert the given URL into a JSON object.
304 * Note that this method expects small JSON files (everything is copied into
305 * memory at least twice).
310 * TRUE for more stable resources, FALSE when they often change
312 * @return the JSON object
314 * @throws IOException
315 * in case of I/O error
317 protected JSONObject
getJson(String url
, boolean stable
)
320 return getJson(new URL(url
), stable
);
321 } catch (MalformedURLException e
) {
322 throw new IOException("Malformed URL: " + url
, e
);
327 * Utility method to convert the given URL into a JSON object.
329 * Note that this method expects small JSON files (everything is copied into
330 * memory at least twice).
335 * TRUE for more stable resources, FALSE when they often change
337 * @return the JSON object
339 * @throws IOException
340 * in case of I/O error
342 protected JSONObject
getJson(URL url
, boolean stable
) throws IOException
{
343 InputStream in
= Instance
.getInstance().getCache().open(url
, null,
346 Scanner scan
= new Scanner(in
);
347 scan
.useDelimiter("\0");
349 return new JSONObject(scan
.next());
359 * Process the given story resource into a fully filled {@link Story}
363 * the optional progress reporter
365 * @return the {@link Story}, never NULL
367 * @throws IOException
368 * in case of I/O error
370 // TODO: ADD final when BasicSupport_Deprecated is gone
371 public Story
process(Progress pg
) throws IOException
{
372 setCurrentReferer(source
);
374 sourceNode
= loadDocument(source
);
377 Story story
= doProcess(pg
);
379 // Check for "no chapters" stories
380 if (story
.getChapters().isEmpty()
381 && story
.getMeta().getResume() != null
382 && !story
.getMeta().getResume().getParagraphs().isEmpty()) {
383 Chapter resume
= story
.getMeta().getResume();
386 story
.getChapters().add(resume
);
387 story
.getMeta().setWords(resume
.getWords());
389 String descChapterName
= Instance
.getInstance().getTrans()
390 .getString(StringId
.DESCRIPTION
);
391 resume
= new Chapter(0, descChapterName
);
392 story
.getMeta().setResume(resume
);
402 * Actual processing step, without the calls to other methods.
404 * Will convert the story resource into a fully filled {@link Story} object.
407 * the optional progress reporter
409 * @return the {@link Story}, never NULL
411 * @throws IOException
412 * in case of I/O error
414 protected Story
doProcess(Progress pg
) throws IOException
{
418 pg
.setMinMax(0, 100);
421 pg
.setName("Initialising");
424 Progress pgMeta
= new Progress();
425 pg
.addProgress(pgMeta
, 10);
426 Story story
= processMeta(true, pgMeta
);
427 pgMeta
.done(); // 10%
428 pg
.put("meta", story
.getMeta());
430 Progress pgGetChapters
= new Progress();
431 pg
.addProgress(pgGetChapters
, 10);
432 story
.setChapters(new ArrayList
<Chapter
>());
433 List
<Entry
<String
, URL
>> chapters
= getChapters(pgGetChapters
);
434 pgGetChapters
.done(); // 20%
436 if (chapters
!= null) {
437 Progress pgChaps
= new Progress("Extracting chapters", 0,
438 chapters
.size() * 300);
439 pg
.addProgress(pgChaps
, 80);
443 for (Entry
<String
, URL
> chap
: chapters
) {
444 pgChaps
.setName("Extracting chapter " + i
);
445 URL chapUrl
= chap
.getValue();
446 String chapName
= chap
.getKey();
447 if (chapUrl
!= null) {
448 setCurrentReferer(chapUrl
);
451 pgChaps
.setProgress(i
* 100);
452 Progress pgGetChapterContent
= new Progress();
453 Progress pgMakeChapter
= new Progress();
454 pgChaps
.addProgress(pgGetChapterContent
, 100);
455 pgChaps
.addProgress(pgMakeChapter
, 100);
457 String content
= getChapterContent(chapUrl
, i
,
458 pgGetChapterContent
);
459 pgGetChapterContent
.done();
460 Chapter cc
= bsPara
.makeChapter(this, chapUrl
, i
,
461 chapName
, content
, isHtml(), pgMakeChapter
);
462 pgMakeChapter
.done();
464 words
+= cc
.getWords();
465 story
.getChapters().add(cc
);
470 story
.getMeta().setWords(words
);
472 pgChaps
.setName("Extracting chapters");
482 * Create a chapter from the given data.
485 * the source URL for this content, which can be used to try and
486 * find images if images are present in the format [image-url]
488 * the chapter number (0 = description)
492 * the content of the chapter
494 * @return the {@link Chapter}, never NULL
496 * @throws IOException
497 * in case of I/O error
499 public Chapter
makeChapter(URL source
, int number
, String name
,
500 String content
) throws IOException
{
501 return bsPara
.makeChapter(this, source
, number
, name
,
502 content
, isHtml(), null);
506 * Return a {@link BasicSupport} implementation supporting the given
507 * resource if possible.
512 * @return an implementation that supports it, or NULL
514 public static BasicSupport
getSupport(URL url
) {
519 // TEXT and INFO_TEXT always support files (not URLs though)
520 for (SupportType type
: SupportType
.values()) {
521 if (type
!= SupportType
.TEXT
&& type
!= SupportType
.INFO_TEXT
) {
522 BasicSupport support
= getSupport(type
, url
);
523 if (support
!= null && support
.supports(url
)) {
529 for (SupportType type
: new SupportType
[] { SupportType
.INFO_TEXT
,
530 SupportType
.TEXT
}) {
531 BasicSupport support
= getSupport(type
, url
);
532 if (support
!= null && support
.supports(url
)) {
541 * Return a {@link BasicSupport} implementation supporting the given type.
544 * the type, must not be NULL
546 * the {@link URL} to support (can be NULL to get an
547 * "abstract support"; if not NULL, will be used as the source
550 * @return an implementation that supports it, or NULL
552 public static BasicSupport
getSupport(SupportType type
, URL url
) {
553 BasicSupport support
= null;
557 support
= new Epub();
560 support
= new InfoText();
564 // Can fail if no client key or NO in options
565 support
= new FimfictionApi();
566 } catch (IOException e
) {
567 support
= new Fimfiction();
571 support
= new Fanfiction();
574 support
= new Text();
577 support
= new MangaHub();
580 support
= new E621();
583 support
= new YiffStar();
586 support
= new EHentai();
589 support
= new MangaLel();
595 support
= new Html();
599 if (support
!= null) {
600 support
.setType(type
);
601 support
.source
= support
.getCanonicalUrl(url
);