mirror of https://github.com/kiwix/kiwix-tools.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
272 lines
8.1 KiB
272 lines
8.1 KiB
/*
|
|
* 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 _WIN32
|
|
#include <unistd.h>
|
|
#endif
|
|
#include <getopt.h>
|
|
#include <kiwix/tools/stringTools.h>
|
|
#include <kiwix/manager.h>
|
|
#include <cstdlib>
|
|
#include <iostream>
|
|
|
|
using namespace std;
|
|
|
|
enum supportedAction { NONE, ADD, SHOW, REMOVE };
|
|
|
|
void show(kiwix::Library* library, const std::string& bookId)
|
|
{
|
|
try {
|
|
auto& book = library->getBookById(bookId);
|
|
std::cout << "id:\t\t" << book.getId() << std::endl
|
|
<< "path:\t\t" << book.getPath() << std::endl
|
|
<< "url:\t\t" << book.getUrl() << std::endl
|
|
<< "title:\t\t" << book.getTitle() << std::endl
|
|
<< "name:\t\t" << book.getName() << std::endl
|
|
<< "tags:\t\t" << book.getTags() << std::endl
|
|
<< "description:\t" << book.getDescription() << std::endl
|
|
<< "creator:\t" << book.getCreator() << std::endl
|
|
<< "date:\t\t" << book.getDate() << std::endl
|
|
<< "articleCount:\t" << book.getArticleCount() << std::endl
|
|
<< "mediaCount:\t" << book.getMediaCount() << std::endl
|
|
<< "size:\t\t" << book.getSize() << " KB" << std::endl;
|
|
} catch (std::out_of_range&) {
|
|
std::cout << "No book " << bookId << " in the library" << std::endl;
|
|
}
|
|
std::cout << std::endl;
|
|
}
|
|
|
|
/* Print correct console usage options */
|
|
void usage()
|
|
{
|
|
std::cout << "Usage:" << std::endl
|
|
<< "\tkiwix-manage LIBRARY_PATH add ZIM_PATH [OPTIONS]" << std::endl
|
|
<< "\tkiwix-manage LIBRARY_PATH remove ZIM_ID [ZIM_ID]..." << std::endl
|
|
<< "\tkiwix-manage LIBRARY_PATH show [ZIM_ID]..." << std::endl
|
|
<< std::endl
|
|
|
|
<< "Purpose:" << std::endl
|
|
<< "\tManipulates the Kiwix library XML file"
|
|
<< std::endl << std::endl
|
|
|
|
<< "Arguments:" << std::endl
|
|
<< "\tLIBRARY_PATH\tis the XML library file path."
|
|
<< std::endl << std::endl
|
|
<< "\tACTION\t\tis the pre-defined string to specify the action to run on the XML library file."
|
|
<< std::endl << std::endl
|
|
<< "\t\t\tMust be one of the following values:" << std::endl
|
|
<< "\t\t\t* add: add a ZIM file to the library" << std::endl
|
|
<< "\t\t\t* remove: remove a ZIM file from the library" << std::endl
|
|
<< "\t\t\t* show: show the content of the library"
|
|
<< std::endl << std::endl
|
|
<< "\tZIM_ID\t\tZIM file unique ID"
|
|
<< std::endl << std::endl
|
|
<< "\tOPTIONS\t\tCustom options for \"add\" action:" << std::endl
|
|
<< "\t\t\t--zimPathToSave=CUSTOM_ZIM_PATH to replace the current ZIM file path" << std::endl
|
|
<< "\t\t\t--url=HTTP_ZIM_URL to create an \"url\" attribute for the online version of the ZIM file" << std::endl
|
|
<< std::endl
|
|
|
|
<< "Examples:" << std::endl
|
|
<< "\tAdd ZIM files to library: kiwix-manage my_library.xml add first.zim second.zim" << std::endl
|
|
<< "\tRemove ZIM fiels from library: kiwix-manage my_library.xml remove e5c2c003-b49e-2756-5176-5d9c86393dd9" << std::endl
|
|
<< "\tShow all library ZIM files: kiwix-manage my_library.xml show" << std::endl
|
|
<< std::endl
|
|
|
|
<< "Documentation:" << std::endl
|
|
<< "\tSource code\thttps://github.com/kiwix/kiwix-tools" << std::endl
|
|
<< "\tMore info\thttps://wiki.kiwix.org/wiki/Kiwix-manage" << std::endl
|
|
<< std::endl;
|
|
}
|
|
|
|
bool handle_show(kiwix::Library* library, const std::string& libraryPath,
|
|
int argc, char* argv[])
|
|
{
|
|
if (argc > 3 ) {
|
|
for(auto i=3; i<argc; i++) {
|
|
std::string bookId = argv[i];
|
|
show(library, bookId);
|
|
}
|
|
} else {
|
|
auto booksIds = library->getBooksIds();
|
|
for(auto& bookId: booksIds) {
|
|
show(library, bookId);
|
|
}
|
|
}
|
|
return(0);
|
|
}
|
|
|
|
bool handle_add(kiwix::Library* library, const std::string& libraryPath,
|
|
int argc, char* argv[])
|
|
{
|
|
string zimPath;
|
|
string zimPathToSave = ".";
|
|
string url;
|
|
string origID = "";
|
|
int option_index = 0;
|
|
int c = 0;
|
|
bool resultCode = 0;
|
|
|
|
if (argc <= 3) {
|
|
std::cerr << "Path to zim file to add is missing in the command line" << std::endl;
|
|
return (-1);
|
|
}
|
|
|
|
/* Options parsing */
|
|
optind = 3;
|
|
static struct option long_options[] = {
|
|
{"url", required_argument, 0, 'u'},
|
|
{"origId", required_argument, 0, 'o'},
|
|
{"zimPathToSave", required_argument, 0, 'z'},
|
|
{0, 0, 0, 0}
|
|
};
|
|
|
|
bool has_option = false;
|
|
while (true) {
|
|
c = getopt_long(argc, argv, "cz:u:", long_options, &option_index);
|
|
if (c == -1)
|
|
break;
|
|
|
|
has_option = true;
|
|
switch (c) {
|
|
case 'u':
|
|
url = optarg;
|
|
break;
|
|
|
|
case 'o':
|
|
origID = optarg;
|
|
break;
|
|
|
|
case 'z':
|
|
zimPathToSave = optarg;
|
|
break;
|
|
}
|
|
}
|
|
|
|
if (optind >= argc) {
|
|
std::cerr << "Path to zim file to add is missing in the command line" << std::endl;
|
|
return (-1);
|
|
}
|
|
|
|
if (has_option && argc-optind > 1) {
|
|
std::cerr << "You cannot give option and several zim files to add" << std::endl;
|
|
return (-1);
|
|
}
|
|
|
|
kiwix::Manager manager(library);
|
|
|
|
for(auto i=optind; i<argc; i++) {
|
|
std::string zimPath = argv[i];
|
|
if (!zimPath.empty()) {
|
|
zimPathToSave = zimPathToSave == "." ? zimPath : zimPathToSave;
|
|
manager.addBookFromPathAndGetId(zimPath, zimPathToSave, url, false);
|
|
} else {
|
|
std::cerr << "Invalid zim file path" << std::endl;
|
|
resultCode = 1;
|
|
}
|
|
}
|
|
|
|
return(resultCode);
|
|
}
|
|
|
|
bool handle_remove(kiwix::Library* library, const std::string& libraryPath,
|
|
int argc, char* argv[])
|
|
{
|
|
std::string bookId;
|
|
const unsigned int totalBookCount = library->getBookCount(true, true);
|
|
bool exitCode = 0;
|
|
|
|
if (argc <= 3) {
|
|
std::cerr << "BookId to remove missing in the command line" << std::endl;
|
|
return (-1);
|
|
}
|
|
|
|
if (!totalBookCount) {
|
|
std::cerr << "Library is empty, no book to delete."
|
|
<< std::endl;
|
|
return 1;
|
|
}
|
|
|
|
for (int i = 3; i<argc; i++) {
|
|
bookId = argv[i];
|
|
|
|
if (!library->removeBookById(bookId)) {
|
|
std::cerr << "Invalid book id '" << bookId << "'." << std::endl;
|
|
exitCode = 1;
|
|
}
|
|
}
|
|
|
|
return(exitCode);
|
|
}
|
|
|
|
int main(int argc, char** argv)
|
|
{
|
|
string libraryPath = "";
|
|
supportedAction action = NONE;
|
|
kiwix::Library library;
|
|
|
|
/* Argument parsing */
|
|
if (argc > 2) {
|
|
libraryPath = argv[1];
|
|
string actionString = argv[2];
|
|
|
|
if (actionString == "add")
|
|
action = ADD;
|
|
else if (actionString == "show")
|
|
action = SHOW;
|
|
else if (actionString == "remove" || actionString == "delete")
|
|
action = REMOVE;
|
|
}
|
|
|
|
/* Print usage)) if necessary */
|
|
if (libraryPath == "" || action == NONE) {
|
|
usage();
|
|
exit(1);
|
|
}
|
|
|
|
/* Try to read the file */
|
|
libraryPath = isRelativePath(libraryPath)
|
|
? computeAbsolutePath(getCurrentDirectory(), libraryPath)
|
|
: libraryPath;
|
|
kiwix::Manager manager(&library);
|
|
manager.readFile(libraryPath, false);
|
|
|
|
/* SHOW */
|
|
bool exitCode = 0;
|
|
switch (action) {
|
|
case SHOW:
|
|
exitCode = handle_show(&library, libraryPath, argc, argv);
|
|
break;
|
|
case ADD:
|
|
exitCode = handle_add(&library, libraryPath, argc, argv);
|
|
break;
|
|
case REMOVE:
|
|
exitCode = handle_remove(&library, libraryPath, argc, argv);
|
|
break;
|
|
case NONE:
|
|
break;
|
|
}
|
|
|
|
/* Rewrite the library file */
|
|
if (action == REMOVE || action == ADD) {
|
|
library.writeToFile(libraryPath);
|
|
}
|
|
|
|
exit(exitCode);
|
|
}
|