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
.BasicSupport
.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 File remoteCacheDir
= Instance
.getRemoteDir(host
);
203 BasicLibrary lib
= new RemoteLibrary(key
, host
, port
);
204 lib
= new CacheLibrary(remoteCacheDir
, lib
);
206 BasicReader
.setDefaultLibrary(lib
);
208 action
= MainAction
.START
;
216 final Progress mainProgress
= new Progress(0, 80);
217 mainProgress
.addProgressListener(new Progress
.ProgressListener() {
218 private int current
= mainProgress
.getMin();
221 public void progress(Progress progress
, String name
) {
222 int diff
= progress
.getProgress() - current
;
225 StringBuilder builder
= new StringBuilder();
226 for (int i
= 0; i
< diff
; i
++) {
230 System
.err
.print(builder
.toString());
232 if (progress
.isDone()) {
233 System
.err
.println("");
237 Progress pg
= new Progress();
238 mainProgress
.addProgress(pg
, mainProgress
.getMax());
240 VersionCheck updates
= VersionCheck
.check();
241 if (updates
.isNewVersionAvailable()) {
242 // Sent to syserr so not to cause problem if one tries to capture a
243 // story content in text mode
245 .println("A new version of the program is available at https://github.com/nikiroo/fanfix/releases");
246 System
.err
.println("");
247 for (Version v
: updates
.getNewer()) {
248 System
.err
.println("\tVersion " + v
);
249 System
.err
.println("\t-------------");
250 System
.err
.println("");
251 for (String item
: updates
.getChanges().get(v
)) {
252 System
.err
.println("\t- " + item
);
254 System
.err
.println("");
258 if (exitCode
!= 255) {
261 exitCode
= imprt(urlString
, pg
);
262 updates
.ok(); // we consider it read
265 exitCode
= export(luid
, sourceString
, target
, pg
);
266 updates
.ok(); // we consider it read
269 exitCode
= convert(urlString
, sourceString
, target
,
270 plusInfo
== null ?
false : plusInfo
, pg
);
271 updates
.ok(); // we consider it read
274 if (BasicReader
.getReader() == null) {
275 Instance
.getTraceHandler()
276 .error(new Exception(
277 "No reader type has been configured"));
281 exitCode
= list(sourceString
);
284 if (BasicReader
.getReader() == null) {
285 Instance
.getTraceHandler()
286 .error(new Exception(
287 "No reader type has been configured"));
291 exitCode
= read(luid
, chapString
, true);
294 if (BasicReader
.getReader() == null) {
295 Instance
.getTraceHandler()
296 .error(new Exception(
297 "No reader type has been configured"));
301 exitCode
= read(urlString
, chapString
, false);
312 .println(String
.format("Fanfix version %s"
313 + "\nhttps://github.com/nikiroo/fanfix/"
314 + "\n\tWritten by Nikiroo",
315 Version
.getCurrentVersion()));
316 updates
.ok(); // we consider it read
319 if (BasicReader
.getReader() == null) {
320 Instance
.getTraceHandler()
321 .error(new Exception(
322 "No reader type has been configured"));
326 BasicReader
.getReader().browse(null);
334 ServerObject server
= new RemoteLibraryServer(key
, port
);
335 server
.setTraceHandler(Instance
.getTraceHandler());
337 } catch (IOException e
) {
338 Instance
.getTraceHandler().error(e
);
347 new RemoteLibrary(key
, host
, port
).exit();
350 exitCode
= 255; // should not be reachable (REMOTE -> START)
355 if (exitCode
== 255) {
360 System
.exit(exitCode
);
365 * Import the given resource into the {@link LocalLibrary}.
368 * the resource to import
370 * the optional progress reporter
372 * @return the exit return code (0 = success)
374 public static int imprt(String urlString
, Progress pg
) {
376 Story story
= Instance
.getLibrary().imprt(
377 BasicReader
.getUrl(urlString
), pg
);
378 System
.out
.println(story
.getMeta().getLuid() + ": \""
379 + story
.getMeta().getTitle() + "\" imported.");
380 } catch (IOException e
) {
381 Instance
.getTraceHandler().error(e
);
389 * Export the {@link Story} from the {@link LocalLibrary} to the given
395 * the {@link OutputType} to use
399 * the optional progress reporter
401 * @return the exit return code (0 = success)
403 public static int export(String luid
, String typeString
, String target
,
405 OutputType type
= OutputType
.valueOfNullOkUC(typeString
, null);
407 Instance
.getTraceHandler().error(
408 new Exception(trans(StringId
.OUTPUT_DESC
, typeString
)));
413 Instance
.getLibrary().export(luid
, type
, target
, pg
);
414 } catch (IOException e
) {
415 Instance
.getTraceHandler().error(e
);
423 * List the stories of the given source from the {@link LocalLibrary}
424 * (unless NULL is passed, in which case all stories will be listed).
427 * the source to list the known stories of, or NULL to list all
430 * @return the exit return code (0 = success)
432 private static int list(String source
) {
433 List
<MetaData
> stories
;
434 stories
= BasicReader
.getReader().getLibrary().getListBySource(source
);
436 for (MetaData story
: stories
) {
438 if (story
.getAuthor() != null && !story
.getAuthor().isEmpty()) {
439 author
= " (" + story
.getAuthor() + ")";
442 System
.out
.println(story
.getLuid() + ": " + story
.getTitle()
449 * Start the CLI reader for this {@link Story}.
452 * the LUID of the {@link Story} in the {@link LocalLibrary}
453 * <b>or</b> the {@link Story} {@link URL}
455 * which {@link Chapter} to read (starting at 1), or NULL to get
456 * the {@link Story} description
458 * TRUE if the source is the {@link Story} LUID, FALSE if it is a
461 * @return the exit return code (0 = success)
463 private static int read(String story
, String chapString
, boolean library
) {
465 Reader reader
= BasicReader
.getReader();
467 reader
.setMeta(story
);
469 reader
.setMeta(BasicReader
.getUrl(story
), null);
472 if (chapString
!= null) {
474 reader
.setChapter(Integer
.parseInt(chapString
));
476 } catch (NumberFormatException e
) {
477 Instance
.getTraceHandler().error(
478 new IOException("Chapter number cannot be parsed: "
485 } catch (IOException e
) {
486 Instance
.getTraceHandler().error(e
);
494 * Convert the {@link Story} into another format.
497 * the source {@link Story} to convert
499 * the {@link OutputType} to convert to
503 * TRUE to also export the cover and info file, even if the given
504 * {@link OutputType} does not usually save them
506 * the optional progress reporter
508 * @return the exit return code (0 = success)
510 private static int convert(String urlString
, String typeString
,
511 String target
, boolean infoCover
, Progress pg
) {
514 String sourceName
= urlString
;
516 URL source
= BasicReader
.getUrl(urlString
);
517 sourceName
= source
.toString();
518 if (source
.toString().startsWith("file://")) {
519 sourceName
= sourceName
.substring("file://".length());
522 OutputType type
= OutputType
.valueOfAllOkUC(typeString
, null);
524 Instance
.getTraceHandler().error(
525 new IOException(trans(StringId
.ERR_BAD_OUTPUT_TYPE
,
531 BasicSupport support
= BasicSupport
.getSupport(source
);
533 if (support
!= null) {
534 Progress pgIn
= new Progress();
535 Progress pgOut
= new Progress();
538 pg
.addProgress(pgIn
, 1);
539 pg
.addProgress(pgOut
, 1);
542 Story story
= support
.process(source
, pgIn
);
544 target
= new File(target
).getAbsolutePath();
545 BasicOutput
.getOutput(type
, infoCover
, infoCover
)
546 .process(story
, target
, pgOut
);
547 } catch (IOException e
) {
548 Instance
.getTraceHandler().error(
549 new IOException(trans(StringId
.ERR_SAVING
,
554 Instance
.getTraceHandler().error(
555 new IOException(trans(
556 StringId
.ERR_NOT_SUPPORTED
, source
)));
560 } catch (IOException e
) {
561 Instance
.getTraceHandler().error(
562 new IOException(trans(StringId
.ERR_LOADING
,
567 } catch (MalformedURLException e
) {
568 Instance
.getTraceHandler()
569 .error(new IOException(trans(StringId
.ERR_BAD_URL
,
578 * Simple shortcut method to call {link Instance#getTrans()#getString()}.
581 * the ID to translate
583 * @return the translated result
585 private static String
trans(StringId id
, Object
... params
) {
586 return Instance
.getTrans().getString(id
, params
);
590 * Display the correct syntax of the program to the user to stdout, or an
591 * error message if the syntax used was wrong on stderr.
594 * TRUE to show the syntax help, FALSE to show "syntax error"
596 private static void syntax(boolean showHelp
) {
598 StringBuilder builder
= new StringBuilder();
599 for (SupportType type
: SupportType
.values()) {
600 builder
.append(trans(StringId
.ERR_SYNTAX_TYPE
, type
.toString(),
602 builder
.append('\n');
605 String typesIn
= builder
.toString();
606 builder
.setLength(0);
608 for (OutputType type
: OutputType
.values()) {
609 builder
.append(trans(StringId
.ERR_SYNTAX_TYPE
, type
.toString(),
610 type
.getDesc(true)));
611 builder
.append('\n');
614 String typesOut
= builder
.toString();
616 System
.out
.println(trans(StringId
.HELP_SYNTAX
, typesIn
, typesOut
));
618 System
.err
.println(trans(StringId
.ERR_SYNTAX
));
623 * Set the default reader type for this session only (it can be changed in
624 * the configuration file, too, but this value will override it).
626 * @param readerTypeString
629 private static int setReaderType(String readerTypeString
) {
631 ReaderType readerType
= ReaderType
.valueOf(readerTypeString
633 BasicReader
.setDefaultReaderType(readerType
);
635 } catch (IllegalArgumentException e
) {
636 Instance
.getTraceHandler().error(
637 new IOException("Unknown reader type: " + readerTypeString
,