mirror of
https://github.com/kiwix/libkiwix.git
synced 2025-06-26 10:11:30 +00:00
0bd5a5ec3b
While it was "ok" to store raw pointer as, in our use case, the library always live longer than object using it; it is not safe to store raw pointer on object than may be deleted. All classes storing a library now store a shared_ptr. Functionr only using the library (as `HumanReadableNameMapper`) continue to use a (const) reference.
124 lines
3.2 KiB
C++
124 lines
3.2 KiB
C++
/*
|
|
* Copyright 2017 Matthieu Gautier <mgautier@kymeria.fr>
|
|
*
|
|
* 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_OPDS_DUMPER_H
|
|
#define KIWIX_OPDS_DUMPER_H
|
|
|
|
#include <time.h>
|
|
#include <sstream>
|
|
#include <string>
|
|
|
|
#include <pugixml.hpp>
|
|
|
|
#include "library.h"
|
|
#include "name_mapper.h"
|
|
|
|
using namespace std;
|
|
|
|
namespace kiwix
|
|
{
|
|
|
|
/**
|
|
* A tool to dump a `Library` into a opds stream.
|
|
*
|
|
*/
|
|
class OPDSDumper
|
|
{
|
|
public:
|
|
OPDSDumper() = default;
|
|
OPDSDumper(std::shared_ptr<Library> library, NameMapper* NameMapper);
|
|
~OPDSDumper();
|
|
|
|
/**
|
|
* Dump the OPDS feed.
|
|
*
|
|
* @param bookIds the ids of the books to include in the feed
|
|
* @param query the query used to obtain the list of book ids
|
|
* @return The OPDS feed.
|
|
*/
|
|
std::string dumpOPDSFeed(const std::vector<std::string>& bookIds, const std::string& query) const;
|
|
|
|
/**
|
|
* Dump the OPDS feed.
|
|
*
|
|
* @param bookIds the ids of the books to include in the feed
|
|
* @param query the query used to obtain the list of book ids
|
|
* @param partial whether the feed should include partial or complete entries
|
|
* @return The OPDS feed.
|
|
*/
|
|
std::string dumpOPDSFeedV2(const std::vector<std::string>& bookIds, const std::string& query, bool partial) const;
|
|
|
|
/**
|
|
* Dump the OPDS complete entry document.
|
|
*
|
|
* @param bookId the id of the book
|
|
* @return The OPDS complete entry document.
|
|
*/
|
|
std::string dumpOPDSCompleteEntry(const std::string& bookId) const;
|
|
|
|
/**
|
|
* Dump the categories OPDS feed.
|
|
*
|
|
* @return The OPDS feed.
|
|
*/
|
|
std::string categoriesOPDSFeed() const;
|
|
|
|
/**
|
|
* Dump the languages OPDS feed.
|
|
*
|
|
* @return The OPDS feed.
|
|
*/
|
|
std::string languagesOPDSFeed() const;
|
|
|
|
/**
|
|
* Set the id of the library.
|
|
*
|
|
* @param id the id to use.
|
|
*/
|
|
void setLibraryId(const std::string& id) { this->libraryId = id;}
|
|
|
|
/**
|
|
* Set the root location used when generating url.
|
|
*
|
|
* @param rootLocation the root location to use.
|
|
*/
|
|
void setRootLocation(const std::string& rootLocation) { this->rootLocation = rootLocation; }
|
|
|
|
/**
|
|
* Set some informations about the search results.
|
|
*
|
|
* @param totalResult the total number of results of the search.
|
|
* @param startIndex the start index of the result.
|
|
* @param count the number of result of the current set (or page).
|
|
*/
|
|
void setOpenSearchInfo(int totalResult, int startIndex, int count);
|
|
|
|
protected:
|
|
std::shared_ptr<kiwix::Library> library;
|
|
kiwix::NameMapper* nameMapper;
|
|
std::string libraryId;
|
|
std::string rootLocation;
|
|
int m_totalResults;
|
|
int m_startIndex;
|
|
int m_count;
|
|
};
|
|
}
|
|
|
|
#endif // KIWIX_OPDS_DUMPER_H
|