import be.nikiroo.fanfix.data.Story;
import be.nikiroo.fanfix.output.BasicOutput;
import be.nikiroo.fanfix.output.BasicOutput.OutputType;
-import be.nikiroo.fanfix.reader.CliReader;
+import be.nikiroo.fanfix.reader.BasicReader;
+import be.nikiroo.fanfix.reader.BasicReader.ReaderType;
import be.nikiroo.fanfix.supported.BasicSupport;
import be.nikiroo.fanfix.supported.BasicSupport.SupportType;
+import be.nikiroo.utils.Progress;
+import be.nikiroo.utils.Version;
+import be.nikiroo.utils.ui.UIUtils;
/**
* Main program entry point.
* @author niki
*/
public class Main {
+ private enum MainAction {
+ IMPORT, EXPORT, CONVERT, READ, READ_URL, LIST, HELP, SET_READER, START, VERSION,
+ }
+
/**
* Main program entry point.
* <p>
* Known environment variables:
* <ul>
- * <li>NOUTF: if set to 1, the program will prefer non-unicode
+ * <li>NOUTF: if set to 1 or 'true', the program will prefer non-unicode
* {@link String}s when possible</li>
* <li>CONFIG_DIR: a path where to look for the <tt>.properties</tt> files
- * before taking the included ones; they will also be saved/updated into
- * this path when the program starts</li>
+ * before taking the usual ones; they will also be saved/updated into this
+ * path when the program starts</li>
+ * <li>DEBUG: if set to 1 or 'true', the program will override the DEBUG_ERR
+ * configuration value with 'true'</li>
+ * </ul>
+ * <p>
+ * <ul>
+ * <li>--import [URL]: import into library</li>
+ * <li>--export [id] [output_type] [target]: export story to target</li>
+ * <li>--convert [URL] [output_type] [target] (+info): convert URL into
+ * target</li>
+ * <li>--read [id] ([chapter number]): read the given story from the library
+ * </li>
+ * <li>--read-url [URL] ([chapter number]): convert on the fly and read the
+ * story, without saving it</li>
+ * <li>--list ([type]): list the stories present in the library</li>
+ * <li>--set-reader [reader type]: set the reader type to CLI or LOCAL for
+ * this command</li>
+ * <li>--version: get the version of the program</li>
* </ul>
*
* @param args
- * <ol>
- * <li>--import [URL]: import into library</li> <li>--export [id]
- * [output_type] [target]: export story to target</li> <li>
- * --convert [URL] [output_type] [target]: convert URL into
- * target</li> <li>--read [id]: read the given story from the
- * library</li> <li>--read-url [URL]: convert on the fly and read
- * the story, without saving it</li> <li>--list: list the stories
- * present in the library</li>
- * </ol>
+ * see method description
*/
public static void main(String[] args) {
- int exitCode = 255;
+ String urlString = null;
+ String luid = null;
+ String typeString = null;
+ String chapString = null;
+ String target = null;
+ MainAction action = MainAction.START;
+ Boolean plusInfo = null;
+
+ boolean noMoreActions = false;
+
+ 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.syserr(new IllegalArgumentException(
+ "Unknown action: " + args[i], e));
+ exitCode = 255;
+ }
+ }
+
+ continue;
+ }
- if (args.length > 0) {
- String action = args[0];
- if (action.equals("--import")) {
- if (args.length > 1) {
- exitCode = imprt(args[1]);
+ switch (action) {
+ case IMPORT:
+ if (urlString == null) {
+ urlString = args[i];
+ } else {
+ exitCode = 255;
}
- } else if (action.equals("--export")) {
- if (args.length > 3) {
- exitCode = export(args[1], args[2], args[3]);
+ break;
+ case EXPORT:
+ if (luid == null) {
+ luid = args[i];
+ } else if (typeString == null) {
+ typeString = args[i];
+ } else if (target == null) {
+ target = 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 CONVERT:
+ if (urlString == null) {
+ urlString = args[i];
+ } else if (typeString == null) {
+ typeString = 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;
}
- } 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 LIST:
+ if (typeString == null) {
+ typeString = 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 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]);
+ break;
+ case START:
+ exitCode = 255; // not supposed to be selected by user
+ break;
+ case VERSION:
+ exitCode = 255; // no arguments for this option
}
}
- 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);
+ 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, typeString, target, pg);
+ updates.ok(); // we consider it read
+ break;
+ case CONVERT:
+ exitCode = convert(urlString, typeString, target,
+ plusInfo == null ? false : plusInfo, pg);
+ updates.ok(); // we consider it read
+ break;
+ case LIST:
+ exitCode = list(typeString);
+ break;
+ case READ:
+ exitCode = read(luid, chapString, true);
+ break;
+ case READ_URL:
+ exitCode = read(urlString, chapString, false);
+ break;
+ case HELP:
+ syntax(true);
+ exitCode = 0;
+ break;
+ case SET_READER:
+ 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:
+ UIUtils.setLookAndFeel();
+ BasicReader.setDefaultReaderType(ReaderType.LOCAL);
+ BasicReader.getReader().start(null);
+ break;
+ }
}
- URL source = null;
- try {
- source = new URL(sourceString);
- } catch (MalformedURLException e) {
- File sourceFile = new File(sourceString);
- source = sourceFile.toURI().toURL();
+ if (exitCode == 255) {
+ syntax(false);
}
- return source;
+ if (exitCode != 0) {
+ System.exit(exitCode);
+ }
}
/**
* Import the given resource into the {@link Library}.
*
- * @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) {
/**
* Export the {@link Story} from the {@link Library} 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) {
+ public static int export(String luid, String typeString, String target,
+ Progress pg) {
OutputType type = OutputType.valueOfNullOkUC(typeString);
if (type == null) {
Instance.syserr(new Exception(trans(StringId.OUTPUT_DESC,
}
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);
return 4;
* 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
+ * the type 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;
- }
-
- CliReader.list(type);
-
+ private static int list(String type) {
+ BasicReader.getReader().start(type);
return 0;
}
* @param story
* the LUID of the {@link Story} in the {@link Library} <b>or</b>
* the {@link Story} {@link URL}
- * @param chap
+ * @param chapString
* which {@link Chapter} to read (starting at 1), or NULL to get
* the {@link Story} description
* @param library
*
* @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 {
- CliReader reader;
+ BasicReader reader = BasicReader.getReader();
if (library) {
- reader = new CliReader(story);
+ reader.setStory(story, null);
} else {
- reader = new CliReader(getUrl(story));
+ reader.setStory(BasicReader.getUrl(story), null);
}
- if (chap != null) {
- reader.read(Integer.parseInt(chap));
+ if (chapString != null) {
+ try {
+ reader.read(Integer.parseInt(chapString));
+ } catch (NumberFormatException e) {
+ Instance.syserr(new IOException(
+ "Chapter number cannot be parsed: " + chapString, e));
+ return 2;
+ }
} else {
reader.read();
}
/**
* 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) {
+ private 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());
} 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(source, pgIn);
try {
- filename = new File(filename).getAbsolutePath();
+ target = new File(target).getAbsolutePath();
BasicOutput.getOutput(type, infoCover).process(
- story, filename);
+ story, target, pgOut);
} catch (IOException e) {
Instance.syserr(new IOException(trans(
- StringId.ERR_SAVING, filename), e));
+ StringId.ERR_SAVING, target), e));
exitCode = 5;
}
} else {
}
/**
- * 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.out.println(trans(StringId.HELP_SYNTAX, typesIn, typesOut));
+ } else {
+ System.err.println(trans(StringId.ERR_SYNTAX));
+ }
+ }
- System.err.println(trans(StringId.ERR_SYNTAX, typesIn, typesOut));
+ /**
+ * 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.syserr(new IOException("Unknown reader type: "
+ + readerTypeString, e));
+ return 1;
+ }
}
}