* Known environment variables: *
+ *
+ * If specific actions were asked (with correct parameters), they will be + * forwarded to the different protected methods that you can override. + *
+ * At the end of the method, {@link Main#exit(int)} will be called; by
+ * default, it calls {@link System#exit(int)} if the status is not 0.
+ *
+ * @param args
+ * the arguments received from the system
+ */
+ public void start(String [] args) {
+ // Only one line, but very important:
+ Instance.init();
+
+ String urlString = null;
+ String luid = null;
+ String sourceString = null;
+ String titleString = null;
+ String authorString = null;
+ String chapString = null;
+ String target = null;
+ String key = null;
+ MainAction action = MainAction.START;
+ Boolean plusInfo = null;
+ String host = null;
+ Integer port = null;
+ SupportType searchOn = null;
+ String search = null;
+ List
+ * You will probably want to override that one if you offer a user
+ * interface.
+ *
+ * @throws IOException
+ * in case of I/O error
+ */
+ protected void start() throws IOException {
+ new CliReader().listBooks(null);
}
/**
- * Return an {@link URL} from this {@link String}, be it a file path or an
- * actual {@link URL}.
+ * Will check if updates are available, synchronously.
+ *
+ * For this, it will simply forward the call to
+ * {@link Main#checkUpdates(String)} with a value of "nikiroo/fanfix".
+ *
+ * You may want to override it so you call the forward method with the right
+ * parameters (or also if you want it to be asynchronous).
*
- * @param sourceString
- * the source
+ * @return the newer version information or NULL if nothing new
+ */
+ protected VersionCheck checkUpdates() {
+ return checkUpdates("nikiroo/fanfix");
+ }
+
+ /**
+ * Will check if updates are available on a specific GitHub project.
+ *
+ * Will be called by {@link Main#checkUpdates()}, but if you override that
+ * one you mall call it with another project.
*
- * @return the corresponding {@link URL}
+ * @param githubProject
+ * the GitHub project, for instance "nikiroo/fanfix"
*
- * @throws MalformedURLException
- * if this is neither a file nor a conventional {@link URL}
+ * @return the newer version information or NULL if nothing new
*/
- private static URL getUrl(String sourceString) throws MalformedURLException {
- if (sourceString == null || sourceString.isEmpty()) {
- throw new MalformedURLException("Empty url");
- }
-
- URL source = null;
+ protected VersionCheck checkUpdates(String githubProject) {
try {
- source = new URL(sourceString);
- } catch (MalformedURLException e) {
- File sourceFile = new File(sourceString);
- source = sourceFile.toURI().toURL();
+ VersionCheck updates = VersionCheck.check(githubProject,
+ Instance.getInstance().getTrans().getLocale());
+ if (updates.isNewVersionAvailable()) {
+ notifyUpdates(updates);
+ return updates;
+ }
+ } catch (IOException e) {
+ // Maybe no internet. Do not report any update.
}
- return source;
+ return null;
}
/**
- * Import the given resource into the {@link Library}.
+ * Notify the user about available updates.
+ *
+ * Will only be called when a version is available.
+ *
+ * Note that you can call {@link Instance#setVersionChecked()} on it if the
+ * user has read the information (by default, it is marked read only on
+ * certain other actions).
+ *
+ * @param updates
+ * the new version information
+ */
+ protected void notifyUpdates(VersionCheck updates) {
+ // Sent to syserr so not to cause problem if one tries to capture a
+ // story content in text mode
+ System.err.println(
+ "A new version of the program is available at https://github.com/nikiroo/fanfix/releases");
+ System.err.println("");
+ for (Version v : updates.getNewer()) {
+ System.err.println("\tVersion " + v);
+ System.err.println("\t-------------");
+ System.err.println("");
+ for (String it : updates.getChanges().get(v)) {
+ System.err.println("\t- " + it);
+ }
+ System.err.println("");
+ }
+ }
+
+ /**
+ * Import the given resource into the {@link LocalLibrary}.
*
- * @param sourceString
+ * @param url
* the resource to import
+ * @param pg
+ * the optional progress reporter
*
* @return the exit return code (0 = success)
*/
- private static int imprt(String sourceString) {
+ protected static int imprt(URL url, Progress pg) {
try {
- Story story = Instance.getLibrary().imprt(getUrl(sourceString));
- System.out.println(story.getMeta().getLuid() + ": \""
- + story.getMeta().getTitle() + "\" imported.");
+ MetaData meta = Instance.getInstance().getLibrary().imprt(url, pg);
+ System.out.println(meta.getLuid() + ": \"" + meta.getTitle() + "\" imported.");
} catch (IOException e) {
- Instance.syserr(e);
+ Instance.getInstance().getTraceHandler().error(e);
return 1;
}
@@ -139,95 +818,81 @@ public class Main {
}
/**
- * Export the {@link Story} from the {@link Library} to the given target.
+ * Export the {@link Story} from the {@link LocalLibrary} to the given
+ * target.
*
- * @param sourceString
+ * @param luid
* the story LUID
- * @param typeString
+ * @param type
* the {@link OutputType} to use
* @param target
* the target
+ * @param pg
+ * the optional progress reporter
*
* @return the exit return code (0 = success)
*/
- private static int export(String sourceString, String typeString,
- String target) {
- OutputType type = OutputType.valueOfNullOkUC(typeString);
- if (type == null) {
- Instance.syserr(new Exception(trans(StringId.OUTPUT_DESC,
- typeString)));
- return 1;
- }
-
+ protected static int export(String luid, OutputType type, String target,
+ Progress pg) {
try {
- Story story = Instance.getLibrary().imprt(new URL(sourceString));
- Instance.getLibrary().export(story.getMeta().getLuid(), type,
- target);
+ Instance.getInstance().getLibrary().export(luid, type, target, pg);
} catch (IOException e) {
- Instance.syserr(e);
+ Instance.getInstance().getTraceHandler().error(e);
return 4;
}
return 0;
}
-
+
/**
- * List the stories of the given type from the {@link Library} (unless NULL
- * is passed, in which case all stories will be listed).
+ * List the stories of the given source from the {@link LocalLibrary}
+ * (unless NULL is passed, in which case all stories will be listed).
*
- * @param typeString
- * the {@link SupportType} to list the known stories of, or NULL
- * to list all stories
+ * @param source
+ * the source to list the known stories of, or NULL to list all
+ * stories
*
* @return the exit return code (0 = success)
*/
- private static int list(String typeString) {
- SupportType type = null;
+ protected int list(String source) {
try {
- type = SupportType.valueOfNullOkUC(typeString);
- } catch (Exception e) {
- Instance.syserr(new Exception(
- trans(StringId.INPUT_DESC, typeString), e));
- return 1;
+ new CliReader().listBooks(source);
+ } catch (IOException e) {
+ Instance.getInstance().getTraceHandler().error(e);
+ return 66;
}
- CliReader.list(type);
-
return 0;
}
/**
- * Start the CLI reader for this {@link Story}.
+ * Start the current reader for this {@link Story}.
*
* @param story
- * the LUID of the {@link Story} in the {@link Library} or
- * the {@link Story} {@link URL}
+ * the story to read
* @param chap
* which {@link Chapter} to read (starting at 1), or NULL to get
* the {@link Story} description
- * @param library
- * TRUE if the source is the {@link Story} LUID, FALSE if it is a
- * {@link URL}
*
* @return the exit return code (0 = success)
*/
- private static int read(String story, String chap, boolean library) {
- try {
- CliReader reader;
- if (library) {
- reader = new CliReader(story);
- } else {
- reader = new CliReader(getUrl(story));
- }
-
- if (chap != null) {
- reader.read(Integer.parseInt(chap));
- } else {
- reader.read();
+ protected int read(Story story, Integer chap) {
+ if (story != null) {
+ try {
+ if (chap == null) {
+ new CliReader().listChapters(story);
+ } else {
+ new CliReader().printChapter(story, chap);
+ }
+ } catch (IOException e) {
+ Instance.getInstance().getTraceHandler()
+ .error(new IOException("Failed to read book", e));
+ return 2;
}
- } catch (IOException e) {
- Instance.syserr(e);
- return 1;
+ } else {
+ Instance.getInstance().getTraceHandler()
+ .error("Cannot find book: " + story);
+ return 2;
}
return 0;
@@ -236,66 +901,72 @@ public class Main {
/**
* Convert the {@link Story} into another format.
*
- * @param sourceString
+ * @param urlString
* the source {@link Story} to convert
- * @param typeString
+ * @param type
* the {@link OutputType} to convert to
- * @param filename
+ * @param target
* the target file
* @param infoCover
* TRUE to also export the cover and info file, even if the given
* {@link OutputType} does not usually save them
+ * @param pg
+ * the optional progress reporter
*
* @return the exit return code (0 = success)
*/
- private static int convert(String sourceString, String typeString,
- String filename, boolean infoCover) {
+ protected int convert(String urlString, OutputType type,
+ String target, boolean infoCover, Progress pg) {
int exitCode = 0;
- String sourceName = sourceString;
+ Instance.getInstance().getTraceHandler().trace("Convert: " + urlString);
+ String sourceName = urlString;
try {
- URL source = getUrl(sourceString);
+ URL source = BasicReader.getUrl(urlString);
sourceName = source.toString();
- if (source.toString().startsWith("file://")) {
+ if (sourceName.startsWith("file://")) {
sourceName = sourceName.substring("file://".length());
}
- OutputType type = OutputType.valueOfAllOkUC(typeString);
- if (type == null) {
- Instance.syserr(new IOException(trans(
- StringId.ERR_BAD_OUTPUT_TYPE, typeString)));
-
- exitCode = 2;
- } else {
- try {
- BasicSupport support = BasicSupport.getSupport(source);
- if (support != null) {
- Story story = support.process(source);
+ try {
+ BasicSupport support = BasicSupport.getSupport(source);
- try {
- filename = new File(filename).getAbsolutePath();
- BasicOutput.getOutput(type, infoCover).process(
- story, filename);
- } catch (IOException e) {
- Instance.syserr(new IOException(trans(
- StringId.ERR_SAVING, filename), e));
- exitCode = 5;
- }
- } else {
- Instance.syserr(new IOException(trans(
- StringId.ERR_NOT_SUPPORTED, source)));
+ if (support != null) {
+ Instance.getInstance().getTraceHandler()
+ .trace("Support found: " + support.getClass());
+ Progress pgIn = new Progress();
+ Progress pgOut = new Progress();
+ if (pg != null) {
+ pg.setMax(2);
+ pg.addProgress(pgIn, 1);
+ pg.addProgress(pgOut, 1);
+ }
- exitCode = 4;
+ Story story = support.process(pgIn);
+ try {
+ target = new File(target).getAbsolutePath();
+ BasicOutput.getOutput(type, infoCover, infoCover)
+ .process(story, target, pgOut);
+ } catch (IOException e) {
+ Instance.getInstance().getTraceHandler()
+ .error(new IOException(
+ trans(StringId.ERR_SAVING, target), e));
+ exitCode = 5;
}
- } catch (IOException e) {
- Instance.syserr(new IOException(trans(StringId.ERR_LOADING,
- sourceName), e));
- exitCode = 3;
+ } else {
+ Instance.getInstance().getTraceHandler()
+ .error(new IOException(
+ trans(StringId.ERR_NOT_SUPPORTED, source)));
+
+ exitCode = 4;
}
+ } catch (IOException e) {
+ Instance.getInstance().getTraceHandler().error(new IOException(
+ trans(StringId.ERR_LOADING, sourceName), e));
+ exitCode = 3;
}
} catch (MalformedURLException e) {
- Instance.syserr(new IOException(trans(StringId.ERR_BAD_URL,
- sourceName), e));
+ Instance.getInstance().getTraceHandler().error(new IOException(trans(StringId.ERR_BAD_URL, sourceName), e));
exitCode = 1;
}
@@ -303,39 +974,168 @@ public class Main {
}
/**
- * Simple shortcut method to call {link Instance#getTrans()#getString()}.
+ * Display the correct syntax of the program to the user to stdout, or an
+ * error message if the syntax used was wrong on stderr.
*
- * @param id
- * the ID to translate
+ * @param showHelp
+ * TRUE to show the syntax help, FALSE to show "syntax error"
+ */
+ protected void syntax(boolean showHelp) {
+ if (showHelp) {
+ StringBuilder builder = new StringBuilder();
+ for (SupportType type : SupportType.values()) {
+ builder.append(trans(StringId.ERR_SYNTAX_TYPE, type.toString(),
+ type.getDesc()));
+ builder.append('\n');
+ }
+
+ String typesIn = builder.toString();
+ builder.setLength(0);
+
+ for (OutputType type : OutputType.values()) {
+ builder.append(trans(StringId.ERR_SYNTAX_TYPE, type.toString(),
+ type.getDesc(true)));
+ builder.append('\n');
+ }
+
+ String typesOut = builder.toString();
+
+ System.out.println(trans(StringId.HELP_SYNTAX, typesIn, typesOut));
+ } else {
+ System.err.println(trans(StringId.ERR_SYNTAX));
+ }
+ }
+
+ /**
+ * Starts a search operation (i.e., list the available web sites we can
+ * search on).
*
- * @return the translated result
+ * @throws IOException
+ * in case of I/O errors
*/
- private static String trans(StringId id, Object... params) {
- return Instance.getTrans().getString(id, params);
+ protected void search() throws IOException {
+ new CliReader().listSearchables();
}
/**
- * Display the correct syntax of the program to the user.
+ * Search for books by keywords on the given supported web site.
+ *
+ * @param searchOn
+ * the web site to search on
+ * @param search
+ * the keyword to look for
+ * @param page
+ * the page of results to get, or 0 to inquire about the number
+ * of pages
+ * @param item
+ * the index of the book we are interested by, or 0 to query
+ * about how many books are in that page of results
+ *
+ * @throws IOException
+ * in case of I/O error
*/
- private static void syntax() {
- StringBuilder builder = new StringBuilder();
- for (SupportType type : SupportType.values()) {
- builder.append(trans(StringId.ERR_SYNTAX_TYPE, type.toString(),
- type.getDesc()));
- builder.append('\n');
- }
+ protected void searchKeywords(SupportType searchOn, String search,
+ int page, Integer item) throws IOException {
+ new CliReader().searchBooksByKeyword(searchOn, search, page, item);
+ }
- String typesIn = builder.toString();
- builder.setLength(0);
+ /**
+ * Search for books by tags on the given supported web site.
+ *
+ * @param searchOn
+ * the web site to search on
+ * @param page
+ * the page of results to get, or 0 to inquire about the number
+ * of pages
+ * @param item
+ * the index of the book we are interested by, or 0 to query
+ * about how many books are in that page of results
+ * @param tags
+ * the tags to look for
+ *
+ * @throws IOException
+ * in case of I/O error
+ */
+ protected void searchTags(SupportType searchOn, Integer page, Integer item,
+ Integer[] tags) throws IOException {
+ new CliReader().searchBooksByTag(searchOn, page, item, tags);
+ }
- for (OutputType type : OutputType.values()) {
- builder.append(trans(StringId.ERR_SYNTAX_TYPE, type.toString(),
- type.getDesc()));
- builder.append('\n');
+ /**
+ * Start a Fanfix server.
+ *
+ * @throws IOException
+ * in case of I/O errors
+ * @throws SSLException
+ * when the key was not accepted
+ */
+ private void startServer() throws IOException {
+ String mode = Instance.getInstance().getConfig()
+ .getString(Config.SERVER_MODE, "fanfix");
+ if (mode.equals("fanfix")) {
+ RemoteLibraryServer server = new RemoteLibraryServer();
+ server.setTraceHandler(Instance.getInstance().getTraceHandler());
+ server.run();
+ } else if (mode.equals("http")) {
+ WebLibraryServer server = new WebLibraryServer(false);
+ server.setTraceHandler(Instance.getInstance().getTraceHandler());
+ server.run();
+ } else if (mode.equals("https")) {
+ WebLibraryServer server = new WebLibraryServer(true);
+ server.setTraceHandler(Instance.getInstance().getTraceHandler());
+ server.run();
+ } else {
+ throw new IOException("Unknown server mode: " + mode);
}
+ }
- String typesOut = builder.toString();
+ /**
+ * Stop a running Fanfix server.
+ *
+ * @param key
+ * the key to contact the Fanfix server
+ * @param host
+ * the host on which it runs
+ * @param port
+ * the port on which it runs
+ *
+ * @throws IOException
+ * in case of I/O errors
+ * @throws SSLException
+ * when the key was not accepted
+ */
+ private void stopServer(String key, String host, int port)
+ throws IOException, SSLException {
+ if (host.startsWith("http://") || host.startsWith("https://")) {
+ new WebLibrary(key, host, port).stop();
+ } else {
+ new RemoteLibrary(key, host, port).stop();
+ }
+ }
- System.err.println(trans(StringId.ERR_SYNTAX, typesIn, typesOut));
+ /**
+ * We are done and ready to exit.
+ *
+ * By default, it will call {@link System#exit(int)} if the status is not 0.
+ *
+ * @param status
+ * the exit status
+ */
+ protected void exit(int status) {
+ if (status != 0) {
+ System.exit(status);
+ }
+ }
+
+ /**
+ * Simple shortcut method to call {link Instance#getTrans()#getString()}.
+ *
+ * @param id
+ * the ID to translate
+ *
+ * @return the translated result
+ */
+ static private String trans(StringId id, Object... params) {
+ return Instance.getInstance().getTrans().getString(id, params);
}
}