/*
 * 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.
 */

#ifndef KIWIX_LIBRARY_H
#define KIWIX_LIBRARY_H

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <stack>
#include <string>
#include <vector>

#include "common/regexTools.h"
#include "common/stringTools.h"

#define KIWIX_LIBRARY_VERSION "20110515"

using namespace std;

namespace kiwix
{
enum supportedIndexType { UNKNOWN, XAPIAN };


/**
 * A class to store information about a book (a zim file)
 */
class Book
{
 public:
  Book();
  ~Book();

  static bool sortByLastOpen(const Book& a, const Book& b);
  static bool sortByTitle(const Book& a, const Book& b);
  static bool sortBySize(const Book& a, const Book& b);
  static bool sortByDate(const Book& a, const Book& b);
  static bool sortByCreator(const Book& a, const Book& b);
  static bool sortByPublisher(const Book& a, const Book& b);
  static bool sortByLanguage(const Book& a, const Book& b);
  string getHumanReadableIdFromPath();

  string id;
  string path;
  string pathAbsolute;
  string last;
  string indexPath;
  string indexPathAbsolute;
  supportedIndexType indexType;
  string title;
  string description;
  string language;
  string creator;
  string publisher;
  string date;
  string url;
  string name;
  string tags;
  string origId;
  string articleCount;
  string mediaCount;
  bool readOnly;
  string size;
  string favicon;
  string faviconMimeType;
};

/**
 * A Library store several books.
 */
class Library
{
 public:
  Library();
  ~Library();

  string version;
  /**
   * Add a book to the library.
   *
   * If a book already exist in the library with the same id, update
   * the existing book instead of adding a new one.
   *
   * @param book The book to add.
   * @return True if the book has been added.
   *         False if a book has been updated.
   */
  bool addBook(const Book& book);

  /**
   * Remove a book from the library.
   *
   * @param bookIndex the index of the book to remove.
   * @return True
   */
  bool removeBookByIndex(const unsigned int bookIndex);
  vector<kiwix::Book> books;

  /*
   * 'current' is the variable storing the current content/book id
   * in the library. This is used to be able to load per default a
   * content. As Kiwix may work with many library XML files, you may
   * have "current" defined many time with different values. The
   * last XML file read has the priority, Although we do not have an
   * library object for each file, we want to be able to fallback to
   * an 'old' current book if the one which should be load
   * failed. That is the reason why we need a stack here
   */
  stack<string> current;
};
}

#endif