X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;f=src%2Fbe%2Fnikiroo%2Ffanfix%2FMain.java;h=42f3924daa811bdb1bb6e121d38c01b651bf828b;hb=2953f98805434534094068a52bf983b71282cf5c;hp=30febd336d2d94f9d6e2c9257dd11726888213b8;hpb=3727aae2b0516c5ed5366cde29544565f1d6c6b0;p=fanfix.git
diff --git a/src/be/nikiroo/fanfix/Main.java b/src/be/nikiroo/fanfix/Main.java
index 30febd3..42f3924 100644
--- a/src/be/nikiroo/fanfix/Main.java
+++ b/src/be/nikiroo/fanfix/Main.java
@@ -4,15 +4,27 @@ import java.io.File;
import java.io.IOException;
import java.net.MalformedURLException;
import java.net.URL;
+import java.util.List;
import be.nikiroo.fanfix.bundles.StringId;
import be.nikiroo.fanfix.data.Chapter;
+import be.nikiroo.fanfix.data.MetaData;
import be.nikiroo.fanfix.data.Story;
+import be.nikiroo.fanfix.library.BasicLibrary;
+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.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.supported.BasicSupport;
-import be.nikiroo.fanfix.supported.BasicSupport.SupportType;
+import be.nikiroo.fanfix.supported.SupportType;
+import be.nikiroo.utils.Progress;
+import be.nikiroo.utils.Version;
+import be.nikiroo.utils.serial.server.ServerObject;
/**
* Main program entry point.
@@ -20,118 +32,360 @@ import be.nikiroo.fanfix.supported.BasicSupport.SupportType;
* @author niki
*/
public class Main {
+ private enum MainAction {
+ IMPORT, EXPORT, CONVERT, READ, READ_URL, LIST, HELP, SET_READER, START, VERSION, SERVER, STOP_SERVER, REMOTE,
+ }
+
/**
* Main program entry point.
*
* Known environment variables:
*
- * - NOUTF: if set to 1, the program will prefer non-unicode
+ *
- NOUTF: if set to 1 or 'true', the program will prefer non-unicode
* {@link String}s when possible
* - CONFIG_DIR: a path where to look for the .properties files
- * before taking the included ones; they will also be saved/updated into
- * this path when the program starts
+ * before taking the usual ones; they will also be saved/updated into this
+ * path when the program starts
+ * - DEBUG: if set to 1 or 'true', the program will override the DEBUG_ERR
+ * configuration value with 'true'
+ *
+ *
+ *
+ * - --import [URL]: import into library
+ * - --export [id] [output_type] [target]: export story to target
+ * - --convert [URL] [output_type] [target] (+info): convert URL into
+ * target
+ * - --read [id] ([chapter number]): read the given story from the library
+ *
+ * - --read-url [URL] ([chapter number]): convert on the fly and read the
+ * story, without saving it
+ * - --list ([type]): list the stories present in the library
+ * - --set-reader [reader type]: set the reader type to CLI, TUI or LOCAL
+ * for this command
+ * - --version: get the version of the program
+ * - --server [key] [port]: start a server on this port
+ * - --stop-server [key] [port]: stop the running server on this port if
+ * any
+ * - --remote [key] [host] [port]: use a the given remote library
*
*
* @param args
- *
- * - --import [URL]: import into library
- --export [id]
- * [output_type] [target]: export story to target
-
- * --convert [URL] [output_type] [target]: convert URL into
- * target
- --read [id]: read the given story from the
- * library
- --read-url [URL]: convert on the fly and read
- * the story, without saving it
- --list: list the stories
- * present in the library
- *
+ * see method description
*/
public static void main(String[] args) {
- int exitCode = 255;
+ String urlString = null;
+ String luid = null;
+ String sourceString = null;
+ String chapString = null;
+ String target = null;
+ String key = null;
+ MainAction action = MainAction.START;
+ Boolean plusInfo = null;
+ String host = null;
+ Integer port = null;
+
+ boolean noMoreActions = false;
- if (args.length > 0) {
- String action = args[0];
- if (action.equals("--import")) {
- if (args.length > 1) {
- exitCode = imprt(args[1]);
+ int exitCode = 0;
+ for (int i = 0; exitCode == 0 && i < args.length; i++) {
+ // Action (--) handling:
+ if (!noMoreActions && args[i].startsWith("--")) {
+ if (args[i].equals("--")) {
+ noMoreActions = true;
+ } else {
+ try {
+ action = MainAction.valueOf(args[i].substring(2)
+ .toUpperCase().replace("-", "_"));
+ } catch (Exception e) {
+ Instance.getTraceHandler().error(
+ new IllegalArgumentException("Unknown action: "
+ + args[i], e));
+ exitCode = 255;
+ }
}
- } else if (action.equals("--export")) {
- if (args.length > 3) {
- exitCode = export(args[1], args[2], args[3]);
+
+ continue;
+ }
+
+ switch (action) {
+ case IMPORT:
+ if (urlString == null) {
+ urlString = args[i];
+ } else {
+ exitCode = 255;
}
- } else if (action.equals("--convert")) {
- if (args.length > 3) {
- exitCode = convert(
- args[1],
- args[2],
- args[3],
- args.length > 4 ? args[4].toLowerCase().equals(
- "+info") : false);
+ break;
+ case EXPORT:
+ if (luid == null) {
+ luid = args[i];
+ } else if (sourceString == null) {
+ sourceString = args[i];
+ } else if (target == null) {
+ target = args[i];
+ } else {
+ exitCode = 255;
}
- } else if (action.equals("--list")) {
- exitCode = list(args.length > 1 ? args[1] : null);
- } else if (action.equals("--read-url")) {
- if (args.length > 1) {
- exitCode = read(args[1], args.length > 2 ? args[2] : null,
- false);
+ break;
+ case CONVERT:
+ if (urlString == null) {
+ urlString = args[i];
+ } else if (sourceString == null) {
+ sourceString = args[i];
+ } else if (target == null) {
+ target = args[i];
+ } else if (plusInfo == null) {
+ if ("+info".equals(args[i])) {
+ plusInfo = true;
+ } else {
+ exitCode = 255;
+ }
+ } else {
+ exitCode = 255;
+ }
+ break;
+ case LIST:
+ if (sourceString == null) {
+ sourceString = args[i];
+ } else {
+ exitCode = 255;
+ }
+ break;
+ case READ:
+ if (luid == null) {
+ luid = args[i];
+ } else if (chapString == null) {
+ chapString = args[i];
+ } else {
+ exitCode = 255;
+ }
+ break;
+ case READ_URL:
+ if (urlString == null) {
+ urlString = args[i];
+ } else if (chapString == null) {
+ chapString = args[i];
+ } else {
+ exitCode = 255;
+ }
+ break;
+ 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;
+ case VERSION:
+ exitCode = 255; // no arguments for this option
+ break;
+ case SERVER:
+ case STOP_SERVER:
+ if (key == null) {
+ key = args[i];
+ } else if (port == null) {
+ port = Integer.parseInt(args[i]);
+ } else {
+ exitCode = 255;
}
- } else if (action.equals("--read")) {
- if (args.length > 1) {
- exitCode = read(args[1], args.length > 2 ? args[2] : null,
- true);
+ break;
+ case REMOTE:
+ if (key == null) {
+ key = args[i];
+ } else if (host == null) {
+ host = args[i];
+ } else if (port == null) {
+ port = Integer.parseInt(args[i]);
+
+ BasicLibrary lib = new RemoteLibrary(key, host, port);
+ lib = new CacheLibrary(Instance.getRemoteDir(host), lib);
+
+ BasicReader.setDefaultLibrary(lib);
+
+ action = MainAction.START;
+ } else {
+ exitCode = 255;
}
+ break;
}
}
- if (exitCode == 255) {
- syntax();
- }
+ final Progress mainProgress = new Progress(0, 80);
+ mainProgress.addProgressListener(new Progress.ProgressListener() {
+ private int current = mainProgress.getMin();
- if (exitCode != 0) {
- System.exit(exitCode);
+ @Override
+ public void progress(Progress progress, String name) {
+ int diff = progress.getProgress() - current;
+ current += diff;
+
+ StringBuilder builder = new StringBuilder();
+ for (int i = 0; i < diff; i++) {
+ builder.append('.');
+ }
+
+ System.err.print(builder.toString());
+
+ if (progress.isDone()) {
+ System.err.println("");
+ }
+ }
+ });
+ 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 item : updates.getChanges().get(v)) {
+ System.err.println("\t- " + item);
+ }
+ System.err.println("");
+ }
}
- }
- /**
- * Return an {@link URL} from this {@link String}, be it a file path or an
- * actual {@link URL}.
- *
- * @param sourceString
- * the source
- *
- * @return the corresponding {@link URL}
- *
- * @throws MalformedURLException
- * if this is neither a file nor a conventional {@link URL}
- */
- private static URL getUrl(String sourceString) throws MalformedURLException {
- if (sourceString == null || sourceString.isEmpty()) {
- throw new MalformedURLException("Empty url");
+ if (exitCode != 255) {
+ switch (action) {
+ case IMPORT:
+ exitCode = imprt(urlString, pg);
+ updates.ok(); // we consider it read
+ break;
+ case EXPORT:
+ exitCode = export(luid, sourceString, target, pg);
+ updates.ok(); // we consider it read
+ break;
+ case CONVERT:
+ exitCode = convert(urlString, sourceString, 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 READ:
+ if (BasicReader.getReader() == null) {
+ Instance.getTraceHandler()
+ .error(new Exception(
+ "No reader type has been configured"));
+ exitCode = 10;
+ break;
+ }
+ exitCode = read(luid, chapString, true);
+ break;
+ case READ_URL:
+ if (BasicReader.getReader() == null) {
+ Instance.getTraceHandler()
+ .error(new Exception(
+ "No reader type has been configured"));
+ exitCode = 10;
+ break;
+ }
+ exitCode = read(urlString, chapString, false);
+ break;
+ case HELP:
+ syntax(true);
+ exitCode = 0;
+ break;
+ case SET_READER:
+ exitCode = 255;
+ break;
+ case VERSION:
+ 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;
+ }
+ 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();
+ } catch (IOException e) {
+ Instance.getTraceHandler().error(e);
+ }
+ return;
+ case STOP_SERVER:
+ if (port == null) {
+ exitCode = 255;
+ break;
+ }
+
+ new RemoteLibrary(key, host, port).exit();
+ break;
+ case REMOTE:
+ exitCode = 255; // should not be reachable (REMOTE -> START)
+ break;
+ }
}
- URL source = null;
try {
- source = new URL(sourceString);
- } catch (MalformedURLException e) {
- File sourceFile = new File(sourceString);
- source = sourceFile.toURI().toURL();
+ Instance.getTempFiles().close();
+ } catch (IOException e) {
+ Instance.getTraceHandler()
+ .error(new IOException(
+ "Cannot dispose of the temporary files", e));
}
- return source;
+ if (exitCode == 255) {
+ syntax(false);
+ }
+
+ if (exitCode != 0) {
+ System.exit(exitCode);
+ }
}
/**
- * Import the given resource into the {@link Library}.
+ * Import the given resource into the {@link LocalLibrary}.
*
- * @param sourceString
+ * @param urlString
* the resource to import
+ * @param pg
+ * the optional progress reporter
*
* @return the exit return code (0 = success)
*/
- private static int imprt(String sourceString) {
+ public static int imprt(String urlString, Progress pg) {
try {
- Story story = Instance.getLibrary().imprt(getUrl(sourceString));
+ Story story = Instance.getLibrary().imprt(
+ BasicReader.getUrl(urlString), pg);
System.out.println(story.getMeta().getLuid() + ": \""
+ story.getMeta().getTitle() + "\" imported.");
} catch (IOException e) {
- Instance.syserr(e);
+ Instance.getTraceHandler().error(e);
return 1;
}
@@ -139,32 +393,33 @@ 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
* 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);
+ public static int export(String luid, String typeString, String target,
+ Progress pg) {
+ OutputType type = OutputType.valueOfNullOkUC(typeString, null);
if (type == null) {
- Instance.syserr(new Exception(trans(StringId.OUTPUT_DESC,
- typeString)));
+ Instance.getTraceHandler().error(
+ new Exception(trans(StringId.OUTPUT_DESC, typeString)));
return 1;
}
try {
- Story story = Instance.getLibrary().imprt(new URL(sourceString));
- Instance.getLibrary().export(story.getMeta().getLuid(), type,
- target);
+ Instance.getLibrary().export(luid, type, target, pg);
} catch (IOException e) {
- Instance.syserr(e);
+ Instance.getTraceHandler().error(e);
return 4;
}
@@ -172,27 +427,28 @@ public class Main {
}
/**
- * 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;
- try {
- type = SupportType.valueOfNullOkUC(typeString);
- } catch (Exception e) {
- Instance.syserr(new Exception(
- trans(StringId.INPUT_DESC, typeString), e));
- return 1;
- }
-
- BasicReader.getReader().start(type);
+ private static int list(String source) {
+ List stories;
+ stories = BasicReader.getReader().getLibrary().getListBySource(source);
+
+ for (MetaData story : stories) {
+ String author = "";
+ if (story.getAuthor() != null && !story.getAuthor().isEmpty()) {
+ author = " (" + story.getAuthor() + ")";
+ }
+ System.out.println(story.getLuid() + ": " + story.getTitle()
+ + author);
+ }
return 0;
}
@@ -200,9 +456,9 @@ public class Main {
* Start the CLI reader for this {@link Story}.
*
* @param story
- * the LUID of the {@link Story} in the {@link Library} or
- * the {@link Story} {@link URL}
- * @param chap
+ * the LUID of the {@link Story} in the {@link LocalLibrary}
+ * or the {@link Story} {@link URL}
+ * @param chapString
* which {@link Chapter} to read (starting at 1), or NULL to get
* the {@link Story} description
* @param library
@@ -211,22 +467,30 @@ public class Main {
*
* @return the exit return code (0 = success)
*/
- private static int read(String story, String chap, boolean library) {
+ private static int read(String story, String chapString, boolean library) {
try {
- BasicReader reader = BasicReader.getReader();
+ Reader reader = BasicReader.getReader();
if (library) {
- reader.setStory(story);
+ reader.setMeta(story);
} else {
- reader.setStory(getUrl(story));
+ reader.setMeta(BasicReader.getUrl(story), null);
}
- if (chap != null) {
- reader.read(Integer.parseInt(chap));
+ if (chapString != null) {
+ try {
+ reader.setChapter(Integer.parseInt(chapString));
+ reader.read();
+ } catch (NumberFormatException e) {
+ Instance.getTraceHandler().error(
+ new IOException("Chapter number cannot be parsed: "
+ + chapString, e));
+ return 2;
+ }
} else {
reader.read();
}
} catch (IOException e) {
- Instance.syserr(e);
+ Instance.getTraceHandler().error(e);
return 1;
}
@@ -236,66 +500,81 @@ public class Main {
/**
* Convert the {@link Story} into another format.
*
- * @param sourceString
+ * @param urlString
* the source {@link Story} to convert
* @param typeString
* 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) {
+ public static int convert(String urlString, String typeString,
+ String target, boolean infoCover, Progress pg) {
int exitCode = 0;
- String sourceName = sourceString;
+ String sourceName = urlString;
try {
- URL source = getUrl(sourceString);
+ URL source = BasicReader.getUrl(urlString);
sourceName = source.toString();
if (source.toString().startsWith("file://")) {
sourceName = sourceName.substring("file://".length());
}
- OutputType type = OutputType.valueOfAllOkUC(typeString);
+ OutputType type = OutputType.valueOfAllOkUC(typeString, null);
if (type == null) {
- Instance.syserr(new IOException(trans(
- StringId.ERR_BAD_OUTPUT_TYPE, typeString)));
+ Instance.getTraceHandler().error(
+ 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);
+ Progress pgIn = new Progress();
+ Progress pgOut = new Progress();
+ if (pg != null) {
+ pg.setMax(2);
+ pg.addProgress(pgIn, 1);
+ pg.addProgress(pgOut, 1);
+ }
+ Story story = support.process(pgIn);
try {
- filename = new File(filename).getAbsolutePath();
- BasicOutput.getOutput(type, infoCover).process(
- story, filename);
+ target = new File(target).getAbsolutePath();
+ BasicOutput.getOutput(type, infoCover, infoCover)
+ .process(story, target, pgOut);
} catch (IOException e) {
- Instance.syserr(new IOException(trans(
- StringId.ERR_SAVING, filename), e));
+ Instance.getTraceHandler().error(
+ new IOException(trans(StringId.ERR_SAVING,
+ target), e));
exitCode = 5;
}
} else {
- Instance.syserr(new IOException(trans(
- StringId.ERR_NOT_SUPPORTED, source)));
+ Instance.getTraceHandler().error(
+ new IOException(trans(
+ StringId.ERR_NOT_SUPPORTED, source)));
exitCode = 4;
}
} catch (IOException e) {
- Instance.syserr(new IOException(trans(StringId.ERR_LOADING,
- sourceName), e));
+ Instance.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.getTraceHandler()
+ .error(new IOException(trans(StringId.ERR_BAD_URL,
+ sourceName), e));
exitCode = 1;
}
@@ -315,27 +594,56 @@ public class Main {
}
/**
- * Display the correct syntax of the program to the user.
+ * 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 showHelp
+ * TRUE to show the syntax help, FALSE to show "syntax 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');
- }
+ private static 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);
+ String typesIn = builder.toString();
+ builder.setLength(0);
- for (OutputType type : OutputType.values()) {
- builder.append(trans(StringId.ERR_SYNTAX_TYPE, type.toString(),
- type.getDesc()));
- builder.append('\n');
- }
+ for (OutputType type : OutputType.values()) {
+ builder.append(trans(StringId.ERR_SYNTAX_TYPE, type.toString(),
+ type.getDesc(true)));
+ builder.append('\n');
+ }
- String typesOut = builder.toString();
+ String typesOut = builder.toString();
- System.err.println(trans(StringId.ERR_SYNTAX, typesIn, typesOut));
+ System.out.println(trans(StringId.HELP_SYNTAX, typesIn, typesOut));
+ } else {
+ System.err.println(trans(StringId.ERR_SYNTAX));
+ }
+ }
+
+ /**
+ * Set the default reader type for this session only (it can be changed in
+ * the configuration file, too, but this value will override it).
+ *
+ * @param readerTypeString
+ * the type
+ */
+ private static int setReaderType(String readerTypeString) {
+ try {
+ ReaderType readerType = ReaderType.valueOf(readerTypeString
+ .toUpperCase());
+ BasicReader.setDefaultReaderType(readerType);
+ return 0;
+ } catch (IllegalArgumentException e) {
+ Instance.getTraceHandler().error(
+ new IOException("Unknown reader type: " + readerTypeString,
+ e));
+ return 1;
+ }
}
}