1 package be
.nikiroo
.fanfix
;
4 import java
.io
.IOException
;
5 import java
.net
.MalformedURLException
;
9 import be
.nikiroo
.fanfix
.bundles
.StringId
;
10 import be
.nikiroo
.fanfix
.data
.Chapter
;
11 import be
.nikiroo
.fanfix
.data
.MetaData
;
12 import be
.nikiroo
.fanfix
.data
.Story
;
13 import be
.nikiroo
.fanfix
.library
.BasicLibrary
;
14 import be
.nikiroo
.fanfix
.library
.CacheLibrary
;
15 import be
.nikiroo
.fanfix
.library
.LocalLibrary
;
16 import be
.nikiroo
.fanfix
.library
.RemoteLibrary
;
17 import be
.nikiroo
.fanfix
.library
.RemoteLibraryServer
;
18 import be
.nikiroo
.fanfix
.output
.BasicOutput
;
19 import be
.nikiroo
.fanfix
.output
.BasicOutput
.OutputType
;
20 import be
.nikiroo
.fanfix
.reader
.BasicReader
;
21 import be
.nikiroo
.fanfix
.reader
.Reader
;
22 import be
.nikiroo
.fanfix
.reader
.Reader
.ReaderType
;
23 import be
.nikiroo
.fanfix
.supported
.BasicSupport
;
24 import be
.nikiroo
.fanfix
.supported
.SupportType
;
25 import be
.nikiroo
.utils
.Progress
;
26 import be
.nikiroo
.utils
.Version
;
27 import be
.nikiroo
.utils
.serial
.server
.ServerObject
;
30 * Main program entry point.
35 private enum MainAction
{
36 IMPORT
, EXPORT
, CONVERT
, READ
, READ_URL
, LIST
, HELP
, SET_READER
, START
, VERSION
, SERVER
, STOP_SERVER
, REMOTE
,
40 * Main program entry point.
42 * Known environment variables:
44 * <li>NOUTF: if set to 1 or 'true', the program will prefer non-unicode
45 * {@link String}s when possible</li>
46 * <li>CONFIG_DIR: a path where to look for the <tt>.properties</tt> files
47 * before taking the usual ones; they will also be saved/updated into this
48 * path when the program starts</li>
49 * <li>DEBUG: if set to 1 or 'true', the program will override the DEBUG_ERR
50 * configuration value with 'true'</li>
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
58 * <li>--read [id] ([chapter number]): read the given story from the library
60 * <li>--read-url [URL] ([chapter number]): convert on the fly and read the
61 * story, without saving it</li>
62 * <li>--list ([type]): list the stories present in the library</li>
63 * <li>--set-reader [reader type]: set the reader type to CLI, TUI or LOCAL
64 * for this command</li>
65 * <li>--version: get the version of the program</li>
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
69 * <li>--remote [key] [host] [port]: use a the given remote library</li>
73 * see method description
75 public static void main(String
[] args
) {
76 String urlString
= null;
78 String sourceString
= null;
79 String chapString
= null;
82 MainAction action
= MainAction
.START
;
83 Boolean plusInfo
= null;
87 boolean noMoreActions
= false;
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("--")) {
97 action
= MainAction
.valueOf(args
[i
].substring(2)
98 .toUpperCase().replace("-", "_"));
99 } catch (Exception e
) {
100 Instance
.getTraceHandler().error(
101 new IllegalArgumentException("Unknown action: "
112 if (urlString
== null) {
121 } else if (sourceString
== null) {
122 sourceString
= args
[i
];
123 } else if (target
== null) {
130 if (urlString
== null) {
132 } else if (sourceString
== null) {
133 sourceString
= args
[i
];
134 } else if (target
== null) {
136 } else if (plusInfo
== null) {
137 if ("+info".equals(args
[i
])) {
147 if (sourceString
== null) {
148 sourceString
= args
[i
];
156 } else if (chapString
== null) {
157 chapString
= args
[i
];
163 if (urlString
== null) {
165 } else if (chapString
== null) {
166 chapString
= args
[i
];
175 exitCode
= setReaderType(args
[i
]);
176 action
= MainAction
.START
;
179 exitCode
= 255; // not supposed to be selected by user
182 exitCode
= 255; // no arguments for this option
188 } else if (port
== null) {
189 port
= Integer
.parseInt(args
[i
]);
197 } else if (host
== null) {
199 } else if (port
== null) {
200 port
= Integer
.parseInt(args
[i
]);
202 BasicLibrary lib
= new RemoteLibrary(key
, host
, port
);
203 lib
= new CacheLibrary(Instance
.getRemoteDir(host
), lib
);
205 BasicReader
.setDefaultLibrary(lib
);
207 action
= MainAction
.START
;
215 final Progress mainProgress
= new Progress(0, 80);
216 mainProgress
.addProgressListener(new Progress
.ProgressListener() {
217 private int current
= mainProgress
.getMin();
220 public void progress(Progress progress
, String name
) {
221 int diff
= progress
.getProgress() - current
;
227 StringBuilder builder
= new StringBuilder();
228 for (int i
= 0; i
< diff
; i
++) {
232 System
.err
.print(builder
.toString());
234 if (progress
.isDone()) {
235 System
.err
.println("");
239 Progress pg
= new Progress();
240 mainProgress
.addProgress(pg
, mainProgress
.getMax());
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
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
);
256 System
.err
.println("");
260 if (exitCode
!= 255) {
263 exitCode
= imprt(urlString
, pg
);
264 updates
.ok(); // we consider it read
267 exitCode
= export(luid
, sourceString
, target
, pg
);
268 updates
.ok(); // we consider it read
271 exitCode
= convert(urlString
, sourceString
, target
,
272 plusInfo
== null ?
false : plusInfo
, pg
);
273 updates
.ok(); // we consider it read
276 if (BasicReader
.getReader() == null) {
277 Instance
.getTraceHandler()
278 .error(new Exception(
279 "No reader type has been configured"));
283 exitCode
= list(sourceString
);
286 if (BasicReader
.getReader() == null) {
287 Instance
.getTraceHandler()
288 .error(new Exception(
289 "No reader type has been configured"));
293 exitCode
= read(luid
, chapString
, true);
296 if (BasicReader
.getReader() == null) {
297 Instance
.getTraceHandler()
298 .error(new Exception(
299 "No reader type has been configured"));
303 exitCode
= read(urlString
, chapString
, false);
314 .println(String
.format("Fanfix version %s"
315 + "%nhttps://github.com/nikiroo/fanfix/"
316 + "%n\tWritten by Nikiroo",
317 Version
.getCurrentVersion()));
318 updates
.ok(); // we consider it read
321 if (BasicReader
.getReader() == null) {
322 Instance
.getTraceHandler()
323 .error(new Exception(
324 "No reader type has been configured"));
328 BasicReader
.getReader().browse(null);
336 ServerObject server
= new RemoteLibraryServer(key
, port
);
337 server
.setTraceHandler(Instance
.getTraceHandler());
339 } catch (IOException e
) {
340 Instance
.getTraceHandler().error(e
);
349 new RemoteLibrary(key
, host
, port
).exit();
352 exitCode
= 255; // should not be reachable (REMOTE -> START)
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)
363 Instance
.getTempFiles().close();
364 } catch (IOException e
) {
365 Instance
.getTraceHandler().error(
367 "Cannot dispose of the temporary files", e
));
371 if (exitCode
== 255) {
376 System
.exit(exitCode
);
381 * Import the given resource into the {@link LocalLibrary}.
384 * the resource to import
386 * the optional progress reporter
388 * @return the exit return code (0 = success)
390 public static int imprt(String urlString
, Progress pg
) {
392 Story story
= Instance
.getLibrary().imprt(
393 BasicReader
.getUrl(urlString
), pg
);
394 System
.out
.println(story
.getMeta().getLuid() + ": \""
395 + story
.getMeta().getTitle() + "\" imported.");
396 } catch (IOException e
) {
397 Instance
.getTraceHandler().error(e
);
405 * Export the {@link Story} from the {@link LocalLibrary} to the given
411 * the {@link OutputType} to use
415 * the optional progress reporter
417 * @return the exit return code (0 = success)
419 public static int export(String luid
, String typeString
, String target
,
421 OutputType type
= OutputType
.valueOfNullOkUC(typeString
, null);
423 Instance
.getTraceHandler().error(
424 new Exception(trans(StringId
.OUTPUT_DESC
, typeString
)));
429 Instance
.getLibrary().export(luid
, type
, target
, pg
);
430 } catch (IOException e
) {
431 Instance
.getTraceHandler().error(e
);
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).
443 * the source to list the known stories of, or NULL to list all
446 * @return the exit return code (0 = success)
448 private static int list(String source
) {
449 List
<MetaData
> stories
;
450 stories
= BasicReader
.getReader().getLibrary().getListBySource(source
);
452 for (MetaData story
: stories
) {
454 if (story
.getAuthor() != null && !story
.getAuthor().isEmpty()) {
455 author
= " (" + story
.getAuthor() + ")";
458 System
.out
.println(story
.getLuid() + ": " + story
.getTitle()
465 * Start the CLI reader for this {@link Story}.
468 * the LUID of the {@link Story} in the {@link LocalLibrary}
469 * <b>or</b> the {@link Story} {@link URL}
471 * which {@link Chapter} to read (starting at 1), or NULL to get
472 * the {@link Story} description
474 * TRUE if the source is the {@link Story} LUID, FALSE if it is a
477 * @return the exit return code (0 = success)
479 private static int read(String story
, String chapString
, boolean library
) {
481 Reader reader
= BasicReader
.getReader();
483 reader
.setMeta(story
);
485 reader
.setMeta(BasicReader
.getUrl(story
), null);
488 if (chapString
!= null) {
490 reader
.setChapter(Integer
.parseInt(chapString
));
492 } catch (NumberFormatException e
) {
493 Instance
.getTraceHandler().error(
494 new IOException("Chapter number cannot be parsed: "
501 } catch (IOException e
) {
502 Instance
.getTraceHandler().error(e
);
510 * Convert the {@link Story} into another format.
513 * the source {@link Story} to convert
515 * the {@link OutputType} to convert to
519 * TRUE to also export the cover and info file, even if the given
520 * {@link OutputType} does not usually save them
522 * the optional progress reporter
524 * @return the exit return code (0 = success)
526 public static int convert(String urlString
, String typeString
,
527 String target
, boolean infoCover
, Progress pg
) {
530 Instance
.getTraceHandler().trace("Convert: " + urlString
);
531 String sourceName
= urlString
;
533 URL source
= BasicReader
.getUrl(urlString
);
534 sourceName
= source
.toString();
535 if (source
.toString().startsWith("file://")) {
536 sourceName
= sourceName
.substring("file://".length());
539 OutputType type
= OutputType
.valueOfAllOkUC(typeString
, null);
541 Instance
.getTraceHandler().error(
542 new IOException(trans(StringId
.ERR_BAD_OUTPUT_TYPE
,
548 BasicSupport support
= BasicSupport
.getSupport(source
);
550 if (support
!= null) {
551 Instance
.getTraceHandler().trace("Support found: " + support
.getClass());
552 Progress pgIn
= new Progress();
553 Progress pgOut
= new Progress();
556 pg
.addProgress(pgIn
, 1);
557 pg
.addProgress(pgOut
, 1);
560 Story story
= support
.process(pgIn
);
562 target
= new File(target
).getAbsolutePath();
563 BasicOutput
.getOutput(type
, infoCover
, infoCover
)
564 .process(story
, target
, pgOut
);
565 } catch (IOException e
) {
566 Instance
.getTraceHandler().error(
567 new IOException(trans(StringId
.ERR_SAVING
,
572 Instance
.getTraceHandler().error(
573 new IOException(trans(
574 StringId
.ERR_NOT_SUPPORTED
, source
)));
578 } catch (IOException e
) {
579 Instance
.getTraceHandler().error(
580 new IOException(trans(StringId
.ERR_LOADING
,
585 } catch (MalformedURLException e
) {
586 Instance
.getTraceHandler()
587 .error(new IOException(trans(StringId
.ERR_BAD_URL
,
596 * Simple shortcut method to call {link Instance#getTrans()#getString()}.
599 * the ID to translate
601 * @return the translated result
603 private static String
trans(StringId id
, Object
... params
) {
604 return Instance
.getTrans().getString(id
, params
);
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.
612 * TRUE to show the syntax help, FALSE to show "syntax error"
614 private static void syntax(boolean showHelp
) {
616 StringBuilder builder
= new StringBuilder();
617 for (SupportType type
: SupportType
.values()) {
618 builder
.append(trans(StringId
.ERR_SYNTAX_TYPE
, type
.toString(),
620 builder
.append('\n');
623 String typesIn
= builder
.toString();
624 builder
.setLength(0);
626 for (OutputType type
: OutputType
.values()) {
627 builder
.append(trans(StringId
.ERR_SYNTAX_TYPE
, type
.toString(),
628 type
.getDesc(true)));
629 builder
.append('\n');
632 String typesOut
= builder
.toString();
634 System
.out
.println(trans(StringId
.HELP_SYNTAX
, typesIn
, typesOut
));
636 System
.err
.println(trans(StringId
.ERR_SYNTAX
));
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).
644 * @param readerTypeString
647 private static int setReaderType(String readerTypeString
) {
649 ReaderType readerType
= ReaderType
.valueOf(readerTypeString
651 BasicReader
.setDefaultReaderType(readerType
);
653 } catch (IllegalArgumentException e
) {
654 Instance
.getTraceHandler().error(
655 new IOException("Unknown reader type: " + readerTypeString
,