src/be/nikiroo/fanfix/Main.java

   1 package be.nikiroo.fanfix;
   2
   3 import java.io.File;
   4 import java.io.IOException;
   5 import java.net.MalformedURLException;
   6 import java.net.URL;
   7 import java.util.List;
   8
   9 import be.nikiroo.fanfix.bundles.StringId;
  10 import be.nikiroo.fanfix.data.Chapter;
  11 import be.nikiroo.fanfix.data.MetaData;
  12 import be.nikiroo.fanfix.data.Story;
  13 import be.nikiroo.fanfix.library.BasicLibrary;
  14 import be.nikiroo.fanfix.library.CacheLibrary;
  15 import be.nikiroo.fanfix.library.LocalLibrary;
  16 import be.nikiroo.fanfix.library.RemoteLibrary;
  17 import be.nikiroo.fanfix.library.RemoteLibraryServer;
  18 import be.nikiroo.fanfix.output.BasicOutput;
  19 import be.nikiroo.fanfix.output.BasicOutput.OutputType;
  20 import be.nikiroo.fanfix.reader.BasicReader;
  21 import be.nikiroo.fanfix.reader.Reader;
  22 import be.nikiroo.fanfix.reader.Reader.ReaderType;
  23 import be.nikiroo.fanfix.supported.BasicSupport;
  24 import be.nikiroo.fanfix.supported.SupportType;
  25 import be.nikiroo.utils.Progress;
  26 import be.nikiroo.utils.Version;
  27 import be.nikiroo.utils.serial.server.ServerObject;
  28
  29 /**
  30  * Main program entry point.
  31  *
  32  * @author niki
  33  */
  34 public class Main {
  35         private enum MainAction {
  36                 IMPORT, EXPORT, CONVERT, READ, READ_URL, LIST, HELP, SET_READER, START, VERSION, SERVER, STOP_SERVER, REMOTE,
  37         }
  38
  39         /**
  40          * Main program entry point.
  41          * <p>
  42          * Known environment variables:
  43          * <ul>
  44          * <li>NOUTF: if set to 1 or 'true', the program will prefer non-unicode
  45          * {@link String}s when possible</li>
  46          * <li>CONFIG_DIR: a path where to look for the <tt>.properties</tt> files
  47          * before taking the usual ones; they will also be saved/updated into this
  48          * path when the program starts</li>
  49          * <li>DEBUG: if set to 1 or 'true', the program will override the DEBUG_ERR
  50          * configuration value with 'true'</li>
  51          * </ul>
  52          * <p>
  53          * <ul>
  54          * <li>--import [URL]: import into library</li>
  55          * <li>--export [id] [output_type] [target]: export story to target</li>
  56          * <li>--convert [URL] [output_type] [target] (+info): convert URL into
  57          * target</li>
  58          * <li>--read [id] ([chapter number]): read the given story from the library
  59          * </li>
  60          * <li>--read-url [URL] ([chapter number]): convert on the fly and read the
  61          * story, without saving it</li>
  62          * <li>--list ([type]): list the stories present in the library</li>
  63          * <li>--set-reader [reader type]: set the reader type to CLI, TUI or LOCAL
  64          * for this command</li>
  65          * <li>--version: get the version of the program</li>
  66          * <li>--server [key] [port]: start a server on this port</li>
  67          * <li>--stop-server [key] [port]: stop the running server on this port if
  68          * any</li>
  69          * <li>--remote [key] [host] [port]: use a the given remote library</li>
  70          * </ul>
  71          *
  72          * @param args
  73          *            see method description
  74          */
  75         public static void main(String[] args) {
  76                 String urlString = null;
  77                 String luid = null;
  78                 String sourceString = null;
  79                 String chapString = null;
  80                 String target = null;
  81                 String key = null;
  82                 MainAction action = MainAction.START;
  83                 Boolean plusInfo = null;
  84                 String host = null;
  85                 Integer port = null;
  86
  87                 boolean noMoreActions = false;
  88
  89                 int exitCode = 0;
  90                 for (int i = 0; exitCode == 0 && i < args.length; i++) {
  91                         // Action (--) handling:
  92                         if (!noMoreActions && args[i].startsWith("--")) {
  93                                 if (args[i].equals("--")) {
  94                                         noMoreActions = true;
  95                                 } else {
  96                                         try {
  97                                                 action = MainAction.valueOf(args[i].substring(2)
  98                                                                 .toUpperCase().replace("-", "_"));
  99                                         } catch (Exception e) {
 100                                                 Instance.getTraceHandler().error(
 101                                                                 new IllegalArgumentException("Unknown action: "
 102                                                                                 + args[i], e));
 103                                                 exitCode = 255;
 104                                         }
 105                                 }
 106
 107                                 continue;
 108                         }
 109
 110                         switch (action) {
 111                         case IMPORT:
 112                                 if (urlString == null) {
 113                                         urlString = args[i];
 114                                 } else {
 115                                         exitCode = 255;
 116                                 }
 117                                 break;
 118                         case EXPORT:
 119                                 if (luid == null) {
 120                                         luid = args[i];
 121                                 } else if (sourceString == null) {
 122                                         sourceString = args[i];
 123                                 } else if (target == null) {
 124                                         target = args[i];
 125                                 } else {
 126                                         exitCode = 255;
 127                                 }
 128                                 break;
 129                         case CONVERT:
 130                                 if (urlString == null) {
 131                                         urlString = args[i];
 132                                 } else if (sourceString == null) {
 133                                         sourceString = args[i];
 134                                 } else if (target == null) {
 135                                         target = args[i];
 136                                 } else if (plusInfo == null) {
 137                                         if ("+info".equals(args[i])) {
 138                                                 plusInfo = true;
 139                                         } else {
 140                                                 exitCode = 255;
 141                                         }
 142                                 } else {
 143                                         exitCode = 255;
 144                                 }
 145                                 break;
 146                         case LIST:
 147                                 if (sourceString == null) {
 148                                         sourceString = args[i];
 149                                 } else {
 150                                         exitCode = 255;
 151                                 }
 152                                 break;
 153                         case READ:
 154                                 if (luid == null) {
 155                                         luid = args[i];
 156                                 } else if (chapString == null) {
 157                                         chapString = args[i];
 158                                 } else {
 159                                         exitCode = 255;
 160                                 }
 161                                 break;
 162                         case READ_URL:
 163                                 if (urlString == null) {
 164                                         urlString = args[i];
 165                                 } else if (chapString == null) {
 166                                         chapString = args[i];
 167                                 } else {
 168                                         exitCode = 255;
 169                                 }
 170                                 break;
 171                         case HELP:
 172                                 exitCode = 255;
 173                                 break;
 174                         case SET_READER:
 175                                 exitCode = setReaderType(args[i]);
 176                                 action = MainAction.START;
 177                                 break;
 178                         case START:
 179                                 exitCode = 255; // not supposed to be selected by user
 180                                 break;
 181                         case VERSION:
 182                                 exitCode = 255; // no arguments for this option
 183                                 break;
 184                         case SERVER:
 185                         case STOP_SERVER:
 186                                 if (key == null) {
 187                                         key = args[i];
 188                                 } else if (port == null) {
 189                                         port = Integer.parseInt(args[i]);
 190                                 } else {
 191                                         exitCode = 255;
 192                                 }
 193                                 break;
 194                         case REMOTE:
 195                                 if (key == null) {
 196                                         key = args[i];
 197                                 } else if (host == null) {
 198                                         host = args[i];
 199                                 } else if (port == null) {
 200                                         port = Integer.parseInt(args[i]);
 201
 202                                         BasicLibrary lib = new RemoteLibrary(key, host, port);
 203                                         lib = new CacheLibrary(Instance.getRemoteDir(host), lib);
 204
 205                                         BasicReader.setDefaultLibrary(lib);
 206
 207                                         action = MainAction.START;
 208                                 } else {
 209                                         exitCode = 255;
 210                                 }
 211                                 break;
 212                         }
 213                 }
 214
 215                 final Progress mainProgress = new Progress(0, 80);
 216                 mainProgress.addProgressListener(new Progress.ProgressListener() {
 217                         private int current = mainProgress.getMin();
 218
 219                         @Override
 220                         public void progress(Progress progress, String name) {
 221                                 int diff = progress.getProgress() - current;
 222                                 current += diff;
 223
 224                                 if (diff <= 0)
 225                                         return;
 226
 227                                 StringBuilder builder = new StringBuilder();
 228                                 for (int i = 0; i < diff; i++) {
 229                                         builder.append('.');
 230                                 }
 231
 232                                 System.err.print(builder.toString());
 233
 234                                 if (progress.isDone()) {
 235                                         System.err.println("");
 236                                 }
 237                         }
 238                 });
 239                 Progress pg = new Progress();
 240                 mainProgress.addProgress(pg, mainProgress.getMax());
 241
 242                 VersionCheck updates = VersionCheck.check();
 243                 if (updates.isNewVersionAvailable()) {
 244                         // Sent to syserr so not to cause problem if one tries to capture a
 245                         // story content in text mode
 246                         System.err
 247                                         .println("A new version of the program is available at https://github.com/nikiroo/fanfix/releases");
 248                         System.err.println("");
 249                         for (Version v : updates.getNewer()) {
 250                                 System.err.println("\tVersion " + v);
 251                                 System.err.println("\t-------------");
 252                                 System.err.println("");
 253                                 for (String item : updates.getChanges().get(v)) {
 254                                         System.err.println("\t- " + item);
 255                                 }
 256                                 System.err.println("");
 257                         }
 258                 }
 259
 260                 if (exitCode != 255) {
 261                         switch (action) {
 262                         case IMPORT:
 263                                 exitCode = imprt(urlString, pg);
 264                                 updates.ok(); // we consider it read
 265                                 break;
 266                         case EXPORT:
 267                                 exitCode = export(luid, sourceString, target, pg);
 268                                 updates.ok(); // we consider it read
 269                                 break;
 270                         case CONVERT:
 271                                 exitCode = convert(urlString, sourceString, target,
 272                                                 plusInfo == null ? false : plusInfo, pg);
 273                                 updates.ok(); // we consider it read
 274                                 break;
 275                         case LIST:
 276                                 if (BasicReader.getReader() == null) {
 277                                         Instance.getTraceHandler()
 278                                                         .error(new Exception(
 279                                                                         "No reader type has been configured"));
 280                                         exitCode = 10;
 281                                         break;
 282                                 }
 283                                 exitCode = list(sourceString);
 284                                 break;
 285                         case READ:
 286                                 if (BasicReader.getReader() == null) {
 287                                         Instance.getTraceHandler()
 288                                                         .error(new Exception(
 289                                                                         "No reader type has been configured"));
 290                                         exitCode = 10;
 291                                         break;
 292                                 }
 293                                 exitCode = read(luid, chapString, true);
 294                                 break;
 295                         case READ_URL:
 296                                 if (BasicReader.getReader() == null) {
 297                                         Instance.getTraceHandler()
 298                                                         .error(new Exception(
 299                                                                         "No reader type has been configured"));
 300                                         exitCode = 10;
 301                                         break;
 302                                 }
 303                                 exitCode = read(urlString, chapString, false);
 304                                 break;
 305                         case HELP:
 306                                 syntax(true);
 307                                 exitCode = 0;
 308                                 break;
 309                         case SET_READER:
 310                                 exitCode = 255;
 311                                 break;
 312                         case VERSION:
 313                                 System.out
 314                                                 .println(String.format("Fanfix version %s"
 315                                                                 + "%nhttps://github.com/nikiroo/fanfix/"
 316                                                                 + "%n\tWritten by Nikiroo",
 317                                                                 Version.getCurrentVersion()));
 318                                 updates.ok(); // we consider it read
 319                                 break;
 320                         case START:
 321                                 if (BasicReader.getReader() == null) {
 322                                         Instance.getTraceHandler()
 323                                                         .error(new Exception(
 324                                                                         "No reader type has been configured"));
 325                                         exitCode = 10;
 326                                         break;
 327                                 }
 328                                 BasicReader.getReader().browse(null);
 329                                 break;
 330                         case SERVER:
 331                                 if (port == null) {
 332                                         exitCode = 255;
 333                                         break;
 334                                 }
 335                                 try {
 336                                         ServerObject server = new RemoteLibraryServer(key, port);
 337                                         server.setTraceHandler(Instance.getTraceHandler());
 338                                         server.run();
 339                                 } catch (IOException e) {
 340                                         Instance.getTraceHandler().error(e);
 341                                 }
 342                                 return;
 343                         case STOP_SERVER:
 344                                 if (port == null) {
 345                                         exitCode = 255;
 346                                         break;
 347                                 }
 348
 349                                 new RemoteLibrary(key, host, port).exit();
 350                                 break;
 351                         case REMOTE:
 352                                 exitCode = 255; // should not be reachable (REMOTE -> START)
 353                                 break;
 354                         }
 355                 }
 356
 357                 try {
 358                         Instance.getTempFiles().close();
 359                 } catch (IOException e) {
 360                         Instance.getTraceHandler()
 361                                         .error(new IOException(
 362                                                         "Cannot dispose of the temporary files", e));
 363                 }
 364
 365                 if (exitCode == 255) {
 366                         syntax(false);
 367                 }
 368
 369                 System.exit(exitCode);
 370         }
 371
 372         /**
 373          * Import the given resource into the {@link LocalLibrary}.
 374          *
 375          * @param urlString
 376          *            the resource to import
 377          * @param pg
 378          *            the optional progress reporter
 379          *
 380          * @return the exit return code (0 = success)
 381          */
 382         public static int imprt(String urlString, Progress pg) {
 383                 try {
 384                         Story story = Instance.getLibrary().imprt(
 385                                         BasicReader.getUrl(urlString), pg);
 386                         System.out.println(story.getMeta().getLuid() + ": \""
 387                                         + story.getMeta().getTitle() + "\" imported.");
 388                 } catch (IOException e) {
 389                         Instance.getTraceHandler().error(e);
 390                         return 1;
 391                 }
 392
 393                 return 0;
 394         }
 395
 396         /**
 397          * Export the {@link Story} from the {@link LocalLibrary} to the given
 398          * target.
 399          *
 400          * @param luid
 401          *            the story LUID
 402          * @param typeString
 403          *            the {@link OutputType} to use
 404          * @param target
 405          *            the target
 406          * @param pg
 407          *            the optional progress reporter
 408          *
 409          * @return the exit return code (0 = success)
 410          */
 411         public static int export(String luid, String typeString, String target,
 412                         Progress pg) {
 413                 OutputType type = OutputType.valueOfNullOkUC(typeString, null);
 414                 if (type == null) {
 415                         Instance.getTraceHandler().error(
 416                                         new Exception(trans(StringId.OUTPUT_DESC, typeString)));
 417                         return 1;
 418                 }
 419
 420                 try {
 421                         Instance.getLibrary().export(luid, type, target, pg);
 422                 } catch (IOException e) {
 423                         Instance.getTraceHandler().error(e);
 424                         return 4;
 425                 }
 426
 427                 return 0;
 428         }
 429
 430         /**
 431          * List the stories of the given source from the {@link LocalLibrary}
 432          * (unless NULL is passed, in which case all stories will be listed).
 433          *
 434          * @param source
 435          *            the source to list the known stories of, or NULL to list all
 436          *            stories
 437          *
 438          * @return the exit return code (0 = success)
 439          */
 440         private static int list(String source) {
 441                 List<MetaData> stories;
 442                 stories = BasicReader.getReader().getLibrary().getListBySource(source);
 443
 444                 for (MetaData story : stories) {
 445                         String author = "";
 446                         if (story.getAuthor() != null && !story.getAuthor().isEmpty()) {
 447                                 author = " (" + story.getAuthor() + ")";
 448                         }
 449
 450                         System.out.println(story.getLuid() + ": " + story.getTitle()
 451                                         + author);
 452                 }
 453                 return 0;
 454         }
 455
 456         /**
 457          * Start the current reader for this {@link Story}.
 458          *
 459          * @param story
 460          *            the LUID of the {@link Story} in the {@link LocalLibrary}
 461          *            <b>or</b> the {@link Story} {@link URL}
 462          * @param chapString
 463          *            which {@link Chapter} to read (starting at 1), or NULL to get
 464          *            the {@link Story} description
 465          * @param library
 466          *            TRUE if the source is the {@link Story} LUID, FALSE if it is a
 467          *            {@link URL}
 468          *
 469          * @return the exit return code (0 = success)
 470          */
 471         private static int read(String story, String chapString, boolean library) {
 472                 try {
 473                         Reader reader = BasicReader.getReader();
 474                         if (library) {
 475                                 reader.setMeta(story);
 476                         } else {
 477                                 reader.setMeta(BasicReader.getUrl(story), null);
 478                         }
 479
 480                         if (chapString != null) {
 481                                 try {
 482                                         reader.setChapter(Integer.parseInt(chapString));
 483                                         reader.read(true);
 484                                 } catch (NumberFormatException e) {
 485                                         Instance.getTraceHandler().error(
 486                                                         new IOException("Chapter number cannot be parsed: "
 487                                                                         + chapString, e));
 488                                         return 2;
 489                                 }
 490                         } else {
 491                                 reader.read(true);
 492                         }
 493                 } catch (IOException e) {
 494                         Instance.getTraceHandler().error(e);
 495                         return 1;
 496                 }
 497
 498                 return 0;
 499         }
 500
 501         /**
 502          * Convert the {@link Story} into another format.
 503          *
 504          * @param urlString
 505          *            the source {@link Story} to convert
 506          * @param typeString
 507          *            the {@link OutputType} to convert to
 508          * @param target
 509          *            the target file
 510          * @param infoCover
 511          *            TRUE to also export the cover and info file, even if the given
 512          *            {@link OutputType} does not usually save them
 513          * @param pg
 514          *            the optional progress reporter
 515          *
 516          * @return the exit return code (0 = success)
 517          */
 518         public static int convert(String urlString, String typeString,
 519                         String target, boolean infoCover, Progress pg) {
 520                 int exitCode = 0;
 521
 522                 Instance.getTraceHandler().trace("Convert: " + urlString);
 523                 String sourceName = urlString;
 524                 try {
 525                         URL source = BasicReader.getUrl(urlString);
 526                         sourceName = source.toString();
 527                         if (source.toString().startsWith("file://")) {
 528                                 sourceName = sourceName.substring("file://".length());
 529                         }
 530
 531                         OutputType type = OutputType.valueOfAllOkUC(typeString, null);
 532                         if (type == null) {
 533                                 Instance.getTraceHandler().error(
 534                                                 new IOException(trans(StringId.ERR_BAD_OUTPUT_TYPE,
 535                                                                 typeString)));
 536
 537                                 exitCode = 2;
 538                         } else {
 539                                 try {
 540                                         BasicSupport support = BasicSupport.getSupport(source);
 541
 542                                         if (support != null) {
 543                                                 Instance.getTraceHandler().trace(
 544                                                                 "Support found: " + support.getClass());
 545                                                 Progress pgIn = new Progress();
 546                                                 Progress pgOut = new Progress();
 547                                                 if (pg != null) {
 548                                                         pg.setMax(2);
 549                                                         pg.addProgress(pgIn, 1);
 550                                                         pg.addProgress(pgOut, 1);
 551                                                 }
 552
 553                                                 Story story = support.process(pgIn);
 554                                                 try {
 555                                                         target = new File(target).getAbsolutePath();
 556                                                         BasicOutput.getOutput(type, infoCover, infoCover)
 557                                                                         .process(story, target, pgOut);
 558                                                 } catch (IOException e) {
 559                                                         Instance.getTraceHandler().error(
 560                                                                         new IOException(trans(StringId.ERR_SAVING,
 561                                                                                         target), e));
 562                                                         exitCode = 5;
 563                                                 }
 564                                         } else {
 565                                                 Instance.getTraceHandler().error(
 566                                                                 new IOException(trans(
 567                                                                                 StringId.ERR_NOT_SUPPORTED, source)));
 568
 569                                                 exitCode = 4;
 570                                         }
 571                                 } catch (IOException e) {
 572                                         Instance.getTraceHandler().error(
 573                                                         new IOException(trans(StringId.ERR_LOADING,
 574                                                                         sourceName), e));
 575                                         exitCode = 3;
 576                                 }
 577                         }
 578                 } catch (MalformedURLException e) {
 579                         Instance.getTraceHandler()
 580                                         .error(new IOException(trans(StringId.ERR_BAD_URL,
 581                                                         sourceName), e));
 582                         exitCode = 1;
 583                 }
 584
 585                 return exitCode;
 586         }
 587
 588         /**
 589          * Simple shortcut method to call {link Instance#getTrans()#getString()}.
 590          *
 591          * @param id
 592          *            the ID to translate
 593          *
 594          * @return the translated result
 595          */
 596         private static String trans(StringId id, Object... params) {
 597                 return Instance.getTrans().getString(id, params);
 598         }
 599
 600         /**
 601          * Display the correct syntax of the program to the user to stdout, or an
 602          * error message if the syntax used was wrong on stderr.
 603          *
 604          * @param showHelp
 605          *            TRUE to show the syntax help, FALSE to show "syntax error"
 606          */
 607         private static void syntax(boolean showHelp) {
 608                 if (showHelp) {
 609                         StringBuilder builder = new StringBuilder();
 610                         for (SupportType type : SupportType.values()) {
 611                                 builder.append(trans(StringId.ERR_SYNTAX_TYPE, type.toString(),
 612                                                 type.getDesc()));
 613                                 builder.append('\n');
 614                         }
 615
 616                         String typesIn = builder.toString();
 617                         builder.setLength(0);
 618
 619                         for (OutputType type : OutputType.values()) {
 620                                 builder.append(trans(StringId.ERR_SYNTAX_TYPE, type.toString(),
 621                                                 type.getDesc(true)));
 622                                 builder.append('\n');
 623                         }
 624
 625                         String typesOut = builder.toString();
 626
 627                         System.out.println(trans(StringId.HELP_SYNTAX, typesIn, typesOut));
 628                 } else {
 629                         System.err.println(trans(StringId.ERR_SYNTAX));
 630                 }
 631         }
 632
 633         /**
 634          * Set the default reader type for this session only (it can be changed in
 635          * the configuration file, too, but this value will override it).
 636          *
 637          * @param readerTypeString
 638          *            the type
 639          */
 640         private static int setReaderType(String readerTypeString) {
 641                 try {
 642                         ReaderType readerType = ReaderType.valueOf(readerTypeString
 643                                         .toUpperCase());
 644                         BasicReader.setDefaultReaderType(readerType);
 645                         return 0;
 646                 } catch (IllegalArgumentException e) {
 647                         Instance.getTraceHandler().error(
 648                                         new IOException("Unknown reader type: " + readerTypeString,
 649                                                         e));
 650                         return 1;
 651                 }
 652         }
 653 }