remote: do not send the cover in the metas
[fanfix.git] / src / be / nikiroo / fanfix / Main.java
CommitLineData
08fe2e33
NR
1package be.nikiroo.fanfix;
2
3import java.io.File;
4import java.io.IOException;
5import java.net.MalformedURLException;
6import java.net.URL;
f569d249 7import java.util.List;
08fe2e33
NR
8
9import be.nikiroo.fanfix.bundles.StringId;
10import be.nikiroo.fanfix.data.Chapter;
f569d249 11import be.nikiroo.fanfix.data.MetaData;
08fe2e33 12import be.nikiroo.fanfix.data.Story;
ff05b828
NR
13import be.nikiroo.fanfix.library.BasicLibrary;
14import be.nikiroo.fanfix.library.CacheLibrary;
e42573a0
NR
15import be.nikiroo.fanfix.library.LocalLibrary;
16import be.nikiroo.fanfix.library.RemoteLibrary;
17import be.nikiroo.fanfix.library.RemoteLibraryServer;
08fe2e33
NR
18import be.nikiroo.fanfix.output.BasicOutput;
19import be.nikiroo.fanfix.output.BasicOutput.OutputType;
3727aae2 20import be.nikiroo.fanfix.reader.BasicReader;
e42573a0
NR
21import be.nikiroo.fanfix.reader.Reader;
22import be.nikiroo.fanfix.reader.Reader.ReaderType;
08fe2e33 23import be.nikiroo.fanfix.supported.BasicSupport;
0ffa4754 24import be.nikiroo.fanfix.supported.SupportType;
3b2b638f 25import be.nikiroo.utils.Progress;
39c3c689 26import be.nikiroo.utils.Version;
62c63b07 27import be.nikiroo.utils.serial.server.ServerObject;
08fe2e33
NR
28
29/**
30 * Main program entry point.
31 *
32 * @author niki
33 */
34public class Main {
d0114000 35 private enum MainAction {
5e848e6a 36 IMPORT, EXPORT, CONVERT, READ, READ_URL, LIST, HELP, SET_READER, START, VERSION, SERVER, STOP_SERVER, REMOTE,
d0114000
NR
37 }
38
08fe2e33
NR
39 /**
40 * Main program entry point.
41 * <p>
42 * Known environment variables:
43 * <ul>
d0114000 44 * <li>NOUTF: if set to 1 or 'true', the program will prefer non-unicode
08fe2e33
NR
45 * {@link String}s when possible</li>
46 * <li>CONFIG_DIR: a path where to look for the <tt>.properties</tt> files
edd46289
NR
47 * before taking the usual ones; they will also be saved/updated into this
48 * path when the program starts</li>
d0114000
NR
49 * <li>DEBUG: if set to 1 or 'true', the program will override the DEBUG_ERR
50 * configuration value with 'true'</li>
51 * </ul>
52 * <p>
53 * <ul>
54 * <li>--import [URL]: import into library</li>
55 * <li>--export [id] [output_type] [target]: export story to target</li>
56 * <li>--convert [URL] [output_type] [target] (+info): convert URL into
57 * target</li>
58 * <li>--read [id] ([chapter number]): read the given story from the library
59 * </li>
333f0e7b 60 * <li>--read-url [URL] ([chapter number]): convert on the fly and read the
d0114000 61 * story, without saving it</li>
333f0e7b 62 * <li>--list ([type]): list the stories present in the library</li>
c1873e56
NR
63 * <li>--set-reader [reader type]: set the reader type to CLI, TUI or LOCAL
64 * for this command</li>
39c3c689 65 * <li>--version: get the version of the program</li>
2070ced5
NR
66 * <li>--server [key] [port]: start a server on this port</li>
67 * <li>--stop-server [key] [port]: stop the running server on this port if
68 * any</li>
69 * <li>--remote [key] [host] [port]: use a the given remote library</li>
08fe2e33
NR
70 * </ul>
71 *
72 * @param args
d0114000 73 * see method description
08fe2e33
NR
74 */
75 public static void main(String[] args) {
d0114000
NR
76 String urlString = null;
77 String luid = null;
b0e88ebd 78 String sourceString = null;
d0114000
NR
79 String chapString = null;
80 String target = null;
2070ced5 81 String key = null;
333f0e7b 82 MainAction action = MainAction.START;
d0114000 83 Boolean plusInfo = null;
b0e88ebd
NR
84 String host = null;
85 Integer port = null;
73ce17ef 86
d0114000
NR
87 boolean noMoreActions = false;
88
89 int exitCode = 0;
90 for (int i = 0; exitCode == 0 && i < args.length; i++) {
91 // Action (--) handling:
92 if (!noMoreActions && args[i].startsWith("--")) {
93 if (args[i].equals("--")) {
94 noMoreActions = true;
95 } else {
96 try {
97 action = MainAction.valueOf(args[i].substring(2)
98 .toUpperCase().replace("-", "_"));
99 } catch (Exception e) {
62c63b07
NR
100 Instance.getTraceHandler().error(
101 new IllegalArgumentException("Unknown action: "
102 + args[i], e));
d0114000
NR
103 exitCode = 255;
104 }
105 }
08fe2e33 106
d0114000
NR
107 continue;
108 }
109
110 switch (action) {
111 case IMPORT:
112 if (urlString == null) {
113 urlString = args[i];
114 } else {
115 exitCode = 255;
116 }
117 break;
118 case EXPORT:
119 if (luid == null) {
120 luid = args[i];
b0e88ebd
NR
121 } else if (sourceString == null) {
122 sourceString = args[i];
d0114000
NR
123 } else if (target == null) {
124 target = args[i];
125 } else {
126 exitCode = 255;
127 }
128 break;
129 case CONVERT:
130 if (urlString == null) {
131 urlString = args[i];
b0e88ebd
NR
132 } else if (sourceString == null) {
133 sourceString = args[i];
d0114000
NR
134 } else if (target == null) {
135 target = args[i];
136 } else if (plusInfo == null) {
137 if ("+info".equals(args[i])) {
138 plusInfo = true;
139 } else {
140 exitCode = 255;
141 }
142 } else {
143 exitCode = 255;
08fe2e33 144 }
d0114000
NR
145 break;
146 case LIST:
b0e88ebd
NR
147 if (sourceString == null) {
148 sourceString = args[i];
d0114000
NR
149 } else {
150 exitCode = 255;
08fe2e33 151 }
d0114000
NR
152 break;
153 case READ:
154 if (luid == null) {
155 luid = args[i];
156 } else if (chapString == null) {
157 chapString = args[i];
158 } else {
159 exitCode = 255;
08fe2e33 160 }
d0114000
NR
161 break;
162 case READ_URL:
163 if (urlString == null) {
164 urlString = args[i];
165 } else if (chapString == null) {
166 chapString = args[i];
167 } else {
168 exitCode = 255;
08fe2e33 169 }
d0114000
NR
170 break;
171 case HELP:
172 exitCode = 255;
173 break;
174 case SET_READER:
7de079f1 175 exitCode = setReaderType(args[i]);
c1873e56 176 action = MainAction.START;
d0114000 177 break;
333f0e7b
NR
178 case START:
179 exitCode = 255; // not supposed to be selected by user
180 break;
39c3c689
NR
181 case VERSION:
182 exitCode = 255; // no arguments for this option
b0e88ebd
NR
183 break;
184 case SERVER:
5e848e6a 185 case STOP_SERVER:
2070ced5
NR
186 if (key == null) {
187 key = args[i];
188 } else if (port == null) {
b0e88ebd
NR
189 port = Integer.parseInt(args[i]);
190 } else {
191 exitCode = 255;
192 }
193 break;
194 case REMOTE:
2070ced5
NR
195 if (key == null) {
196 key = args[i];
197 } else if (host == null) {
b0e88ebd
NR
198 host = args[i];
199 } else if (port == null) {
200 port = Integer.parseInt(args[i]);
ff05b828 201
2070ced5 202 BasicLibrary lib = new RemoteLibrary(key, host, port);
5895a958 203 lib = new CacheLibrary(Instance.getRemoteDir(host), lib);
ff05b828
NR
204
205 BasicReader.setDefaultLibrary(lib);
5e848e6a 206
b0e88ebd
NR
207 action = MainAction.START;
208 } else {
209 exitCode = 255;
210 }
211 break;
d0114000
NR
212 }
213 }
214
92fb0719
NR
215 final Progress mainProgress = new Progress(0, 80);
216 mainProgress.addProgressListener(new Progress.ProgressListener() {
217 private int current = mainProgress.getMin();
218
211f7ddb 219 @Override
92fb0719
NR
220 public void progress(Progress progress, String name) {
221 int diff = progress.getProgress() - current;
222 current += diff;
223
1822d603
NR
224 if (diff <= 0)
225 return;
226
92fb0719
NR
227 StringBuilder builder = new StringBuilder();
228 for (int i = 0; i < diff; i++) {
229 builder.append('.');
230 }
231
232 System.err.print(builder.toString());
233
234 if (progress.isDone()) {
235 System.err.println("");
236 }
237 }
238 });
239 Progress pg = new Progress();
240 mainProgress.addProgress(pg, mainProgress.getMax());
241
b42117f1
NR
242 VersionCheck updates = VersionCheck.check();
243 if (updates.isNewVersionAvailable()) {
244 // Sent to syserr so not to cause problem if one tries to capture a
245 // story content in text mode
246 System.err
247 .println("A new version of the program is available at https://github.com/nikiroo/fanfix/releases");
248 System.err.println("");
249 for (Version v : updates.getNewer()) {
250 System.err.println("\tVersion " + v);
251 System.err.println("\t-------------");
252 System.err.println("");
253 for (String item : updates.getChanges().get(v)) {
254 System.err.println("\t- " + item);
255 }
256 System.err.println("");
257 }
258 }
259
d0114000
NR
260 if (exitCode != 255) {
261 switch (action) {
262 case IMPORT:
92fb0719 263 exitCode = imprt(urlString, pg);
b42117f1 264 updates.ok(); // we consider it read
d0114000
NR
265 break;
266 case EXPORT:
b0e88ebd 267 exitCode = export(luid, sourceString, target, pg);
b42117f1 268 updates.ok(); // we consider it read
d0114000
NR
269 break;
270 case CONVERT:
b0e88ebd 271 exitCode = convert(urlString, sourceString, target,
92fb0719 272 plusInfo == null ? false : plusInfo, pg);
b42117f1 273 updates.ok(); // we consider it read
d0114000
NR
274 break;
275 case LIST:
99ccbdf6 276 if (BasicReader.getReader() == null) {
62c63b07
NR
277 Instance.getTraceHandler()
278 .error(new Exception(
279 "No reader type has been configured"));
99ccbdf6
NR
280 exitCode = 10;
281 break;
282 }
b0e88ebd 283 exitCode = list(sourceString);
d0114000
NR
284 break;
285 case READ:
99ccbdf6 286 if (BasicReader.getReader() == null) {
62c63b07
NR
287 Instance.getTraceHandler()
288 .error(new Exception(
289 "No reader type has been configured"));
99ccbdf6
NR
290 exitCode = 10;
291 break;
292 }
d0114000
NR
293 exitCode = read(luid, chapString, true);
294 break;
295 case READ_URL:
99ccbdf6 296 if (BasicReader.getReader() == null) {
62c63b07
NR
297 Instance.getTraceHandler()
298 .error(new Exception(
299 "No reader type has been configured"));
99ccbdf6
NR
300 exitCode = 10;
301 break;
302 }
d0114000
NR
303 exitCode = read(urlString, chapString, false);
304 break;
305 case HELP:
306 syntax(true);
307 exitCode = 0;
308 break;
309 case SET_READER:
b0e88ebd 310 exitCode = 255;
d0114000 311 break;
39c3c689
NR
312 case VERSION:
313 System.out
314 .println(String.format("Fanfix version %s"
9fe3f177
NR
315 + "%nhttps://github.com/nikiroo/fanfix/"
316 + "%n\tWritten by Nikiroo",
39c3c689 317 Version.getCurrentVersion()));
b42117f1 318 updates.ok(); // we consider it read
39c3c689 319 break;
333f0e7b 320 case START:
99ccbdf6 321 if (BasicReader.getReader() == null) {
62c63b07
NR
322 Instance.getTraceHandler()
323 .error(new Exception(
324 "No reader type has been configured"));
99ccbdf6
NR
325 exitCode = 10;
326 break;
327 }
b0e88ebd
NR
328 BasicReader.getReader().browse(null);
329 break;
330 case SERVER:
331 if (port == null) {
332 exitCode = 255;
333 break;
334 }
335 try {
62c63b07 336 ServerObject server = new RemoteLibraryServer(key, port);
22b2b942 337 server.setTraceHandler(Instance.getTraceHandler());
edf79e5e 338 server.run();
b0e88ebd 339 } catch (IOException e) {
62c63b07 340 Instance.getTraceHandler().error(e);
b0e88ebd
NR
341 }
342 return;
5e848e6a
NR
343 case STOP_SERVER:
344 if (port == null) {
345 exitCode = 255;
346 break;
347 }
348
468b960b 349 new RemoteLibrary(key, host, port).exit();
5e848e6a 350 break;
b0e88ebd 351 case REMOTE:
99ccbdf6 352 exitCode = 255; // should not be reachable (REMOTE -> START)
333f0e7b 353 break;
08fe2e33
NR
354 }
355 }
356
81b5e730
NR
357 // We cannot do it when in GUI mode, because it is async...
358 // So if we close the temp files before it is actually used,
359 // we have a problem...
360 // TODO: close it at the correct time (for now, finalize try to do it)
361 if (false) {
362 try {
363 Instance.getTempFiles().close();
364 } catch (IOException e) {
365 Instance.getTraceHandler().error(
366 new IOException(
367 "Cannot dispose of the temporary files", e));
368 }
2aac79c7
NR
369 }
370
08fe2e33 371 if (exitCode == 255) {
d0114000 372 syntax(false);
08fe2e33
NR
373 }
374
375 if (exitCode != 0) {
376 System.exit(exitCode);
377 }
378 }
379
08fe2e33 380 /**
68e2c6d2 381 * Import the given resource into the {@link LocalLibrary}.
08fe2e33 382 *
d0114000 383 * @param urlString
08fe2e33 384 * the resource to import
92fb0719
NR
385 * @param pg
386 * the optional progress reporter
08fe2e33
NR
387 *
388 * @return the exit return code (0 = success)
389 */
92fb0719 390 public static int imprt(String urlString, Progress pg) {
08fe2e33 391 try {
3b2b638f
NR
392 Story story = Instance.getLibrary().imprt(
393 BasicReader.getUrl(urlString), pg);
08fe2e33
NR
394 System.out.println(story.getMeta().getLuid() + ": \""
395 + story.getMeta().getTitle() + "\" imported.");
396 } catch (IOException e) {
62c63b07 397 Instance.getTraceHandler().error(e);
08fe2e33
NR
398 return 1;
399 }
400
401 return 0;
402 }
403
404 /**
68e2c6d2
NR
405 * Export the {@link Story} from the {@link LocalLibrary} to the given
406 * target.
08fe2e33 407 *
73ce17ef 408 * @param luid
08fe2e33
NR
409 * the story LUID
410 * @param typeString
411 * the {@link OutputType} to use
412 * @param target
413 * the target
92fb0719
NR
414 * @param pg
415 * the optional progress reporter
08fe2e33
NR
416 *
417 * @return the exit return code (0 = success)
418 */
92fb0719
NR
419 public static int export(String luid, String typeString, String target,
420 Progress pg) {
e604986c 421 OutputType type = OutputType.valueOfNullOkUC(typeString, null);
08fe2e33 422 if (type == null) {
62c63b07
NR
423 Instance.getTraceHandler().error(
424 new Exception(trans(StringId.OUTPUT_DESC, typeString)));
08fe2e33
NR
425 return 1;
426 }
427
428 try {
92fb0719 429 Instance.getLibrary().export(luid, type, target, pg);
08fe2e33 430 } catch (IOException e) {
62c63b07 431 Instance.getTraceHandler().error(e);
08fe2e33
NR
432 return 4;
433 }
434
435 return 0;
436 }
437
438 /**
68e2c6d2
NR
439 * List the stories of the given source from the {@link LocalLibrary}
440 * (unless NULL is passed, in which case all stories will be listed).
08fe2e33 441 *
b0e88ebd
NR
442 * @param source
443 * the source to list the known stories of, or NULL to list all
333f0e7b 444 * stories
08fe2e33
NR
445 *
446 * @return the exit return code (0 = success)
447 */
b0e88ebd 448 private static int list(String source) {
f569d249
NR
449 List<MetaData> stories;
450 stories = BasicReader.getReader().getLibrary().getListBySource(source);
451
452 for (MetaData story : stories) {
453 String author = "";
454 if (story.getAuthor() != null && !story.getAuthor().isEmpty()) {
455 author = " (" + story.getAuthor() + ")";
456 }
457
458 System.out.println(story.getLuid() + ": " + story.getTitle()
459 + author);
460 }
08fe2e33
NR
461 return 0;
462 }
463
464 /**
465 * Start the CLI reader for this {@link Story}.
466 *
467 * @param story
68e2c6d2
NR
468 * the LUID of the {@link Story} in the {@link LocalLibrary}
469 * <b>or</b> the {@link Story} {@link URL}
d0114000 470 * @param chapString
08fe2e33
NR
471 * which {@link Chapter} to read (starting at 1), or NULL to get
472 * the {@link Story} description
473 * @param library
474 * TRUE if the source is the {@link Story} LUID, FALSE if it is a
475 * {@link URL}
476 *
477 * @return the exit return code (0 = success)
478 */
d0114000 479 private static int read(String story, String chapString, boolean library) {
08fe2e33 480 try {
e42573a0 481 Reader reader = BasicReader.getReader();
08fe2e33 482 if (library) {
bc2ea776 483 reader.setMeta(story);
08fe2e33 484 } else {
bc2ea776 485 reader.setMeta(BasicReader.getUrl(story), null);
08fe2e33
NR
486 }
487
d0114000
NR
488 if (chapString != null) {
489 try {
bc2ea776
NR
490 reader.setChapter(Integer.parseInt(chapString));
491 reader.read();
d0114000 492 } catch (NumberFormatException e) {
62c63b07
NR
493 Instance.getTraceHandler().error(
494 new IOException("Chapter number cannot be parsed: "
495 + chapString, e));
d0114000
NR
496 return 2;
497 }
08fe2e33
NR
498 } else {
499 reader.read();
500 }
501 } catch (IOException e) {
62c63b07 502 Instance.getTraceHandler().error(e);
08fe2e33
NR
503 return 1;
504 }
505
506 return 0;
507 }
508
509 /**
510 * Convert the {@link Story} into another format.
511 *
d0114000 512 * @param urlString
08fe2e33
NR
513 * the source {@link Story} to convert
514 * @param typeString
515 * the {@link OutputType} to convert to
d0114000 516 * @param target
08fe2e33
NR
517 * the target file
518 * @param infoCover
519 * TRUE to also export the cover and info file, even if the given
520 * {@link OutputType} does not usually save them
92fb0719
NR
521 * @param pg
522 * the optional progress reporter
08fe2e33
NR
523 *
524 * @return the exit return code (0 = success)
525 */
f7460e4c 526 public static int convert(String urlString, String typeString,
92fb0719 527 String target, boolean infoCover, Progress pg) {
08fe2e33
NR
528 int exitCode = 0;
529
826e4569 530 Instance.getTraceHandler().trace("Convert: " + urlString);
d0114000 531 String sourceName = urlString;
08fe2e33 532 try {
3b2b638f 533 URL source = BasicReader.getUrl(urlString);
08fe2e33
NR
534 sourceName = source.toString();
535 if (source.toString().startsWith("file://")) {
536 sourceName = sourceName.substring("file://".length());
537 }
538
e604986c 539 OutputType type = OutputType.valueOfAllOkUC(typeString, null);
08fe2e33 540 if (type == null) {
62c63b07
NR
541 Instance.getTraceHandler().error(
542 new IOException(trans(StringId.ERR_BAD_OUTPUT_TYPE,
543 typeString)));
08fe2e33
NR
544
545 exitCode = 2;
546 } else {
547 try {
548 BasicSupport support = BasicSupport.getSupport(source);
333f0e7b 549
08fe2e33 550 if (support != null) {
826e4569 551 Instance.getTraceHandler().trace("Support found: " + support.getClass());
bee7dffe
NR
552 Progress pgIn = new Progress();
553 Progress pgOut = new Progress();
554 if (pg != null) {
555 pg.setMax(2);
556 pg.addProgress(pgIn, 1);
557 pg.addProgress(pgOut, 1);
558 }
08fe2e33 559
0ffa4754 560 Story story = support.process(pgIn);
08fe2e33 561 try {
d0114000 562 target = new File(target).getAbsolutePath();
925298fd
NR
563 BasicOutput.getOutput(type, infoCover, infoCover)
564 .process(story, target, pgOut);
08fe2e33 565 } catch (IOException e) {
62c63b07
NR
566 Instance.getTraceHandler().error(
567 new IOException(trans(StringId.ERR_SAVING,
568 target), e));
08fe2e33
NR
569 exitCode = 5;
570 }
571 } else {
62c63b07
NR
572 Instance.getTraceHandler().error(
573 new IOException(trans(
574 StringId.ERR_NOT_SUPPORTED, source)));
08fe2e33
NR
575
576 exitCode = 4;
577 }
578 } catch (IOException e) {
62c63b07
NR
579 Instance.getTraceHandler().error(
580 new IOException(trans(StringId.ERR_LOADING,
581 sourceName), e));
08fe2e33
NR
582 exitCode = 3;
583 }
584 }
585 } catch (MalformedURLException e) {
62c63b07
NR
586 Instance.getTraceHandler()
587 .error(new IOException(trans(StringId.ERR_BAD_URL,
588 sourceName), e));
08fe2e33
NR
589 exitCode = 1;
590 }
591
592 return exitCode;
593 }
594
595 /**
596 * Simple shortcut method to call {link Instance#getTrans()#getString()}.
597 *
598 * @param id
599 * the ID to translate
600 *
601 * @return the translated result
602 */
603 private static String trans(StringId id, Object... params) {
604 return Instance.getTrans().getString(id, params);
605 }
606
607 /**
d0114000
NR
608 * Display the correct syntax of the program to the user to stdout, or an
609 * error message if the syntax used was wrong on stderr.
610 *
611 * @param showHelp
612 * TRUE to show the syntax help, FALSE to show "syntax error"
08fe2e33 613 */
d0114000
NR
614 private static void syntax(boolean showHelp) {
615 if (showHelp) {
616 StringBuilder builder = new StringBuilder();
617 for (SupportType type : SupportType.values()) {
618 builder.append(trans(StringId.ERR_SYNTAX_TYPE, type.toString(),
619 type.getDesc()));
620 builder.append('\n');
621 }
08fe2e33 622
d0114000
NR
623 String typesIn = builder.toString();
624 builder.setLength(0);
08fe2e33 625
d0114000
NR
626 for (OutputType type : OutputType.values()) {
627 builder.append(trans(StringId.ERR_SYNTAX_TYPE, type.toString(),
4d205683 628 type.getDesc(true)));
d0114000
NR
629 builder.append('\n');
630 }
08fe2e33 631
d0114000 632 String typesOut = builder.toString();
08fe2e33 633
d0114000
NR
634 System.out.println(trans(StringId.HELP_SYNTAX, typesIn, typesOut));
635 } else {
636 System.err.println(trans(StringId.ERR_SYNTAX));
637 }
638 }
639
640 /**
641 * Set the default reader type for this session only (it can be changed in
642 * the configuration file, too, but this value will override it).
643 *
644 * @param readerTypeString
645 * the type
646 */
647 private static int setReaderType(String readerTypeString) {
648 try {
7de079f1
NR
649 ReaderType readerType = ReaderType.valueOf(readerTypeString
650 .toUpperCase());
d0114000
NR
651 BasicReader.setDefaultReaderType(readerType);
652 return 0;
653 } catch (IllegalArgumentException e) {
62c63b07
NR
654 Instance.getTraceHandler().error(
655 new IOException("Unknown reader type: " + readerTypeString,
656 e));
d0114000
NR
657 return 1;
658 }
08fe2e33
NR
659 }
660}