Fix tests by removing uneeded error traces
[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
224 StringBuilder builder = new StringBuilder();
225 for (int i = 0; i < diff; i++) {
226 builder.append('.');
227 }
228
229 System.err.print(builder.toString());
230
231 if (progress.isDone()) {
232 System.err.println("");
233 }
234 }
235 });
236 Progress pg = new Progress();
237 mainProgress.addProgress(pg, mainProgress.getMax());
238
b42117f1
NR
239 VersionCheck updates = VersionCheck.check();
240 if (updates.isNewVersionAvailable()) {
241 // Sent to syserr so not to cause problem if one tries to capture a
242 // story content in text mode
243 System.err
244 .println("A new version of the program is available at https://github.com/nikiroo/fanfix/releases");
245 System.err.println("");
246 for (Version v : updates.getNewer()) {
247 System.err.println("\tVersion " + v);
248 System.err.println("\t-------------");
249 System.err.println("");
250 for (String item : updates.getChanges().get(v)) {
251 System.err.println("\t- " + item);
252 }
253 System.err.println("");
254 }
255 }
256
d0114000
NR
257 if (exitCode != 255) {
258 switch (action) {
259 case IMPORT:
92fb0719 260 exitCode = imprt(urlString, pg);
b42117f1 261 updates.ok(); // we consider it read
d0114000
NR
262 break;
263 case EXPORT:
b0e88ebd 264 exitCode = export(luid, sourceString, target, pg);
b42117f1 265 updates.ok(); // we consider it read
d0114000
NR
266 break;
267 case CONVERT:
b0e88ebd 268 exitCode = convert(urlString, sourceString, target,
92fb0719 269 plusInfo == null ? false : plusInfo, pg);
b42117f1 270 updates.ok(); // we consider it read
d0114000
NR
271 break;
272 case LIST:
99ccbdf6 273 if (BasicReader.getReader() == null) {
62c63b07
NR
274 Instance.getTraceHandler()
275 .error(new Exception(
276 "No reader type has been configured"));
99ccbdf6
NR
277 exitCode = 10;
278 break;
279 }
b0e88ebd 280 exitCode = list(sourceString);
d0114000
NR
281 break;
282 case READ:
99ccbdf6 283 if (BasicReader.getReader() == null) {
62c63b07
NR
284 Instance.getTraceHandler()
285 .error(new Exception(
286 "No reader type has been configured"));
99ccbdf6
NR
287 exitCode = 10;
288 break;
289 }
d0114000
NR
290 exitCode = read(luid, chapString, true);
291 break;
292 case READ_URL:
99ccbdf6 293 if (BasicReader.getReader() == null) {
62c63b07
NR
294 Instance.getTraceHandler()
295 .error(new Exception(
296 "No reader type has been configured"));
99ccbdf6
NR
297 exitCode = 10;
298 break;
299 }
d0114000
NR
300 exitCode = read(urlString, chapString, false);
301 break;
302 case HELP:
303 syntax(true);
304 exitCode = 0;
305 break;
306 case SET_READER:
b0e88ebd 307 exitCode = 255;
d0114000 308 break;
39c3c689
NR
309 case VERSION:
310 System.out
311 .println(String.format("Fanfix version %s"
9fe3f177
NR
312 + "%nhttps://github.com/nikiroo/fanfix/"
313 + "%n\tWritten by Nikiroo",
39c3c689 314 Version.getCurrentVersion()));
b42117f1 315 updates.ok(); // we consider it read
39c3c689 316 break;
333f0e7b 317 case START:
99ccbdf6 318 if (BasicReader.getReader() == null) {
62c63b07
NR
319 Instance.getTraceHandler()
320 .error(new Exception(
321 "No reader type has been configured"));
99ccbdf6
NR
322 exitCode = 10;
323 break;
324 }
b0e88ebd
NR
325 BasicReader.getReader().browse(null);
326 break;
327 case SERVER:
328 if (port == null) {
329 exitCode = 255;
330 break;
331 }
332 try {
62c63b07 333 ServerObject server = new RemoteLibraryServer(key, port);
22b2b942 334 server.setTraceHandler(Instance.getTraceHandler());
edf79e5e 335 server.run();
b0e88ebd 336 } catch (IOException e) {
62c63b07 337 Instance.getTraceHandler().error(e);
b0e88ebd
NR
338 }
339 return;
5e848e6a
NR
340 case STOP_SERVER:
341 if (port == null) {
342 exitCode = 255;
343 break;
344 }
345
468b960b 346 new RemoteLibrary(key, host, port).exit();
5e848e6a 347 break;
b0e88ebd 348 case REMOTE:
99ccbdf6 349 exitCode = 255; // should not be reachable (REMOTE -> START)
333f0e7b 350 break;
08fe2e33
NR
351 }
352 }
353
354 if (exitCode == 255) {
d0114000 355 syntax(false);
08fe2e33
NR
356 }
357
358 if (exitCode != 0) {
359 System.exit(exitCode);
360 }
361 }
362
08fe2e33 363 /**
68e2c6d2 364 * Import the given resource into the {@link LocalLibrary}.
08fe2e33 365 *
d0114000 366 * @param urlString
08fe2e33 367 * the resource to import
92fb0719
NR
368 * @param pg
369 * the optional progress reporter
08fe2e33
NR
370 *
371 * @return the exit return code (0 = success)
372 */
92fb0719 373 public static int imprt(String urlString, Progress pg) {
08fe2e33 374 try {
3b2b638f
NR
375 Story story = Instance.getLibrary().imprt(
376 BasicReader.getUrl(urlString), pg);
08fe2e33
NR
377 System.out.println(story.getMeta().getLuid() + ": \""
378 + story.getMeta().getTitle() + "\" imported.");
379 } catch (IOException e) {
62c63b07 380 Instance.getTraceHandler().error(e);
08fe2e33
NR
381 return 1;
382 }
383
384 return 0;
385 }
386
387 /**
68e2c6d2
NR
388 * Export the {@link Story} from the {@link LocalLibrary} to the given
389 * target.
08fe2e33 390 *
73ce17ef 391 * @param luid
08fe2e33
NR
392 * the story LUID
393 * @param typeString
394 * the {@link OutputType} to use
395 * @param target
396 * the target
92fb0719
NR
397 * @param pg
398 * the optional progress reporter
08fe2e33
NR
399 *
400 * @return the exit return code (0 = success)
401 */
92fb0719
NR
402 public static int export(String luid, String typeString, String target,
403 Progress pg) {
e604986c 404 OutputType type = OutputType.valueOfNullOkUC(typeString, null);
08fe2e33 405 if (type == null) {
62c63b07
NR
406 Instance.getTraceHandler().error(
407 new Exception(trans(StringId.OUTPUT_DESC, typeString)));
08fe2e33
NR
408 return 1;
409 }
410
411 try {
92fb0719 412 Instance.getLibrary().export(luid, type, target, pg);
08fe2e33 413 } catch (IOException e) {
62c63b07 414 Instance.getTraceHandler().error(e);
08fe2e33
NR
415 return 4;
416 }
417
418 return 0;
419 }
420
421 /**
68e2c6d2
NR
422 * List the stories of the given source from the {@link LocalLibrary}
423 * (unless NULL is passed, in which case all stories will be listed).
08fe2e33 424 *
b0e88ebd
NR
425 * @param source
426 * the source to list the known stories of, or NULL to list all
333f0e7b 427 * stories
08fe2e33
NR
428 *
429 * @return the exit return code (0 = success)
430 */
b0e88ebd 431 private static int list(String source) {
f569d249
NR
432 List<MetaData> stories;
433 stories = BasicReader.getReader().getLibrary().getListBySource(source);
434
435 for (MetaData story : stories) {
436 String author = "";
437 if (story.getAuthor() != null && !story.getAuthor().isEmpty()) {
438 author = " (" + story.getAuthor() + ")";
439 }
440
441 System.out.println(story.getLuid() + ": " + story.getTitle()
442 + author);
443 }
08fe2e33
NR
444 return 0;
445 }
446
447 /**
448 * Start the CLI reader for this {@link Story}.
449 *
450 * @param story
68e2c6d2
NR
451 * the LUID of the {@link Story} in the {@link LocalLibrary}
452 * <b>or</b> the {@link Story} {@link URL}
d0114000 453 * @param chapString
08fe2e33
NR
454 * which {@link Chapter} to read (starting at 1), or NULL to get
455 * the {@link Story} description
456 * @param library
457 * TRUE if the source is the {@link Story} LUID, FALSE if it is a
458 * {@link URL}
459 *
460 * @return the exit return code (0 = success)
461 */
d0114000 462 private static int read(String story, String chapString, boolean library) {
08fe2e33 463 try {
e42573a0 464 Reader reader = BasicReader.getReader();
08fe2e33 465 if (library) {
bc2ea776 466 reader.setMeta(story);
08fe2e33 467 } else {
bc2ea776 468 reader.setMeta(BasicReader.getUrl(story), null);
08fe2e33
NR
469 }
470
d0114000
NR
471 if (chapString != null) {
472 try {
bc2ea776
NR
473 reader.setChapter(Integer.parseInt(chapString));
474 reader.read();
d0114000 475 } catch (NumberFormatException e) {
62c63b07
NR
476 Instance.getTraceHandler().error(
477 new IOException("Chapter number cannot be parsed: "
478 + chapString, e));
d0114000
NR
479 return 2;
480 }
08fe2e33
NR
481 } else {
482 reader.read();
483 }
484 } catch (IOException e) {
62c63b07 485 Instance.getTraceHandler().error(e);
08fe2e33
NR
486 return 1;
487 }
488
489 return 0;
490 }
491
492 /**
493 * Convert the {@link Story} into another format.
494 *
d0114000 495 * @param urlString
08fe2e33
NR
496 * the source {@link Story} to convert
497 * @param typeString
498 * the {@link OutputType} to convert to
d0114000 499 * @param target
08fe2e33
NR
500 * the target file
501 * @param infoCover
502 * TRUE to also export the cover and info file, even if the given
503 * {@link OutputType} does not usually save them
92fb0719
NR
504 * @param pg
505 * the optional progress reporter
08fe2e33
NR
506 *
507 * @return the exit return code (0 = success)
508 */
f7460e4c 509 public static int convert(String urlString, String typeString,
92fb0719 510 String target, boolean infoCover, Progress pg) {
08fe2e33
NR
511 int exitCode = 0;
512
d0114000 513 String sourceName = urlString;
08fe2e33 514 try {
3b2b638f 515 URL source = BasicReader.getUrl(urlString);
08fe2e33
NR
516 sourceName = source.toString();
517 if (source.toString().startsWith("file://")) {
518 sourceName = sourceName.substring("file://".length());
519 }
520
e604986c 521 OutputType type = OutputType.valueOfAllOkUC(typeString, null);
08fe2e33 522 if (type == null) {
62c63b07
NR
523 Instance.getTraceHandler().error(
524 new IOException(trans(StringId.ERR_BAD_OUTPUT_TYPE,
525 typeString)));
08fe2e33
NR
526
527 exitCode = 2;
528 } else {
529 try {
530 BasicSupport support = BasicSupport.getSupport(source);
333f0e7b 531
08fe2e33 532 if (support != null) {
bee7dffe
NR
533 Progress pgIn = new Progress();
534 Progress pgOut = new Progress();
535 if (pg != null) {
536 pg.setMax(2);
537 pg.addProgress(pgIn, 1);
538 pg.addProgress(pgOut, 1);
539 }
08fe2e33 540
0ffa4754 541 Story story = support.process(pgIn);
08fe2e33 542 try {
d0114000 543 target = new File(target).getAbsolutePath();
925298fd
NR
544 BasicOutput.getOutput(type, infoCover, infoCover)
545 .process(story, target, pgOut);
08fe2e33 546 } catch (IOException e) {
62c63b07
NR
547 Instance.getTraceHandler().error(
548 new IOException(trans(StringId.ERR_SAVING,
549 target), e));
08fe2e33
NR
550 exitCode = 5;
551 }
552 } else {
62c63b07
NR
553 Instance.getTraceHandler().error(
554 new IOException(trans(
555 StringId.ERR_NOT_SUPPORTED, source)));
08fe2e33
NR
556
557 exitCode = 4;
558 }
559 } catch (IOException e) {
62c63b07
NR
560 Instance.getTraceHandler().error(
561 new IOException(trans(StringId.ERR_LOADING,
562 sourceName), e));
08fe2e33
NR
563 exitCode = 3;
564 }
565 }
566 } catch (MalformedURLException e) {
62c63b07
NR
567 Instance.getTraceHandler()
568 .error(new IOException(trans(StringId.ERR_BAD_URL,
569 sourceName), e));
08fe2e33
NR
570 exitCode = 1;
571 }
572
573 return exitCode;
574 }
575
576 /**
577 * Simple shortcut method to call {link Instance#getTrans()#getString()}.
578 *
579 * @param id
580 * the ID to translate
581 *
582 * @return the translated result
583 */
584 private static String trans(StringId id, Object... params) {
585 return Instance.getTrans().getString(id, params);
586 }
587
588 /**
d0114000
NR
589 * Display the correct syntax of the program to the user to stdout, or an
590 * error message if the syntax used was wrong on stderr.
591 *
592 * @param showHelp
593 * TRUE to show the syntax help, FALSE to show "syntax error"
08fe2e33 594 */
d0114000
NR
595 private static void syntax(boolean showHelp) {
596 if (showHelp) {
597 StringBuilder builder = new StringBuilder();
598 for (SupportType type : SupportType.values()) {
599 builder.append(trans(StringId.ERR_SYNTAX_TYPE, type.toString(),
600 type.getDesc()));
601 builder.append('\n');
602 }
08fe2e33 603
d0114000
NR
604 String typesIn = builder.toString();
605 builder.setLength(0);
08fe2e33 606
d0114000
NR
607 for (OutputType type : OutputType.values()) {
608 builder.append(trans(StringId.ERR_SYNTAX_TYPE, type.toString(),
4d205683 609 type.getDesc(true)));
d0114000
NR
610 builder.append('\n');
611 }
08fe2e33 612
d0114000 613 String typesOut = builder.toString();
08fe2e33 614
d0114000
NR
615 System.out.println(trans(StringId.HELP_SYNTAX, typesIn, typesOut));
616 } else {
617 System.err.println(trans(StringId.ERR_SYNTAX));
618 }
619 }
620
621 /**
622 * Set the default reader type for this session only (it can be changed in
623 * the configuration file, too, but this value will override it).
624 *
625 * @param readerTypeString
626 * the type
627 */
628 private static int setReaderType(String readerTypeString) {
629 try {
7de079f1
NR
630 ReaderType readerType = ReaderType.valueOf(readerTypeString
631 .toUpperCase());
d0114000
NR
632 BasicReader.setDefaultReaderType(readerType);
633 return 0;
634 } catch (IllegalArgumentException e) {
62c63b07
NR
635 Instance.getTraceHandler().error(
636 new IOException("Unknown reader type: " + readerTypeString,
637 e));
d0114000
NR
638 return 1;
639 }
08fe2e33
NR
640 }
641}