package be.nikiroo.fanfix; import java.io.File; import java.io.IOException; import java.net.MalformedURLException; 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; 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.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.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.VersionCheck; /** * Main program entry point. * * @author niki */ public class Main { private enum MainAction { IMPORT, EXPORT, CONVERT, READ, READ_URL, LIST, HELP, START, VERSION, SERVER, STOP_SERVER, REMOTE, SET_SOURCE, SET_TITLE, SET_AUTHOR, SEARCH, SEARCH_TAG } /** * Main program entry point. *
* 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);
}
/**
* 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 url
* the resource to import
* @param pg
* the optional progress reporter
*
* @return the exit return code (0 = success)
*/
protected static int imprt(URL url, Progress pg) {
try {
MetaData meta = Instance.getInstance().getLibrary().imprt(url, pg);
System.out.println(meta.getLuid() + ": \"" + meta.getTitle() + "\" imported.");
} catch (IOException e) {
Instance.getInstance().getTraceHandler().error(e);
return 1;
}
return 0;
}
/**
* Export the {@link Story} from the {@link LocalLibrary} to the given
* target.
*
* @param luid
* the story LUID
* @param type
* the {@link OutputType} to use
* @param target
* the target
* @param pg
* the optional progress reporter
*
* @return the exit return code (0 = success)
*/
protected static int export(String luid, OutputType type, String target,
Progress pg) {
try {
Instance.getInstance().getLibrary().export(luid, type, target, pg);
} catch (IOException 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).
*
* @param source
* the source to list the known stories of, or NULL to list all
* stories
*
* @return the exit return code (0 = success)
*/
protected int list(String source) {
try {
new CliReader().listBooks(source);
} catch (IOException e) {
Instance.getInstance().getTraceHandler().error(e);
return 66;
}
return 0;
}
/**
* Start the current reader for this {@link Story}.
*
* @param story
* the story to read
* @param chap
* which {@link Chapter} to read (starting at 1), or NULL to get
* the {@link Story} description
*
* @return the exit return code (0 = success)
*/
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;
}
} else {
Instance.getInstance().getTraceHandler()
.error("Cannot find book: " + story);
return 2;
}
return 0;
}
/**
* Convert the {@link Story} into another format.
*
* @param urlString
* the source {@link Story} to convert
* @param type
* the {@link OutputType} to convert to
* @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)
*/
protected int convert(String urlString, OutputType type,
String target, boolean infoCover, Progress pg) {
int exitCode = 0;
Instance.getInstance().getTraceHandler().trace("Convert: " + urlString);
String sourceName = urlString;
try {
URL source = BasicReader.getUrl(urlString);
sourceName = source.toString();
if (sourceName.startsWith("file://")) {
sourceName = sourceName.substring("file://".length());
}
try {
BasicSupport support = BasicSupport.getSupport(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);
}
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;
}
} 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.getInstance().getTraceHandler().error(new IOException(trans(StringId.ERR_BAD_URL, sourceName), e));
exitCode = 1;
}
return exitCode;
}
/**
* 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"
*/
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).
*
* @throws IOException
* in case of I/O errors
*/
protected void search() throws IOException {
new CliReader().listSearchables();
}
/**
* 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
*/
protected void searchKeywords(SupportType searchOn, String search,
int page, Integer item) throws IOException {
new CliReader().searchBooksByKeyword(searchOn, search, page, item);
}
/**
* 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);
}
/**
* 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);
}
}
/**
* Stop a running Fanfix server.
*
* @param key
* the key to contact the Fanfix server
* @param host
* the host on which it runs (NULL means localhost)
* @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, Integer port)
throws IOException, SSLException {
new RemoteLibrary(key, host, port).exit();
}
/**
* 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);
}
}