GUI: add search menu
[nikiroo-utils.git] / src / be / nikiroo / fanfix / supported / BasicSupport.java
CommitLineData
08fe2e33
NR
1package be.nikiroo.fanfix.supported;
2
08fe2e33
NR
3import java.io.IOException;
4import java.io.InputStream;
08fe2e33 5import java.net.URL;
08fe2e33 6import java.util.ArrayList;
793f1071 7import java.util.Date;
08fe2e33
NR
8import java.util.HashMap;
9import java.util.List;
10import java.util.Map;
11import java.util.Map.Entry;
0ffa4754
NR
12
13import org.jsoup.helper.DataUtil;
14import org.jsoup.nodes.Document;
15import org.jsoup.nodes.Element;
16import org.jsoup.nodes.Node;
08fe2e33
NR
17
18import be.nikiroo.fanfix.Instance;
08fe2e33
NR
19import be.nikiroo.fanfix.bundles.StringId;
20import be.nikiroo.fanfix.data.Chapter;
21import be.nikiroo.fanfix.data.MetaData;
9252c65e 22import be.nikiroo.fanfix.data.Story;
3b2b638f 23import be.nikiroo.utils.Progress;
08fe2e33
NR
24import be.nikiroo.utils.StringUtils;
25
26/**
27 * This class is the base class used by the other support classes. It can be
28 * used outside of this package, and have static method that you can use to get
29 * access to the correct support class.
30 * <p>
31 * It will be used with 'resources' (usually web pages or files).
32 *
33 * @author niki
34 */
35public abstract class BasicSupport {
0ffa4754
NR
36 private Document sourceNode;
37 private URL source;
08fe2e33 38 private SupportType type;
22848428 39 private URL currentReferer; // with only one 'r', as in 'HTTP'...
08fe2e33 40
08fe2e33
NR
41 /**
42 * Check if the given resource is supported by this {@link BasicSupport}.
43 *
44 * @param url
45 * the resource to check for
46 *
47 * @return TRUE if it is
48 */
49 protected abstract boolean supports(URL url);
50
51 /**
52 * Return TRUE if the support will return HTML encoded content values for
53 * the chapters content.
54 *
55 * @return TRUE for HTML
56 */
57 protected abstract boolean isHtml();
58
0efd25e3
NR
59 /**
60 * Return the {@link MetaData} of this story.
61 *
776ad3c6 62 * @return the associated {@link MetaData}, never NULL
0efd25e3
NR
63 *
64 * @throws IOException
65 * in case of I/O error
66 */
0ffa4754 67 protected abstract MetaData getMeta() throws IOException;
08fe2e33
NR
68
69 /**
70 * Return the story description.
71 *
08fe2e33
NR
72 * @return the description
73 *
74 * @throws IOException
75 * in case of I/O error
76 */
0ffa4754 77 protected abstract String getDesc() throws IOException;
08fe2e33 78
08fe2e33 79 /**
826e4569 80 * Return the list of chapters (name and resource).
0ffa4754
NR
81 * <p>
82 * Can be NULL if this {@link BasicSupport} do no use chapters.
08fe2e33 83 *
ed08c171
NR
84 * @param pg
85 * the optional progress reporter
08fe2e33 86 *
0ffa4754 87 * @return the chapters or NULL
08fe2e33
NR
88 *
89 * @throws IOException
90 * in case of I/O error
91 */
0ffa4754
NR
92 protected abstract List<Entry<String, URL>> getChapters(Progress pg)
93 throws IOException;
08fe2e33
NR
94
95 /**
96 * Return the content of the chapter (possibly HTML encoded, if
97 * {@link BasicSupport#isHtml()} is TRUE).
98 *
0ffa4754
NR
99 * @param chapUrl
100 * the chapter {@link URL}
08fe2e33
NR
101 * @param number
102 * the chapter number
ed08c171
NR
103 * @param pg
104 * the optional progress reporter
08fe2e33
NR
105 *
106 * @return the content
107 *
108 * @throws IOException
109 * in case of I/O error
110 */
0ffa4754
NR
111 protected abstract String getChapterContent(URL chapUrl, int number,
112 Progress pg) throws IOException;
6e06d2cc 113
08fe2e33
NR
114 /**
115 * Return the list of cookies (values included) that must be used to
116 * correctly fetch the resources.
117 * <p>
118 * You are expected to call the super method implementation if you override
119 * it.
120 *
121 * @return the cookies
122 */
315f14ae 123 public Map<String, String> getCookies() {
08fe2e33
NR
124 return new HashMap<String, String>();
125 }
126
315f14ae
NR
127 /**
128 * OAuth authorisation (aka, "bearer XXXXXXX").
129 *
130 * @return the OAuth string
131 */
132 public String getOAuth() {
133 return null;
134 }
135
a4143cd7
NR
136 /**
137 * Return the canonical form of the main {@link URL}.
138 *
139 * @param source
0ffa4754
NR
140 * the source {@link URL}, which can be NULL
141 *
142 * @return the canonical form of this {@link URL} or NULL if the source was
143 * NULL
144 */
145 protected URL getCanonicalUrl(URL source) {
146 return source;
147 }
148
149 /**
150 * The main {@link Node} for this {@link Story}.
151 *
152 * @return the node
153 */
154 protected Element getSourceNode() {
155 return sourceNode;
156 }
157
158 /**
159 * The main {@link URL} for this {@link Story}.
160 *
161 * @return the URL
162 */
163 protected URL getSource() {
164 return source;
165 }
166
167 /**
168 * The current referer {@link URL} (only one 'r', as in 'HTML'...), i.e.,
169 * the current {@link URL} we work on.
170 *
171 * @return the referer
172 */
173 public URL getCurrentReferer() {
174 return currentReferer;
175 }
176
177 /**
178 * The current referer {@link URL} (only one 'r', as in 'HTML'...), i.e.,
179 * the current {@link URL} we work on.
180 *
181 * @param currentReferer
182 * the new referer
183 */
184 protected void setCurrentReferer(URL currentReferer) {
185 this.currentReferer = currentReferer;
186 }
187
188 /**
189 * The support type.
190 *
191 * @return the type
192 */
193 public SupportType getType() {
194 return type;
195 }
196
197 /**
198 * The support type.
199 *
200 * @param type
201 * the new type
202 */
203 protected void setType(SupportType type) {
204 this.type = type;
205 }
206
207 /**
208 * Open an input link that will be used for the support.
209 * <p>
7445f856
NR
210 * Can return NULL, in which case you are supposed to work without a source
211 * node.
0ffa4754
NR
212 *
213 * @param source
a4143cd7
NR
214 * the source {@link URL}
215 *
0ffa4754
NR
216 * @return the {@link InputStream}
217 *
218 * @throws IOException
219 * in case of I/O error
220 */
221 protected Document loadDocument(URL source) throws IOException {
222 String url = getCanonicalUrl(source).toString();
223 return DataUtil.load(Instance.getCache().open(source, this, false),
224 "UTF-8", url.toString());
225 }
226
227 /**
228 * Log into the support (can be a no-op depending upon the support).
a4143cd7
NR
229 *
230 * @throws IOException
231 * in case of I/O error
232 */
0ffa4754
NR
233 protected void login() throws IOException {
234 }
235
0ffa4754
NR
236 /**
237 * Now that we have processed the {@link Story}, close the resources if any.
238 */
239 protected void close() {
240 setCurrentReferer(null);
a4143cd7
NR
241 }
242
08fe2e33
NR
243 /**
244 * Process the given story resource into a partially filled {@link Story}
245 * object containing the name and metadata.
246 *
0efd25e3
NR
247 * @param getDesc
248 * retrieve the description of the story, or not
ed08c171
NR
249 * @param pg
250 * the optional progress reporter
08fe2e33 251 *
776ad3c6 252 * @return the {@link Story}, never NULL
08fe2e33
NR
253 *
254 * @throws IOException
255 * in case of I/O error
256 */
0ffa4754
NR
257 protected Story processMeta(boolean getDesc, Progress pg)
258 throws IOException {
ed08c171
NR
259 if (pg == null) {
260 pg = new Progress();
261 } else {
262 pg.setMinMax(0, 100);
263 }
264
0ffa4754 265 pg.setProgress(30);
ed08c171 266
0ffa4754
NR
267 Story story = new Story();
268 MetaData meta = getMeta();
269 if (meta.getCreationDate() == null || meta.getCreationDate().isEmpty()) {
270 meta.setCreationDate(StringUtils.fromTime(new Date().getTime()));
271 }
272 story.setMeta(meta);
ed08c171 273
0ffa4754 274 pg.setProgress(50);
08fe2e33 275
0ffa4754
NR
276 if (meta.getCover() == null) {
277 meta.setCover(BasicSupportHelper.getDefaultCover(meta.getSubject()));
278 }
08fe2e33 279
0ffa4754 280 pg.setProgress(60);
a4143cd7 281
0ffa4754
NR
282 if (getDesc) {
283 String descChapterName = Instance.getTrans().getString(
284 StringId.DESCRIPTION);
285 story.getMeta().setResume(
286 BasicSupportPara.makeChapter(this, source, 0,
287 descChapterName, //
288 getDesc(), isHtml(), null));
08fe2e33 289 }
0ffa4754 290
fdc55375 291 pg.done();
0ffa4754 292 return story;
08fe2e33
NR
293 }
294
9005532f 295 /**
826e4569
NR
296 * Process the given story resource into a fully filled {@link Story}
297 * object.
9005532f
NR
298 *
299 * @param pg
300 * the optional progress reporter
301 *
302 * @return the {@link Story}, never NULL
303 *
304 * @throws IOException
305 * in case of I/O error
306 */
826e4569 307 // ADD final when BasicSupport_Deprecated is gone
9005532f
NR
308 public Story process(Progress pg) throws IOException {
309 setCurrentReferer(source);
310 login();
311 sourceNode = loadDocument(source);
312
313 try {
314 return doProcess(pg);
315 } finally {
316 close();
317 }
318 }
319
08fe2e33 320 /**
826e4569
NR
321 * Actual processing step, without the calls to other methods.
322 * <p>
323 * Will convert the story resource into a fully filled {@link Story} object.
08fe2e33 324 *
92fb0719
NR
325 * @param pg
326 * the optional progress reporter
08fe2e33 327 *
776ad3c6 328 * @return the {@link Story}, never NULL
08fe2e33
NR
329 *
330 * @throws IOException
331 * in case of I/O error
332 */
826e4569 333 protected Story doProcess(Progress pg) throws IOException {
92fb0719
NR
334 if (pg == null) {
335 pg = new Progress();
336 } else {
337 pg.setMinMax(0, 100);
338 }
339
92fb0719 340 pg.setProgress(1);
9005532f
NR
341 Progress pgMeta = new Progress();
342 pg.addProgress(pgMeta, 10);
343 Story story = processMeta(true, pgMeta);
68328e17 344 pgMeta.done(); // 10%
ed08c171 345
9005532f 346 pg.setName("Retrieving " + story.getMeta().getTitle());
754a5bc2 347
9005532f
NR
348 Progress pgGetChapters = new Progress();
349 pg.addProgress(pgGetChapters, 10);
350 story.setChapters(new ArrayList<Chapter>());
351 List<Entry<String, URL>> chapters = getChapters(pgGetChapters);
68328e17 352 pgGetChapters.done(); // 20%
9005532f
NR
353
354 if (chapters != null) {
355 Progress pgChaps = new Progress("Extracting chapters", 0,
356 chapters.size() * 300);
357 pg.addProgress(pgChaps, 80);
358
359 long words = 0;
360 int i = 1;
361 for (Entry<String, URL> chap : chapters) {
362 pgChaps.setName("Extracting chapter " + i);
363 URL chapUrl = chap.getValue();
364 String chapName = chap.getKey();
365 if (chapUrl != null) {
366 setCurrentReferer(chapUrl);
367 }
368
369 pgChaps.setProgress(i * 100);
370 Progress pgGetChapterContent = new Progress();
371 Progress pgMakeChapter = new Progress();
372 pgChaps.addProgress(pgGetChapterContent, 100);
373 pgChaps.addProgress(pgMakeChapter, 100);
374
375 String content = getChapterContent(chapUrl, i,
376 pgGetChapterContent);
68328e17 377 pgGetChapterContent.done();
9005532f
NR
378 Chapter cc = BasicSupportPara.makeChapter(this, chapUrl, i,
379 chapName, content, isHtml(), pgMakeChapter);
68328e17 380 pgMakeChapter.done();
ed08c171 381
9005532f
NR
382 words += cc.getWords();
383 story.getChapters().add(cc);
384 story.getMeta().setWords(words);
385
386 i++;
08fe2e33
NR
387 }
388
9005532f 389 pgChaps.setName("Extracting chapters");
fdc55375 390 pgChaps.done();
08fe2e33 391 }
9005532f 392
68328e17
NR
393 pg.done();
394
9005532f 395 return story;
08fe2e33
NR
396 }
397
99d71bd7
NR
398 /**
399 * Create a chapter from the given data.
400 *
401 * @param source
402 * the source URL for this content, which can be used to try and
403 * find images if images are present in the format [image-url]
404 * @param number
405 * the chapter number (0 = description)
406 * @param name
407 * the chapter name
408 * @param content
409 * the content of the chapter
410 * @return the {@link Chapter}
411 *
412 * @throws IOException
413 * in case of I/O error
414 */
415 public Chapter makeChapter(URL source, int number, String name,
416 String content) throws IOException {
417 return BasicSupportPara.makeChapter(this, source, number, name,
418 content, isHtml(), null);
419 }
420
08fe2e33 421 /**
0ffa4754
NR
422 * Return a {@link BasicSupport} implementation supporting the given
423 * resource if possible.
08fe2e33 424 *
0ffa4754
NR
425 * @param url
426 * the story resource
08fe2e33 427 *
0ffa4754 428 * @return an implementation that supports it, or NULL
08fe2e33 429 */
0ffa4754
NR
430 public static BasicSupport getSupport(URL url) {
431 if (url == null) {
432 return null;
433 }
08fe2e33 434
0ffa4754
NR
435 // TEXT and INFO_TEXT always support files (not URLs though)
436 for (SupportType type : SupportType.values()) {
437 if (type != SupportType.TEXT && type != SupportType.INFO_TEXT) {
438 BasicSupport support = getSupport(type, url);
439 if (support != null && support.supports(url)) {
440 return support;
441 }
442 }
443 }
08fe2e33 444
0ffa4754
NR
445 for (SupportType type : new SupportType[] { SupportType.INFO_TEXT,
446 SupportType.TEXT }) {
447 BasicSupport support = getSupport(type, url);
448 if (support != null && support.supports(url)) {
449 return support;
450 }
451 }
452
453 return null;
08fe2e33
NR
454 }
455
456 /**
0ffa4754 457 * Return a {@link BasicSupport} implementation supporting the given type.
08fe2e33 458 *
0ffa4754 459 * @param type
99d71bd7 460 * the type, must not be NULL
0ffa4754
NR
461 * @param url
462 * the {@link URL} to support (can be NULL to get an
727108fe
NR
463 * "abstract support"; if not NULL, will be used as the source
464 * URL)
08fe2e33 465 *
0ffa4754 466 * @return an implementation that supports it, or NULL
08fe2e33 467 */
0ffa4754
NR
468 public static BasicSupport getSupport(SupportType type, URL url) {
469 BasicSupport support = null;
08fe2e33 470
08fe2e33
NR
471 switch (type) {
472 case EPUB:
0ffa4754
NR
473 support = new Epub();
474 break;
08fe2e33 475 case INFO_TEXT:
0ffa4754
NR
476 support = new InfoText();
477 break;
08fe2e33 478 case FIMFICTION:
315f14ae
NR
479 try {
480 // Can fail if no client key or NO in options
0ffa4754 481 support = new FimfictionApi();
315f14ae 482 } catch (IOException e) {
0ffa4754 483 support = new Fimfiction();
315f14ae 484 }
0ffa4754 485 break;
08fe2e33 486 case FANFICTION:
0ffa4754
NR
487 support = new Fanfiction();
488 break;
08fe2e33 489 case TEXT:
0ffa4754
NR
490 support = new Text();
491 break;
08fe2e33 492 case MANGAFOX:
0ffa4754
NR
493 support = new MangaFox();
494 break;
08fe2e33 495 case E621:
0ffa4754
NR
496 support = new E621();
497 break;
a4143cd7 498 case YIFFSTAR:
0ffa4754
NR
499 support = new YiffStar();
500 break;
f0608ab1 501 case E_HENTAI:
0ffa4754
NR
502 support = new EHentai();
503 break;
af1f506f
NR
504 case MANGA_LEL:
505 support = new MangaLel();
506 break;
08fe2e33 507 case CBZ:
0ffa4754
NR
508 support = new Cbz();
509 break;
373da363 510 case HTML:
0ffa4754
NR
511 support = new Html();
512 break;
68686a37
NR
513 }
514
0ffa4754
NR
515 if (support != null) {
516 support.setType(type);
517 support.source = support.getCanonicalUrl(url);
315f14ae
NR
518 }
519
0ffa4754 520 return support;
315f14ae 521 }
08fe2e33 522}