kiwix-tools/src/installer/kiwix-install.cpp

/*
 * Copyright 2011 Emmanuel Engelhart <kelson@kiwix.org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU  General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA 02110-1301, USA.
 */

#include <getopt.h>
#include <pathTools.h>
#include <kiwix/xapianIndexer.h>

#ifndef _WIN32
#include <unistd.h>
#else
#include <Windows.h>
#include <io.h>
#endif

#include <kiwix/reader.h>
#include <kiwix/manager.h>

enum supportedBackend { XAPIAN };
enum supportedAction { NONE, ADDCONTENT };

void usage() {
    cout << "Usage: kiwix-install [--verbose] [--buildIndex] addcontent ZIM_PATH KIWIX_PATH" << endl;
    exit(1);
}

int main(int argc, char **argv) {

  /* Init the variables */
  const char *contentPath = NULL;
  const char *kiwixPath = NULL;
  supportedAction action = NONE;
  bool verboseFlag = false;
  bool buildIndexFlag = false;
  int option_index = 0;
  int c = 0;
  supportedBackend backend = XAPIAN;

  /* Argument parsing */
  while (42) {

    static struct option long_options[] = {
      {"verbose", no_argument, 0, 'v'},
      {"buildIndex", no_argument, 0, 'i'},
      {"backend", required_argument, 0, 'b'},
      {0, 0, 0, 0}
    };

    if (c != -1) {
      c = getopt_long(argc, argv, "vib:", long_options, &option_index);

      switch (c) {
	case 'v':
	  verboseFlag = true;
	  break;
        case 'i':
	  buildIndexFlag = true;
	  break;
	case 'b':
	  if (!strcmp(optarg, "xapian")) {
	    backend = XAPIAN;
	  } else {
	    usage();
	  }
	  break;
      }
    } else {
      if (optind < argc) {
	if (action == NONE) {
	  string actionString = argv[optind++];
	  if (actionString == "addcontent" || actionString == "ADDCONTENT") {
	    action = ADDCONTENT;
	  }
	} else if (contentPath == NULL) {
	  contentPath = argv[optind++];
	} else if (kiwixPath == NULL) {
	  kiwixPath = argv[optind++];
	} else {
	  usage();
	}
      } else {
	break;
      }
    }
  }

  /* Check if we have enough arguments */
  if (contentPath == NULL || kiwixPath == NULL) {
    usage();
  }

  /* Make the action */
  if (action == ADDCONTENT) {

    /* Check if the content path exists and is readable */
    if (verboseFlag) { std::cout << "Check if the ZIM file exists..." << std::endl; }
    if (!fileExists(contentPath)) {
      cerr << "The content path '" << contentPath << "' does not exist or is not readable." << endl;
      exit(1);
    }

    /* Check if this is a ZIM file */
    try {
      if (verboseFlag) { std::cout << "Check if the ZIM file is valid..." << std::endl; }
      kiwix::Reader *reader = new kiwix::Reader(contentPath);
      delete reader;
    } catch (exception &e) {
      cerr << "The content available at '" << contentPath << "' is not a ZIM file." << endl;
      exit(1);
    }
    string contentFilename = getLastPathElement(contentPath);

    /* Check if kiwixPath/kiwix/kiwix.exe exists */
    if (verboseFlag) { std::cout << "Check if the Kiwix path is valid..." << std::endl; }
    string kiwixBinaryPath = computeAbsolutePath(kiwixPath, "kiwix/kiwix.exe");
    if (!fileExists(kiwixBinaryPath)) {
      kiwixBinaryPath = computeAbsolutePath(kiwixPath, "kiwix/kiwix");
      if (!fileExists(kiwixBinaryPath)) {
	cerr << "Unable to find the Kiwix binary at '" << kiwixBinaryPath << "[.exe]'." << endl;
	exit(1);
      }
    }

    /* Check if the directory "data" structure exists */
    if (verboseFlag) { std::cout << "Check the target data directory structure..." << std::endl; }
    string dataPath = computeAbsolutePath(kiwixPath, "data/");
    if (!fileExists(dataPath)) {
      makeDirectory(dataPath);
    }

    /* Check if the directory "data/content" structure exists */
    string dataContentPath = computeAbsolutePath(kiwixPath, "data/content/");
    if (!fileExists(dataContentPath)) {
      makeDirectory(dataContentPath);
    }

    /* Check if the directory "data/library" structure exists */
    string dataLibraryPath = computeAbsolutePath(kiwixPath, "data/library/");
    if (!fileExists(dataLibraryPath)) {
      makeDirectory(dataLibraryPath);
    }

    /* Check if the directory "data/index" structure exists */
    string dataIndexPath = computeAbsolutePath(kiwixPath, "data/index/");
    if (!fileExists(dataIndexPath)) {
      makeDirectory(dataIndexPath);
    }

    /* Copy the file to the data/content directory */
    if (verboseFlag) { std::cout << "Copy ZIM file to the target directory..." << std::endl; }
    string newContentPath = computeAbsolutePath(dataContentPath, contentFilename);
    if (!fileExists(newContentPath) || getFileSize(contentPath) != getFileSize(newContentPath)) {
      copyFile(contentPath, newContentPath);
    }

    /* Index the file if necessary */
    if (verboseFlag) { std::cout << "Check if the index directory exists..." << std::endl; }
    string indexFilename = contentFilename + ".idx";
    string indexPath = computeAbsolutePath(dataIndexPath, indexFilename);
    if (buildIndexFlag && !fileExists(indexPath)) {
      if (verboseFlag) { std::cout << "Start indexing the ZIM file..." << std::endl; }
      kiwix::Indexer *indexer = NULL;
      try {
	  indexer = new kiwix::XapianIndexer();
      } catch (...) {
	cerr << "Unable to index '" << contentPath << "'." << endl;
	exit(1);
      }

      if (indexer != NULL) {
	indexer->setVerboseFlag(verboseFlag);
	indexer->start(contentPath, indexPath);
	while (indexer->isRunning()) {
#ifdef _WIN32
	  Sleep(1000);
#else
	  sleep(1);
#endif
	}
	delete indexer;
      } else {
	cerr << "Unable instanciate the Kiwix indexer." << endl;
	exit(1);
      }
    }

    /* Add the file to the library.xml */
    if (verboseFlag) { std::cout << "Create the library XML file..." << std::endl; }
    kiwix::Manager libraryManager;
    string libraryPath = computeAbsolutePath(dataLibraryPath, contentFilename + ".xml");
    string bookId = libraryManager.addBookFromPathAndGetId(newContentPath, "../content/" + contentFilename, "", false);
    if (!bookId.empty()) {
      libraryManager.setCurrentBookId(bookId);
      if (buildIndexFlag) {
	libraryManager.setBookIndex(bookId, "../index/" + indexFilename, kiwix::XAPIAN);
      }
      libraryManager.writeFile(libraryPath);
    } else {
      cerr << "Unable to build or save library file '" << libraryPath << "'" << endl;
    }
  }

  exit(0);
}