X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;f=src%2Fbe%2Fnikiroo%2Ffanfix%2FMain.java;h=7be305a0977abc17c0fd227f10d1f18c97dca70a;hb=d00a4a038876ff303af993d5c1c059938d6feac1;hp=995251d16d0ee7ca6a0438ce21c8268efa6c51cc;hpb=8141d7ac9891898b77a355bfa152de9f3dd76e7e;p=nikiroo-utils.git diff --git a/src/be/nikiroo/fanfix/Main.java b/src/be/nikiroo/fanfix/Main.java index 995251d..7be305a 100644 --- a/src/be/nikiroo/fanfix/Main.java +++ b/src/be/nikiroo/fanfix/Main.java @@ -7,6 +7,9 @@ import java.net.URL; import java.util.ArrayList; import java.util.List; +import javax.net.ssl.SSLException; + +import be.nikiroo.fanfix.bundles.Config; import be.nikiroo.fanfix.bundles.StringId; import be.nikiroo.fanfix.data.Chapter; import be.nikiroo.fanfix.data.MetaData; @@ -16,17 +19,17 @@ import be.nikiroo.fanfix.library.CacheLibrary; import be.nikiroo.fanfix.library.LocalLibrary; import be.nikiroo.fanfix.library.RemoteLibrary; import be.nikiroo.fanfix.library.RemoteLibraryServer; +import be.nikiroo.fanfix.library.WebLibraryServer; import be.nikiroo.fanfix.output.BasicOutput; import be.nikiroo.fanfix.output.BasicOutput.OutputType; import be.nikiroo.fanfix.reader.BasicReader; -import be.nikiroo.fanfix.reader.Reader; -import be.nikiroo.fanfix.reader.Reader.ReaderType; +import be.nikiroo.fanfix.reader.CliReader; import be.nikiroo.fanfix.searchable.BasicSearchable; import be.nikiroo.fanfix.supported.BasicSupport; import be.nikiroo.fanfix.supported.SupportType; import be.nikiroo.utils.Progress; import be.nikiroo.utils.Version; -import be.nikiroo.utils.serial.server.ServerObject; +import be.nikiroo.utils.VersionCheck; /** * Main program entry point. @@ -35,7 +38,7 @@ import be.nikiroo.utils.serial.server.ServerObject; */ public class Main { private enum MainAction { - IMPORT, EXPORT, CONVERT, READ, READ_URL, LIST, HELP, SET_READER, START, VERSION, SERVER, STOP_SERVER, REMOTE, SET_SOURCE, SET_TITLE, SET_AUTHOR, SEARCH, SEARCH_TAG + IMPORT, EXPORT, CONVERT, READ, READ_URL, LIST, HELP, START, VERSION, SERVER, STOP_SERVER, REMOTE, SET_SOURCE, SET_TITLE, SET_AUTHOR, SEARCH, SEARCH_TAG } /** @@ -73,19 +76,35 @@ public class Main { *
+ * 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; @@ -108,6 +127,9 @@ public class Main { int exitCode = 0; for (int i = 0; exitCode == 0 && i < args.length; i++) { + if (args[i] == null) + continue; + // Action (--) handling: if (!noMoreActions && args[i].startsWith("--")) { if (args[i].equals("--")) { @@ -117,9 +139,8 @@ public class Main { action = MainAction.valueOf(args[i].substring(2) .toUpperCase().replace("-", "_")); } catch (Exception e) { - Instance.getTraceHandler().error( - new IllegalArgumentException("Unknown action: " - + args[i], e)); + Instance.getInstance().getTraceHandler() + .error(new IllegalArgumentException("Unknown action: " + args[i], e)); exitCode = 255; } } @@ -220,15 +241,13 @@ public class Main { searchOn = SupportType.valueOfAllOkUC(args[i]); if (searchOn == null) { - Instance.getTraceHandler().error( - "Website not known: <" + args[i] + ">"); + Instance.getInstance().getTraceHandler().error("Website not known: <" + args[i] + ">"); exitCode = 41; break; } if (BasicSearchable.getSearchable(searchOn) == null) { - Instance.getTraceHandler().error( - "Website not supported: " + searchOn); + Instance.getInstance().getTraceHandler().error("Website not supported: " + searchOn); exitCode = 42; break; } @@ -263,14 +282,12 @@ public class Main { searchOn = SupportType.valueOfAllOkUC(args[i]); if (searchOn == null) { - Instance.getTraceHandler().error( - "Website not known: <" + args[i] + ">"); + Instance.getInstance().getTraceHandler().error("Website not known: <" + args[i] + ">"); exitCode = 255; } if (BasicSearchable.getSearchable(searchOn) == null) { - Instance.getTraceHandler().error( - "Website not supported: " + searchOn); + Instance.getInstance().getTraceHandler().error("Website not supported: " + searchOn); exitCode = 255; } } else if (page == null && item == null) { @@ -283,8 +300,7 @@ public class Main { int index = Integer.parseInt(args[i]); tags.add(index); } catch (NumberFormatException e) { - Instance.getTraceHandler().error( - "Invalid tag index: " + args[i]); + Instance.getInstance().getTraceHandler().error("Invalid tag index: " + args[i]); exitCode = 255; } } @@ -315,10 +331,6 @@ public class Main { case HELP: exitCode = 255; break; - case SET_READER: - exitCode = setReaderType(args[i]); - action = MainAction.START; - break; case START: exitCode = 255; // not supposed to be selected by user break; @@ -326,14 +338,10 @@ public class Main { exitCode = 255; // no arguments for this option break; case SERVER: + exitCode = 255; // no arguments for this option + break; case STOP_SERVER: - if (key == null) { - key = args[i]; - } else if (port == null) { - port = Integer.parseInt(args[i]); - } else { - exitCode = 255; - } + exitCode = 255; // no arguments for this option break; case REMOTE: if (key == null) { @@ -344,9 +352,11 @@ public class Main { port = Integer.parseInt(args[i]); BasicLibrary lib = new RemoteLibrary(key, host, port); - lib = new CacheLibrary(Instance.getRemoteDir(host), lib); + lib = new CacheLibrary( + Instance.getInstance().getRemoteDir(host), lib, + Instance.getInstance().getUiConfig()); - BasicReader.setDefaultLibrary(lib); + Instance.getInstance().setLibrary(lib); action = MainAction.START; } else { @@ -383,129 +393,183 @@ public class Main { Progress pg = new Progress(); mainProgress.addProgress(pg, mainProgress.getMax()); - VersionCheck updates = VersionCheck.check(); - if (updates.isNewVersionAvailable()) { - // 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(""); - } - } + VersionCheck updates = checkUpdates(); if (exitCode == 0) { switch (action) { case IMPORT: - exitCode = imprt(urlString, pg); - updates.ok(); // we consider it read + if (updates != null) { + // we consider it read + Instance.getInstance().setVersionChecked(); + } + + try { + exitCode = imprt(BasicReader.getUrl(urlString), pg); + } catch (MalformedURLException e) { + Instance.getInstance().getTraceHandler().error(e); + exitCode = 1; + } + break; case EXPORT: - exitCode = export(luid, sourceString, target, pg); - updates.ok(); // we consider it read + if (updates != null) { + // we consider it read + Instance.getInstance().setVersionChecked(); + } + + OutputType exportType = OutputType.valueOfNullOkUC(sourceString, null); + if (exportType == null) { + Instance.getInstance().getTraceHandler().error(new Exception(trans(StringId.OUTPUT_DESC, sourceString))); + exitCode = 1; + break; + } + + exitCode = export(luid, exportType, target, pg); + break; case CONVERT: - exitCode = convert(urlString, sourceString, target, + if (updates != null) { + // we consider it read + Instance.getInstance().setVersionChecked(); + } + + OutputType convertType = OutputType.valueOfAllOkUC(sourceString, null); + if (convertType == null) { + Instance.getInstance().getTraceHandler() + .error(new IOException(trans(StringId.ERR_BAD_OUTPUT_TYPE, sourceString))); + + exitCode = 2; + break; + } + + exitCode = convert(urlString, convertType, target, plusInfo == null ? false : plusInfo, pg); - updates.ok(); // we consider it read + break; case LIST: - if (BasicReader.getReader() == null) { - Instance.getTraceHandler() - .error(new Exception( - "No reader type has been configured")); - exitCode = 10; - break; - } exitCode = list(sourceString); break; case SET_SOURCE: try { - Instance.getLibrary().changeSource(luid, sourceString, pg); + Instance.getInstance().getLibrary().changeSource(luid, sourceString, pg); } catch (IOException e1) { - Instance.getTraceHandler().error(e1); + Instance.getInstance().getTraceHandler().error(e1); exitCode = 21; } break; case SET_TITLE: try { - Instance.getLibrary().changeTitle(luid, titleString, pg); + Instance.getInstance().getLibrary().changeTitle(luid, titleString, pg); } catch (IOException e1) { - Instance.getTraceHandler().error(e1); + Instance.getInstance().getTraceHandler().error(e1); exitCode = 22; } break; case SET_AUTHOR: try { - Instance.getLibrary().changeAuthor(luid, authorString, pg); + Instance.getInstance().getLibrary().changeAuthor(luid, authorString, pg); } catch (IOException e1) { - Instance.getTraceHandler().error(e1); + Instance.getInstance().getTraceHandler().error(e1); exitCode = 23; } break; case READ: - if (BasicReader.getReader() == null) { - Instance.getTraceHandler() - .error(new Exception( - "No reader type has been configured")); - exitCode = 10; + if (luid == null || luid.isEmpty()) { + syntax(false); + exitCode = 255; break; } - exitCode = read(luid, chapString, true); + + try { + Integer chap = null; + if (chapString != null) { + try { + chap = Integer.parseInt(chapString); + } catch (NumberFormatException e) { + Instance.getInstance().getTraceHandler().error(new IOException( + "Chapter number cannot be parsed: " + chapString, e)); + exitCode = 2; + break; + } + } + + BasicLibrary lib = Instance.getInstance().getLibrary(); + exitCode = read(lib.getStory(luid, null), chap); + } catch (IOException e) { + Instance.getInstance().getTraceHandler() + .error(new IOException("Failed to read book", e)); + exitCode = 2; + } + break; case READ_URL: - if (BasicReader.getReader() == null) { - Instance.getTraceHandler() - .error(new Exception( - "No reader type has been configured")); - exitCode = 10; + if (urlString == null || urlString.isEmpty()) { + syntax(false); + exitCode = 255; break; } - exitCode = read(urlString, chapString, false); + + try { + Integer chap = null; + if (chapString != null) { + try { + chap = Integer.parseInt(chapString); + } catch (NumberFormatException e) { + Instance.getInstance().getTraceHandler().error(new IOException( + "Chapter number cannot be parsed: " + chapString, e)); + exitCode = 2; + break; + } + } + + BasicSupport support = BasicSupport + .getSupport(BasicReader.getUrl(urlString)); + if (support == null) { + Instance.getInstance().getTraceHandler() + .error("URL not supported: " + urlString); + exitCode = 2; + break; + } + + exitCode = read(support.process(null), chap); + } catch (IOException e) { + Instance.getInstance().getTraceHandler() + .error(new IOException("Failed to read book", e)); + exitCode = 2; + } + break; case SEARCH: page = page == null ? 1 : page; if (page < 0) { - Instance.getTraceHandler().error("Incorrect page number"); + Instance.getInstance().getTraceHandler().error("Incorrect page number"); exitCode = 255; break; } item = item == null ? 0 : item; if (item < 0) { - Instance.getTraceHandler().error("Incorrect item number"); + Instance.getInstance().getTraceHandler().error("Incorrect item number"); exitCode = 255; break; } - if (BasicReader.getReader() == null) { - Instance.getTraceHandler() - .error(new Exception( - "No reader type has been configured")); - exitCode = 10; - break; - } - - try { - if (searchOn == null) { - BasicReader.getReader().search(true); - } else if (search != null) { - - BasicReader.getReader().search(searchOn, search, page, - item, true); - } else { - exitCode = 255; + if (searchOn == null) { + try { + search(); + } catch (IOException e) { + Instance.getInstance().getTraceHandler().error(e); + exitCode = 1; } - } catch (IOException e1) { - Instance.getTraceHandler().error(e1); - exitCode = 20; + } else if (search != null) { + try { + searchKeywords(searchOn, search, page, item); + } catch (IOException e) { + Instance.getInstance().getTraceHandler().error(e); + exitCode = 20; + } + } else { + exitCode = 255; } break; @@ -517,31 +581,23 @@ public class Main { page = page == null ? 1 : page; if (page < 0) { - Instance.getTraceHandler().error("Incorrect page number"); + Instance.getInstance().getTraceHandler().error("Incorrect page number"); exitCode = 255; break; } item = item == null ? 0 : item; if (item < 0) { - Instance.getTraceHandler().error("Incorrect item number"); + Instance.getInstance().getTraceHandler().error("Incorrect item number"); exitCode = 255; break; } - if (BasicReader.getReader() == null) { - Instance.getTraceHandler() - .error(new Exception( - "No reader type has been configured")); - exitCode = 10; - break; - } - try { - BasicReader.getReader().searchTag(searchOn, page, item, - true, tags.toArray(new Integer[] {})); - } catch (IOException e1) { - Instance.getTraceHandler().error(e1); + searchTags(searchOn, page, item, + tags.toArray(new Integer[] {})); + } catch (IOException e) { + Instance.getInstance().getTraceHandler().error(e); } break; @@ -549,47 +605,57 @@ public class Main { syntax(true); exitCode = 0; break; - case SET_READER: - exitCode = 255; - break; case VERSION: + if (updates != null) { + // we consider it read + Instance.getInstance().setVersionChecked(); + } + System.out .println(String.format("Fanfix version %s" + "%nhttps://github.com/nikiroo/fanfix/" + "%n\tWritten by Nikiroo", Version.getCurrentVersion())); - updates.ok(); // we consider it read break; case START: - if (BasicReader.getReader() == null) { - Instance.getTraceHandler() - .error(new Exception( - "No reader type has been configured")); - exitCode = 10; - break; + try { + start(); + } catch (IOException e) { + Instance.getInstance().getTraceHandler().error(e); + exitCode = 66; } - BasicReader.getReader().browse(null); break; case SERVER: - if (port == null) { - exitCode = 255; - break; - } try { - ServerObject server = new RemoteLibraryServer(key, port); - server.setTraceHandler(Instance.getTraceHandler()); - server.run(); + startServer(); } catch (IOException e) { - Instance.getTraceHandler().error(e); + Instance.getInstance().getTraceHandler().error(e); } - return; + + break; case STOP_SERVER: + // Can be given via "--remote XX XX XX" + if (key == null) + key = Instance.getInstance().getConfig().getString(Config.SERVER_KEY); + if (port == null) + port = Instance.getInstance().getConfig().getInteger(Config.SERVER_PORT); + if (port == null) { - exitCode = 255; + System.err.println("No port given nor configured in the config file"); + exitCode = 15; break; } + try { + stopServer(key, host, port); + } catch (SSLException e) { + Instance.getInstance().getTraceHandler().error( + "Bad access key for remote library"); + exitCode = 43; + } catch (IOException e) { + Instance.getInstance().getTraceHandler().error(e); + exitCode = 44; + } - new RemoteLibrary(key, host, port).exit(); break; case REMOTE: exitCode = 255; // should not be reachable (REMOTE -> START) @@ -598,38 +664,119 @@ public class Main { } try { - Instance.getTempFiles().close(); + Instance.getInstance().getTempFiles().close(); } catch (IOException e) { - Instance.getTraceHandler() - .error(new IOException( - "Cannot dispose of the temporary files", e)); + Instance.getInstance().getTraceHandler().error(new IOException( + "Cannot dispose of the temporary files", e)); } if (exitCode == 255) { syntax(false); } - System.exit(exitCode); + exit(exitCode); + } + + /** + * A normal invocation of the program (without parameters or at least + * without "action" parameters). + *
+ * 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); + } + + /** + * 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). + * + * @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. + * + * @param githubProject + * the GitHub project, for instance "nikiroo/fanfix" + * + * @return the newer version information or NULL if nothing new + */ + protected VersionCheck checkUpdates(String githubProject) { + try { + 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 null; } + /** + * 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 urlString
+ * @param url
* the resource to import
* @param pg
* the optional progress reporter
*
* @return the exit return code (0 = success)
*/
- public static int imprt(String urlString, Progress pg) {
+ protected static int imprt(URL url, Progress pg) {
try {
- Story story = Instance.getLibrary().imprt(
- BasicReader.getUrl(urlString), pg);
- 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.getTraceHandler().error(e);
+ Instance.getInstance().getTraceHandler().error(e);
return 1;
}
@@ -642,7 +789,7 @@ public class Main {
*
* @param luid
* the story LUID
- * @param typeString
+ * @param type
* the {@link OutputType} to use
* @param target
* the target
@@ -651,25 +798,18 @@ public class Main {
*
* @return the exit return code (0 = success)
*/
- public static int export(String luid, String typeString, String target,
+ protected static int export(String luid, OutputType type, String target,
Progress pg) {
- OutputType type = OutputType.valueOfNullOkUC(typeString, null);
- if (type == null) {
- Instance.getTraceHandler().error(
- new Exception(trans(StringId.OUTPUT_DESC, typeString)));
- return 1;
- }
-
try {
- Instance.getLibrary().export(luid, type, target, pg);
+ Instance.getInstance().getLibrary().export(luid, type, target, pg);
} catch (IOException e) {
- Instance.getTraceHandler().error(e);
+ Instance.getInstance().getTraceHandler().error(e);
return 4;
}
return 0;
}
-
+
/**
* List the stories of the given source from the {@link LocalLibrary}
* (unless NULL is passed, in which case all stories will be listed).
@@ -680,19 +820,14 @@ public class Main {
*
* @return the exit return code (0 = success)
*/
- private static int list(String source) {
- List
+ * 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);
+ }
}