1 package be
.nikiroo
.fanfix
;
4 import java
.io
.IOException
;
5 import java
.net
.MalformedURLException
;
8 import be
.nikiroo
.fanfix
.bundles
.StringId
;
9 import be
.nikiroo
.fanfix
.data
.Chapter
;
10 import be
.nikiroo
.fanfix
.data
.Story
;
11 import be
.nikiroo
.fanfix
.output
.BasicOutput
;
12 import be
.nikiroo
.fanfix
.output
.BasicOutput
.OutputType
;
13 import be
.nikiroo
.fanfix
.reader
.BasicReader
;
14 import be
.nikiroo
.fanfix
.reader
.BasicReader
.ReaderType
;
15 import be
.nikiroo
.fanfix
.supported
.BasicSupport
;
16 import be
.nikiroo
.fanfix
.supported
.BasicSupport
.SupportType
;
17 import be
.nikiroo
.utils
.Progress
;
18 import be
.nikiroo
.utils
.Version
;
19 import be
.nikiroo
.utils
.serial
.Server
;
22 * Main program entry point.
27 private enum MainAction
{
28 IMPORT
, EXPORT
, CONVERT
, READ
, READ_URL
, LIST
, HELP
, SET_READER
, START
, VERSION
, SERVER
, REMOTE
,
32 * Main program entry point.
34 * Known environment variables:
36 * <li>NOUTF: if set to 1 or 'true', the program will prefer non-unicode
37 * {@link String}s when possible</li>
38 * <li>CONFIG_DIR: a path where to look for the <tt>.properties</tt> files
39 * before taking the usual ones; they will also be saved/updated into this
40 * path when the program starts</li>
41 * <li>DEBUG: if set to 1 or 'true', the program will override the DEBUG_ERR
42 * configuration value with 'true'</li>
46 * <li>--import [URL]: import into library</li>
47 * <li>--export [id] [output_type] [target]: export story to target</li>
48 * <li>--convert [URL] [output_type] [target] (+info): convert URL into
50 * <li>--read [id] ([chapter number]): read the given story from the library
52 * <li>--read-url [URL] ([chapter number]): convert on the fly and read the
53 * story, without saving it</li>
54 * <li>--list ([type]): list the stories present in the library</li>
55 * <li>--set-reader [reader type]: set the reader type to CLI, TUI or LOCAL
56 * for this command</li>
57 * <li>--version: get the version of the program</li>
58 * <li>--server [port]: start a server on this port</li>
59 * <li>--remote [host] [port]: use a the given remote library</li>
63 * see method description
65 public static void main(String
[] args
) {
66 String urlString
= null;
68 String sourceString
= null;
69 String chapString
= null;
71 MainAction action
= MainAction
.START
;
72 Boolean plusInfo
= null;
76 boolean noMoreActions
= false;
79 for (int i
= 0; exitCode
== 0 && i
< args
.length
; i
++) {
80 // Action (--) handling:
81 if (!noMoreActions
&& args
[i
].startsWith("--")) {
82 if (args
[i
].equals("--")) {
86 action
= MainAction
.valueOf(args
[i
].substring(2)
87 .toUpperCase().replace("-", "_"));
88 } catch (Exception e
) {
89 Instance
.syserr(new IllegalArgumentException(
90 "Unknown action: " + args
[i
], e
));
100 if (urlString
== null) {
109 } else if (sourceString
== null) {
110 sourceString
= args
[i
];
111 } else if (target
== null) {
118 if (urlString
== null) {
120 } else if (sourceString
== null) {
121 sourceString
= args
[i
];
122 } else if (target
== null) {
124 } else if (plusInfo
== null) {
125 if ("+info".equals(args
[i
])) {
135 if (sourceString
== null) {
136 sourceString
= args
[i
];
144 } else if (chapString
== null) {
145 chapString
= args
[i
];
151 if (urlString
== null) {
153 } else if (chapString
== null) {
154 chapString
= args
[i
];
163 exitCode
= setReaderType(args
[i
]);
164 action
= MainAction
.START
;
167 exitCode
= 255; // not supposed to be selected by user
170 exitCode
= 255; // no arguments for this option
174 port
= Integer
.parseInt(args
[i
]);
182 } else if (port
== null) {
183 port
= Integer
.parseInt(args
[i
]);
185 BasicReader
.setDefaultLibrary(new RemoteLibrary(host
,
187 } catch (IOException e
) {
190 action
= MainAction
.START
;
198 final Progress mainProgress
= new Progress(0, 80);
199 mainProgress
.addProgressListener(new Progress
.ProgressListener() {
200 private int current
= mainProgress
.getMin();
202 public void progress(Progress progress
, String name
) {
203 int diff
= progress
.getProgress() - current
;
206 StringBuilder builder
= new StringBuilder();
207 for (int i
= 0; i
< diff
; i
++) {
211 System
.err
.print(builder
.toString());
213 if (progress
.isDone()) {
214 System
.err
.println("");
218 Progress pg
= new Progress();
219 mainProgress
.addProgress(pg
, mainProgress
.getMax());
221 VersionCheck updates
= VersionCheck
.check();
222 if (updates
.isNewVersionAvailable()) {
223 // Sent to syserr so not to cause problem if one tries to capture a
224 // story content in text mode
226 .println("A new version of the program is available at https://github.com/nikiroo/fanfix/releases");
227 System
.err
.println("");
228 for (Version v
: updates
.getNewer()) {
229 System
.err
.println("\tVersion " + v
);
230 System
.err
.println("\t-------------");
231 System
.err
.println("");
232 for (String item
: updates
.getChanges().get(v
)) {
233 System
.err
.println("\t- " + item
);
235 System
.err
.println("");
239 if (exitCode
!= 255) {
242 exitCode
= imprt(urlString
, pg
);
243 updates
.ok(); // we consider it read
246 exitCode
= export(luid
, sourceString
, target
, pg
);
247 updates
.ok(); // we consider it read
250 exitCode
= convert(urlString
, sourceString
, target
,
251 plusInfo
== null ?
false : plusInfo
, pg
);
252 updates
.ok(); // we consider it read
255 exitCode
= list(sourceString
);
258 exitCode
= read(luid
, chapString
, true);
261 exitCode
= read(urlString
, chapString
, false);
272 .println(String
.format("Fanfix version %s"
273 + "\nhttps://github.com/nikiroo/fanfix/"
274 + "\n\tWritten by Nikiroo",
275 Version
.getCurrentVersion()));
276 updates
.ok(); // we consider it read
279 BasicReader
.getReader().browse(null);
287 Server server
= new RemoteLibraryServer(port
);
289 System
.out
.println("Remote server started on: " + port
);
290 } catch (IOException e
) {
300 if (exitCode
== 255) {
305 System
.exit(exitCode
);
310 * Import the given resource into the {@link Library}.
313 * the resource to import
315 * the optional progress reporter
317 * @return the exit return code (0 = success)
319 public static int imprt(String urlString
, Progress pg
) {
321 Story story
= Instance
.getLibrary().imprt(
322 BasicReader
.getUrl(urlString
), pg
);
323 System
.out
.println(story
.getMeta().getLuid() + ": \""
324 + story
.getMeta().getTitle() + "\" imported.");
325 } catch (IOException e
) {
334 * Export the {@link Story} from the {@link Library} to the given target.
339 * the {@link OutputType} to use
343 * the optional progress reporter
345 * @return the exit return code (0 = success)
347 public static int export(String luid
, String typeString
, String target
,
349 OutputType type
= OutputType
.valueOfNullOkUC(typeString
);
351 Instance
.syserr(new Exception(trans(StringId
.OUTPUT_DESC
,
357 Instance
.getLibrary().export(luid
, type
, target
, pg
);
358 } catch (IOException e
) {
367 * List the stories of the given source from the {@link Library} (unless
368 * NULL is passed, in which case all stories will be listed).
371 * the source to list the known stories of, or NULL to list all
374 * @return the exit return code (0 = success)
376 private static int list(String source
) {
377 BasicReader
.getReader().browse(source
);
382 * Start the CLI reader for this {@link Story}.
385 * the LUID of the {@link Story} in the {@link Library} <b>or</b>
386 * the {@link Story} {@link URL}
388 * which {@link Chapter} to read (starting at 1), or NULL to get
389 * the {@link Story} description
391 * TRUE if the source is the {@link Story} LUID, FALSE if it is a
394 * @return the exit return code (0 = success)
396 private static int read(String story
, String chapString
, boolean library
) {
398 BasicReader reader
= BasicReader
.getReader();
400 reader
.setStory(story
, null);
402 reader
.setStory(BasicReader
.getUrl(story
), null);
405 if (chapString
!= null) {
407 reader
.read(Integer
.parseInt(chapString
));
408 } catch (NumberFormatException e
) {
409 Instance
.syserr(new IOException(
410 "Chapter number cannot be parsed: " + chapString
, e
));
416 } catch (IOException e
) {
425 * Convert the {@link Story} into another format.
428 * the source {@link Story} to convert
430 * the {@link OutputType} to convert to
434 * TRUE to also export the cover and info file, even if the given
435 * {@link OutputType} does not usually save them
437 * the optional progress reporter
439 * @return the exit return code (0 = success)
441 private static int convert(String urlString
, String typeString
,
442 String target
, boolean infoCover
, Progress pg
) {
445 String sourceName
= urlString
;
447 URL source
= BasicReader
.getUrl(urlString
);
448 sourceName
= source
.toString();
449 if (source
.toString().startsWith("file://")) {
450 sourceName
= sourceName
.substring("file://".length());
453 OutputType type
= OutputType
.valueOfAllOkUC(typeString
);
455 Instance
.syserr(new IOException(trans(
456 StringId
.ERR_BAD_OUTPUT_TYPE
, typeString
)));
461 BasicSupport support
= BasicSupport
.getSupport(source
);
463 if (support
!= null) {
464 Progress pgIn
= new Progress();
465 Progress pgOut
= new Progress();
468 pg
.addProgress(pgIn
, 1);
469 pg
.addProgress(pgOut
, 1);
472 Story story
= support
.process(source
, pgIn
);
474 target
= new File(target
).getAbsolutePath();
475 BasicOutput
.getOutput(type
, infoCover
).process(
476 story
, target
, pgOut
);
477 } catch (IOException e
) {
478 Instance
.syserr(new IOException(trans(
479 StringId
.ERR_SAVING
, target
), e
));
483 Instance
.syserr(new IOException(trans(
484 StringId
.ERR_NOT_SUPPORTED
, source
)));
488 } catch (IOException e
) {
489 Instance
.syserr(new IOException(trans(StringId
.ERR_LOADING
,
494 } catch (MalformedURLException e
) {
495 Instance
.syserr(new IOException(trans(StringId
.ERR_BAD_URL
,
504 * Simple shortcut method to call {link Instance#getTrans()#getString()}.
507 * the ID to translate
509 * @return the translated result
511 private static String
trans(StringId id
, Object
... params
) {
512 return Instance
.getTrans().getString(id
, params
);
516 * Display the correct syntax of the program to the user to stdout, or an
517 * error message if the syntax used was wrong on stderr.
520 * TRUE to show the syntax help, FALSE to show "syntax error"
522 private static void syntax(boolean showHelp
) {
524 StringBuilder builder
= new StringBuilder();
525 for (SupportType type
: SupportType
.values()) {
526 builder
.append(trans(StringId
.ERR_SYNTAX_TYPE
, type
.toString(),
528 builder
.append('\n');
531 String typesIn
= builder
.toString();
532 builder
.setLength(0);
534 for (OutputType type
: OutputType
.values()) {
535 builder
.append(trans(StringId
.ERR_SYNTAX_TYPE
, type
.toString(),
536 type
.getDesc(true)));
537 builder
.append('\n');
540 String typesOut
= builder
.toString();
542 System
.out
.println(trans(StringId
.HELP_SYNTAX
, typesIn
, typesOut
));
544 System
.err
.println(trans(StringId
.ERR_SYNTAX
));
549 * Set the default reader type for this session only (it can be changed in
550 * the configuration file, too, but this value will override it).
552 * @param readerTypeString
555 private static int setReaderType(String readerTypeString
) {
557 ReaderType readerType
= ReaderType
.valueOf(readerTypeString
559 BasicReader
.setDefaultReaderType(readerType
);
561 } catch (IllegalArgumentException e
) {
562 Instance
.syserr(new IOException("Unknown reader type: "
563 + readerTypeString
, e
));