From f1873876b2a4675369c0e044e5924542a39ac406 Mon Sep 17 00:00:00 2001 From: Nikhil Tanwar <2002nikhiltanwar@gmail.com> Date: Fri, 3 Mar 2023 00:30:58 +0530 Subject: [PATCH 01/14] Extract LibraryDumper from OPDSDumper This change creates a new common class for dumping the library into various formats: LibraryDumper --- include/library_dumper.h | 91 +++++++++++++++++++++++++++++ include/opds_dumper.h | 38 +----------- src/library_dumper.cpp | 121 +++++++++++++++++++++++++++++++++++++++ src/meson.build | 1 + src/opds_dumper.cpp | 94 ++---------------------------- 5 files changed, 220 insertions(+), 125 deletions(-) create mode 100644 include/library_dumper.h create mode 100644 src/library_dumper.cpp diff --git a/include/library_dumper.h b/include/library_dumper.h new file mode 100644 index 000000000..3438ef711 --- /dev/null +++ b/include/library_dumper.h @@ -0,0 +1,91 @@ +/* + * Copyright 2023 Nikhil Tanwar <2002nikhiltanwar@gmail.com> + * Copyright 2017 Matthieu Gautier + * + * 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_DUMPER_H +#define KIWIX_LIBRARY_DUMPER_H + +#include + + +#include "library.h" +#include "name_mapper.h" +#include + +namespace kiwix +{ + +/** + * A base class to dump Library in various formats. + * + */ +class LibraryDumper +{ + public: + LibraryDumper(const Library* library, const NameMapper* NameMapper); + ~LibraryDumper(); + + 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); + + /** + * Sets user default language + * + * @param userLang the user language to be set + */ + void setUserLanguage(std::string userLang) { this->m_userLang = userLang; } + + /** + * Get the data of categories + */ + kainjow::mustache::list getCategoryData() const; + + /** + * Get the data of languages + */ + kainjow::mustache::list getLanguageData() const; + + protected: + const kiwix::Library* const library; + const kiwix::NameMapper* const nameMapper; + std::string libraryId; + std::string rootLocation; + std::string m_userLang; + int m_totalResults; + int m_startIndex; + int m_count; +}; +} + +#endif // KIWIX_LIBRARY_DUMPER_H diff --git a/include/opds_dumper.h b/include/opds_dumper.h index cb6566f4f..c2f5ff182 100644 --- a/include/opds_dumper.h +++ b/include/opds_dumper.h @@ -28,6 +28,7 @@ #include "library.h" #include "name_mapper.h" +#include "library_dumper.h" using namespace std; @@ -38,11 +39,10 @@ namespace kiwix * A tool to dump a `Library` into a opds stream. * */ -class OPDSDumper +class OPDSDumper : public LibraryDumper { public: - OPDSDumper() = default; - OPDSDumper(Library* library, NameMapper* NameMapper); + OPDSDumper(const Library* library, const NameMapper* NameMapper); ~OPDSDumper(); /** @@ -85,38 +85,6 @@ class OPDSDumper * @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: - kiwix::Library* library; - kiwix::NameMapper* nameMapper; - std::string libraryId; - std::string rootLocation; - int m_totalResults; - int m_startIndex; - int m_count; }; } diff --git a/src/library_dumper.cpp b/src/library_dumper.cpp new file mode 100644 index 000000000..81880db3b --- /dev/null +++ b/src/library_dumper.cpp @@ -0,0 +1,121 @@ +#include "library_dumper.h" +#include "tools/stringTools.h" +#include "tools/otherTools.h" +#include "tools.h" +#include "tools/regexTools.h" + +namespace kiwix +{ +/* Constructor */ +LibraryDumper::LibraryDumper(const Library* library, const NameMapper* nameMapper) + : library(library), + nameMapper(nameMapper) +{ +} +/* Destructor */ +LibraryDumper::~LibraryDumper() +{ +} + +void LibraryDumper::setOpenSearchInfo(int totalResults, int startIndex, int count) +{ + m_totalResults = totalResults; + m_startIndex = startIndex, + m_count = count; +} + +namespace { + +std::map iso639_3 = { + {"atj", "atikamekw"}, + {"azb", "آذربایجان دیلی"}, + {"bcl", "central bikol"}, + {"bgs", "tagabawa"}, + {"bxr", "буряад хэлэн"}, + {"cbk", "chavacano"}, + {"cdo", "閩東語"}, + {"dag", "Dagbani"}, + {"diq", "dimli"}, + {"dty", "डोटेली"}, + {"eml", "emiliân-rumagnōl"}, + {"fbs", "српскохрватски"}, + {"hbs", "srpskohrvatski"}, + {"ido", "ido"}, + {"kbp", "kabɩyɛ"}, + {"kld", "Gamilaraay"}, + {"lbe", "лакку маз"}, + {"lbj", "ལ་དྭགས་སྐད་"}, + {"map", "Austronesian"}, + {"mhr", "марий йылме"}, + {"mnw", "ဘာသာမန်"}, + {"myn", "mayan"}, + {"nah", "nahuatl"}, + {"nai", "north American Indian"}, + {"nds", "plattdütsch"}, + {"nrm", "bhasa narom"}, + {"olo", "livvi"}, + {"pih", "Pitcairn-Norfolk"}, + {"pnb", "Western Panjabi"}, + {"rmr", "Caló"}, + {"rmy", "romani shib"}, + {"roa", "romance languages"}, + {"twi", "twi"}, +}; + +std::once_flag fillLanguagesFlag; + +void fillLanguagesMap() +{ + for (auto icuLangPtr = icu::Locale::getISOLanguages(); *icuLangPtr != NULL; ++icuLangPtr) { + const ICULanguageInfo lang(*icuLangPtr); + iso639_3.insert({lang.iso3Code(), lang.selfName()}); + } +} + +std::string getLanguageSelfName(const std::string& lang) { + const auto itr = iso639_3.find(lang); + if (itr != iso639_3.end()) { + return itr->second; + } + return lang; +}; + +} // unnamed namespace + +kainjow::mustache::list LibraryDumper::getCategoryData() const +{ + const auto now = gen_date_str(); + kainjow::mustache::list categoryData; + for ( const auto& category : library->getBooksCategories() ) { + const auto urlencodedCategoryName = urlEncode(category); + categoryData.push_back(kainjow::mustache::object{ + {"name", category}, + {"urlencoded_name", urlencodedCategoryName}, + {"updated", now}, + {"id", gen_uuid(libraryId + "/categories/" + urlencodedCategoryName)} + }); + } + return categoryData; +} + +kainjow::mustache::list LibraryDumper::getLanguageData() const +{ + const auto now = gen_date_str(); + kainjow::mustache::list languageData; + std::call_once(fillLanguagesFlag, fillLanguagesMap); + for ( const auto& langAndBookCount : library->getBooksLanguagesWithCounts() ) { + const std::string languageCode = langAndBookCount.first; + const int bookCount = langAndBookCount.second; + const auto languageSelfName = getLanguageSelfName(languageCode); + languageData.push_back(kainjow::mustache::object{ + {"lang_code", languageCode}, + {"lang_self_name", languageSelfName}, + {"book_count", to_string(bookCount)}, + {"updated", now}, + {"id", gen_uuid(libraryId + "/languages/" + languageCode)} + }); + } + return languageData; +} + +} // namespace kiwix diff --git a/src/meson.build b/src/meson.build index 3c486fb18..3bbb24f98 100644 --- a/src/meson.build +++ b/src/meson.build @@ -5,6 +5,7 @@ kiwix_sources = [ 'manager.cpp', 'libxml_dumper.cpp', 'opds_dumper.cpp', + 'library_dumper.cpp', 'downloader.cpp', 'server.cpp', 'search_renderer.cpp', diff --git a/src/opds_dumper.cpp b/src/opds_dumper.cpp index 1104029ac..a8b1be9ed 100644 --- a/src/opds_dumper.cpp +++ b/src/opds_dumper.cpp @@ -30,9 +30,8 @@ namespace kiwix { /* Constructor */ -OPDSDumper::OPDSDumper(Library* library, NameMapper* nameMapper) - : library(library), - nameMapper(nameMapper) +OPDSDumper::OPDSDumper(const Library* library, const NameMapper* nameMapper) + : LibraryDumper(library, nameMapper) { } /* Destructor */ @@ -40,13 +39,6 @@ OPDSDumper::~OPDSDumper() { } -void OPDSDumper::setOpenSearchInfo(int totalResults, int startIndex, int count) -{ - m_totalResults = totalResults; - m_startIndex = startIndex, - m_count = count; -} - namespace { @@ -133,60 +125,6 @@ BooksData getBooksData(const Library* library, const NameMapper* nameMapper, con return booksData; } -std::map iso639_3 = { - {"atj", "atikamekw"}, - {"azb", "آذربایجان دیلی"}, - {"bcl", "central bikol"}, - {"bgs", "tagabawa"}, - {"bxr", "буряад хэлэн"}, - {"cbk", "chavacano"}, - {"cdo", "閩東語"}, - {"dag", "Dagbani"}, - {"diq", "dimli"}, - {"dty", "डोटेली"}, - {"eml", "emiliân-rumagnōl"}, - {"fbs", "српскохрватски"}, - {"hbs", "srpskohrvatski"}, - {"ido", "ido"}, - {"kbp", "kabɩyɛ"}, - {"kld", "Gamilaraay"}, - {"lbe", "лакку маз"}, - {"lbj", "ལ་དྭགས་སྐད་"}, - {"map", "Austronesian"}, - {"mhr", "марий йылме"}, - {"mnw", "ဘာသာမန်"}, - {"myn", "mayan"}, - {"nah", "nahuatl"}, - {"nai", "north American Indian"}, - {"nds", "plattdütsch"}, - {"nrm", "bhasa narom"}, - {"olo", "livvi"}, - {"pih", "Pitcairn-Norfolk"}, - {"pnb", "Western Panjabi"}, - {"rmr", "Caló"}, - {"rmy", "romani shib"}, - {"roa", "romance languages"}, - {"twi", "twi"}, -}; - -std::once_flag fillLanguagesFlag; - -void fillLanguagesMap() -{ - for (auto icuLangPtr = icu::Locale::getISOLanguages(); *icuLangPtr != NULL; ++icuLangPtr) { - const ICULanguageInfo lang(*icuLangPtr); - iso639_3.insert({lang.iso3Code(), lang.selfName()}); - } -} - -std::string getLanguageSelfName(const std::string& lang) { - const auto itr = iso639_3.find(lang); - if (itr != iso639_3.end()) { - return itr->second; - } - return lang; -}; - } // unnamed namespace string OPDSDumper::dumpOPDSFeed(const std::vector& bookIds, const std::string& query) const @@ -240,17 +178,7 @@ std::string OPDSDumper::dumpOPDSCompleteEntry(const std::string& bookId) const std::string OPDSDumper::categoriesOPDSFeed() const { const auto now = gen_date_str(); - kainjow::mustache::list categoryData; - for ( const auto& category : library->getBooksCategories() ) { - const auto urlencodedCategoryName = urlEncode(category); - categoryData.push_back(kainjow::mustache::object{ - {"name", category}, - {"urlencoded_name", urlencodedCategoryName}, - {"updated", now}, - {"id", gen_uuid(libraryId + "/categories/" + urlencodedCategoryName)} - }); - } - + kainjow::mustache::list categoryData = getCategoryData(); return render_template( RESOURCE::templates::catalog_v2_categories_xml, kainjow::mustache::object{ @@ -265,21 +193,7 @@ std::string OPDSDumper::categoriesOPDSFeed() const std::string OPDSDumper::languagesOPDSFeed() const { const auto now = gen_date_str(); - kainjow::mustache::list languageData; - std::call_once(fillLanguagesFlag, fillLanguagesMap); - for ( const auto& langAndBookCount : library->getBooksLanguagesWithCounts() ) { - const std::string languageCode = langAndBookCount.first; - const int bookCount = langAndBookCount.second; - const auto languageSelfName = getLanguageSelfName(languageCode); - languageData.push_back(kainjow::mustache::object{ - {"lang_code", languageCode}, - {"lang_self_name", languageSelfName}, - {"book_count", to_string(bookCount)}, - {"updated", now}, - {"id", gen_uuid(libraryId + "/languages/" + languageCode)} - }); - } - + kainjow::mustache::list languageData = getLanguageData(); return render_template( RESOURCE::templates::catalog_v2_languages_xml, kainjow::mustache::object{ From d8656ec149d7e8de0c58017cb7e88cf3c04207e4 Mon Sep 17 00:00:00 2001 From: Nikhil Tanwar <2002nikhiltanwar@gmail.com> Date: Fri, 3 Mar 2023 00:40:04 +0530 Subject: [PATCH 02/14] Introduce HTMLDumper HTMLDumper class will be used to dump library in HTML format. It inherits from LibraryDumper --- include/html_dumper.h | 50 ++++++++++++++++++++++++ src/html_dumper.cpp | 37 ++++++++++++++++++ src/meson.build | 1 + src/server/internalServer.cpp | 1 + static/resources_list.txt | 1 + static/templates/no_js_library_page.html | 40 +++++++++++++++++++ 6 files changed, 130 insertions(+) create mode 100644 include/html_dumper.h create mode 100644 src/html_dumper.cpp create mode 100644 static/templates/no_js_library_page.html diff --git a/include/html_dumper.h b/include/html_dumper.h new file mode 100644 index 000000000..fd09659db --- /dev/null +++ b/include/html_dumper.h @@ -0,0 +1,50 @@ +/* + * Copyright 2023 Nikhil Tanwar <2002nikhiltanwar@gmail.com> + * + * 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_HTML_DUMPER_H +#define KIWIX_HTML_DUMPER_H + +#include + +#include "library_dumper.h" + +namespace kiwix +{ + +/** + * A class to dump Library in HTML format. + */ +class HTMLDumper : public LibraryDumper +{ + public: + HTMLDumper(const Library* library, const NameMapper* NameMapper); + ~HTMLDumper(); + + + /** + * Dump library in HTML + * + * @return HTML content + */ + std::string dumpPlainHTML() const; +}; + +} + +#endif // KIWIX_HTML_DUMPER_H diff --git a/src/html_dumper.cpp b/src/html_dumper.cpp new file mode 100644 index 000000000..919e4bcea --- /dev/null +++ b/src/html_dumper.cpp @@ -0,0 +1,37 @@ +#include "html_dumper.h" +#include "libkiwix-resources.h" +#include "tools/otherTools.h" + +namespace kiwix +{ + +/* Constructor */ +HTMLDumper::HTMLDumper(const Library* library, const NameMapper* nameMapper) + : LibraryDumper(library, nameMapper) +{ +} +/* Destructor */ +HTMLDumper::~HTMLDumper() +{ +} + +std::string HTMLDumper::dumpPlainHTML() const +{ + kainjow::mustache::list booksData; + for ( const auto& bookId : library->getBooksIds() ) { + const auto bookEx = library->getBookById(bookId); + const auto bookName = bookEx.getName(); + booksData.push_back(kainjow::mustache::object{ + {"name", bookName} + }); + } + + return render_template( + RESOURCE::templates::no_js_library_page_html, + kainjow::mustache::object{ + {"books", booksData } + } + ); +} + +} // namespace kiwix diff --git a/src/meson.build b/src/meson.build index 3bbb24f98..21486bc4e 100644 --- a/src/meson.build +++ b/src/meson.build @@ -5,6 +5,7 @@ kiwix_sources = [ 'manager.cpp', 'libxml_dumper.cpp', 'opds_dumper.cpp', + 'html_dumper.cpp', 'library_dumper.cpp', 'downloader.cpp', 'server.cpp', diff --git a/src/server/internalServer.cpp b/src/server/internalServer.cpp index 8db0f81f3..b787cb03f 100644 --- a/src/server/internalServer.cpp +++ b/src/server/internalServer.cpp @@ -53,6 +53,7 @@ extern "C" { #include "name_mapper.h" #include "search_renderer.h" #include "opds_dumper.h" +#include "html_dumper.h" #include "i18n.h" #include diff --git a/static/resources_list.txt b/static/resources_list.txt index 69f8bf961..516c8bfc6 100644 --- a/static/resources_list.txt +++ b/static/resources_list.txt @@ -37,6 +37,7 @@ templates/catalog_v2_categories.xml templates/catalog_v2_languages.xml templates/url_of_search_results_css templates/viewer_settings.js +templates/no_js_library_page.html opensearchdescription.xml ft_opensearchdescription.xml catalog_v2_searchdescription.xml diff --git a/static/templates/no_js_library_page.html b/static/templates/no_js_library_page.html new file mode 100644 index 000000000..0281d85ba --- /dev/null +++ b/static/templates/no_js_library_page.html @@ -0,0 +1,40 @@ + + + + + + + Welcome to Kiwix Server + + + + + + + + + + + + + + VERY REAL TEST :)))))))) + {{#books}} +
{{name}}
+ {{/books}} + + \ No newline at end of file From dca47d35f76f648a535ae597924ae4552e4e3cca Mon Sep 17 00:00:00 2001 From: Nikhil Tanwar <2002nikhiltanwar@gmail.com> Date: Mon, 13 Feb 2023 03:21:56 +0530 Subject: [PATCH 03/14] Introduce /nojs endpoint Adds /nojs endpoint for fallback. Currently, it serves an HTML with book names in library --- src/server/internalServer.cpp | 16 ++++++++++++++++ src/server/internalServer.h | 1 + 2 files changed, 17 insertions(+) diff --git a/src/server/internalServer.cpp b/src/server/internalServer.cpp index b787cb03f..a0236f3e6 100644 --- a/src/server/internalServer.cpp +++ b/src/server/internalServer.cpp @@ -628,6 +628,9 @@ std::unique_ptr InternalServer::handle_request(const RequestContext& r if (isEndpointUrl(url, "search")) return handle_search(request); + if (isEndpointUrl(url, "nojs")) + return handle_no_js(request); + if (isEndpointUrl(url, "suggest")) return handle_suggest(request); @@ -756,6 +759,19 @@ std::unique_ptr InternalServer::handle_viewer_settings(const RequestCo return ContentResponse::build(*this, RESOURCE::templates::viewer_settings_js, data, "application/javascript; charset=utf-8"); } +std::unique_ptr InternalServer::handle_no_js(const RequestContext& request) +{ + HTMLDumper htmlDumper(mp_library, mp_nameMapper); + htmlDumper.setRootLocation(m_root); + htmlDumper.setLibraryId(getLibraryId()); + return ContentResponse::build( + *this, + htmlDumper.dumpPlainHTML(), + "text/html; charset=utf-8" + ); +} + + namespace { diff --git a/src/server/internalServer.h b/src/server/internalServer.h index b852afa52..a9e0070c8 100644 --- a/src/server/internalServer.h +++ b/src/server/internalServer.h @@ -131,6 +131,7 @@ class InternalServer { std::unique_ptr handle_catalog_v2_entries(const RequestContext& request, bool partial); std::unique_ptr handle_catalog_v2_complete_entry(const RequestContext& request, const std::string& entryId); std::unique_ptr handle_catalog_v2_categories(const RequestContext& request); + std::unique_ptr handle_no_js(const RequestContext& request); std::unique_ptr handle_catalog_v2_languages(const RequestContext& request); std::unique_ptr handle_catalog_v2_illustration(const RequestContext& request); std::unique_ptr handle_search(const RequestContext& request); From 6071b98fb730e6f52a59e3550535803a67b5f85d Mon Sep 17 00:00:00 2001 From: Nikhil Tanwar <2002nikhiltanwar@gmail.com> Date: Mon, 13 Feb 2023 04:35:53 +0530 Subject: [PATCH 04/14] Import book tiles Tries to copy the same design of tiles as main page with javascript enabled --- src/html_dumper.cpp | 14 ++++++++-- static/templates/no_js_library_page.html | 35 +++++++++++++++++++++--- 2 files changed, 42 insertions(+), 7 deletions(-) diff --git a/src/html_dumper.cpp b/src/html_dumper.cpp index 919e4bcea..9122a723a 100644 --- a/src/html_dumper.cpp +++ b/src/html_dumper.cpp @@ -19,16 +19,24 @@ std::string HTMLDumper::dumpPlainHTML() const { kainjow::mustache::list booksData; for ( const auto& bookId : library->getBooksIds() ) { - const auto bookEx = library->getBookById(bookId); - const auto bookName = bookEx.getName(); + const auto bookObj = library->getBookById(bookId); + const auto bookTitle = bookObj.getTitle(); + const auto bookDescription = bookObj.getDescription(); + const auto langCode = bookObj.getCommaSeparatedLanguages(); + const auto bookIconUrl = rootLocation + "/catalog/v2/illustration/" + bookId + "/?size=48"; + std::string faviconAttr = "style=background-image:url(" + bookIconUrl + ")"; booksData.push_back(kainjow::mustache::object{ - {"name", bookName} + {"title", bookTitle}, + {"description", bookDescription}, + {"langCode", langCode}, + {"faviconAttr", faviconAttr} }); } return render_template( RESOURCE::templates::no_js_library_page_html, kainjow::mustache::object{ + {"root", rootLocation}, {"books", booksData } } ); diff --git a/static/templates/no_js_library_page.html b/static/templates/no_js_library_page.html index 0281d85ba..69f1c6ecc 100644 --- a/static/templates/no_js_library_page.html +++ b/static/templates/no_js_library_page.html @@ -29,12 +29,39 @@ font-family: "roboto"; src: url("{{root}}/skin/fonts/Roboto.ttf?KIWIXCACHEID") format("truetype"); } + + .book__list { + display: flex; + flex-direction: row; + flex-wrap: wrap; + align-items: center; + } + + .book__wrapper:hover { + transform: scale(1.0); + } - VERY REAL TEST :)))))))) - {{#books}} -
{{name}}
- {{/books}} +
+
+ {{#books}} +
+ +
+
+
+
{{title}}
+
+
{{description}}
+
+ +
{{langCode}}
+
TO DO: TAGS
+
+
+ {{/books}} +
+
\ No newline at end of file From c1d7cc37fd42b2708cbd2d17b597cf7a551d0a0d Mon Sep 17 00:00:00 2001 From: Nikhil Tanwar <2002nikhiltanwar@gmail.com> Date: Mon, 13 Feb 2023 18:12:49 +0530 Subject: [PATCH 05/14] Add tags in tiles for /nojs endpoint Adds span elements for tags --- src/html_dumper.cpp | 22 +++++++++++++++++++++- static/templates/no_js_library_page.html | 10 +++++++++- 2 files changed, 30 insertions(+), 2 deletions(-) diff --git a/src/html_dumper.cpp b/src/html_dumper.cpp index 9122a723a..6674080a2 100644 --- a/src/html_dumper.cpp +++ b/src/html_dumper.cpp @@ -1,6 +1,7 @@ #include "html_dumper.h" #include "libkiwix-resources.h" #include "tools/otherTools.h" +#include "tools.h" namespace kiwix { @@ -15,6 +16,23 @@ HTMLDumper::~HTMLDumper() { } +namespace { + +kainjow::mustache::list getTagList(std::string tags) +{ + const auto tagsList = kiwix::split(tags, ";", true, false); + kainjow::mustache::list finalTagList; + for (auto tag : tagsList) { + if (tag[0] != '_') + finalTagList.push_back(kainjow::mustache::object{ + {"tag", tag} + }); + } + return finalTagList; +} + +} // unnamed namespace + std::string HTMLDumper::dumpPlainHTML() const { kainjow::mustache::list booksData; @@ -24,12 +42,14 @@ std::string HTMLDumper::dumpPlainHTML() const const auto bookDescription = bookObj.getDescription(); const auto langCode = bookObj.getCommaSeparatedLanguages(); const auto bookIconUrl = rootLocation + "/catalog/v2/illustration/" + bookId + "/?size=48"; + const auto tags = bookObj.getTags(); std::string faviconAttr = "style=background-image:url(" + bookIconUrl + ")"; booksData.push_back(kainjow::mustache::object{ {"title", bookTitle}, {"description", bookDescription}, {"langCode", langCode}, - {"faviconAttr", faviconAttr} + {"faviconAttr", faviconAttr}, + {"tagList", getTagList(tags)} }); } diff --git a/static/templates/no_js_library_page.html b/static/templates/no_js_library_page.html index 69f1c6ecc..2db51a0d6 100644 --- a/static/templates/no_js_library_page.html +++ b/static/templates/no_js_library_page.html @@ -40,6 +40,10 @@ .book__wrapper:hover { transform: scale(1.0); } + + .tag__link { + pointer-events: none; + } @@ -57,7 +61,11 @@
{{langCode}}
-
TO DO: TAGS
+
+ {{#tagList}} + {{tag}} + {{/tagList}} +
{{/books}} From dbded6eee2fc4497cfadd26055906b9a028e9f74 Mon Sep 17 00:00:00 2001 From: Nikhil Tanwar <2002nikhiltanwar@gmail.com> Date: Tue, 14 Feb 2023 00:32:22 +0530 Subject: [PATCH 06/14] Add links to content for tiles in /nojs If the tiles are now clicked, they redirect to main page of book. --- src/html_dumper.cpp | 5 +++++ static/templates/no_js_library_page.html | 2 +- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/src/html_dumper.cpp b/src/html_dumper.cpp index 6674080a2..277dc92ec 100644 --- a/src/html_dumper.cpp +++ b/src/html_dumper.cpp @@ -39,12 +39,17 @@ std::string HTMLDumper::dumpPlainHTML() const for ( const auto& bookId : library->getBooksIds() ) { const auto bookObj = library->getBookById(bookId); const auto bookTitle = bookObj.getTitle(); + std::string contentId = ""; + try { + contentId = urlEncode(nameMapper->getNameForId(bookId)); + } catch (...) {} const auto bookDescription = bookObj.getDescription(); const auto langCode = bookObj.getCommaSeparatedLanguages(); const auto bookIconUrl = rootLocation + "/catalog/v2/illustration/" + bookId + "/?size=48"; const auto tags = bookObj.getTags(); std::string faviconAttr = "style=background-image:url(" + bookIconUrl + ")"; booksData.push_back(kainjow::mustache::object{ + {"id", contentId}, {"title", bookTitle}, {"description", bookDescription}, {"langCode", langCode}, diff --git a/static/templates/no_js_library_page.html b/static/templates/no_js_library_page.html index 2db51a0d6..3494bd74d 100644 --- a/static/templates/no_js_library_page.html +++ b/static/templates/no_js_library_page.html @@ -51,7 +51,7 @@
{{#books}}
- +
From 0f7e11bd866556be7d383f224368d980935044e9 Mon Sep 17 00:00:00 2001 From: Nikhil Tanwar <2002nikhiltanwar@gmail.com> Date: Wed, 15 Feb 2023 02:43:33 +0530 Subject: [PATCH 07/14] Add download-links to tiles in /nojs The download-link links to /nojs/download/ for all 4 types of downloads. --- src/html_dumper.cpp | 5 ++- src/server/internalServer.cpp | 49 ++++++++++++++++++++---- src/server/internalServer.h | 2 + src/tools/stringTools.cpp | 11 ++++++ src/tools/stringTools.h | 2 + static/resources_list.txt | 1 + static/templates/no_js_download.html | 33 ++++++++++++++++ static/templates/no_js_library_page.html | 27 ++++++++++--- test/stringTools.cpp | 7 ++++ 9 files changed, 123 insertions(+), 14 deletions(-) create mode 100644 static/templates/no_js_download.html diff --git a/src/html_dumper.cpp b/src/html_dumper.cpp index 277dc92ec..27be874ab 100644 --- a/src/html_dumper.cpp +++ b/src/html_dumper.cpp @@ -47,14 +47,17 @@ std::string HTMLDumper::dumpPlainHTML() const const auto langCode = bookObj.getCommaSeparatedLanguages(); const auto bookIconUrl = rootLocation + "/catalog/v2/illustration/" + bookId + "/?size=48"; const auto tags = bookObj.getTags(); + const auto downloadAvailable = (bookObj.getUrl() != ""); std::string faviconAttr = "style=background-image:url(" + bookIconUrl + ")"; + booksData.push_back(kainjow::mustache::object{ {"id", contentId}, {"title", bookTitle}, {"description", bookDescription}, {"langCode", langCode}, {"faviconAttr", faviconAttr}, - {"tagList", getTagList(tags)} + {"tagList", getTagList(tags)}, + {"downloadAvailable", downloadAvailable} }); } diff --git a/src/server/internalServer.cpp b/src/server/internalServer.cpp index a0236f3e6..32aa7752f 100644 --- a/src/server/internalServer.cpp +++ b/src/server/internalServer.cpp @@ -759,18 +759,51 @@ std::unique_ptr InternalServer::handle_viewer_settings(const RequestCo return ContentResponse::build(*this, RESOURCE::templates::viewer_settings_js, data, "application/javascript; charset=utf-8"); } -std::unique_ptr InternalServer::handle_no_js(const RequestContext& request) +std::string InternalServer::getNoJSDownloadPageHTML(const std::string& bookId) const { - HTMLDumper htmlDumper(mp_library, mp_nameMapper); - htmlDumper.setRootLocation(m_root); - htmlDumper.setLibraryId(getLibraryId()); - return ContentResponse::build( - *this, - htmlDumper.dumpPlainHTML(), - "text/html; charset=utf-8" + const auto book = mp_library->getBookById(bookId); + auto bookUrl = kiwix::stripSuffix(book.getUrl(), ".meta4"); + + return render_template( + RESOURCE::templates::no_js_download_html, + kainjow::mustache::object{ + {"url", bookUrl}, + {"bookTitle", book.getTitle()} + } ); } +std::unique_ptr InternalServer::handle_no_js(const RequestContext& request) +{ + const auto url = request.get_url(); + const auto urlParts = kiwix::split(url, "/", true, false); + HTMLDumper htmlDumper(mp_library, mp_nameMapper); + htmlDumper.setRootLocation(m_root); + htmlDumper.setLibraryId(getLibraryId()); + std::string content; + + if (urlParts.size() == 1) { + content = htmlDumper.dumpPlainHTML(); + } else if ((urlParts.size() == 3) && (urlParts[1] == "download")) { + try { + const auto bookId = mp_nameMapper->getIdForName(urlParts[2]); + content = getNoJSDownloadPageHTML(bookId); + } catch (const std::out_of_range&) { + return HTTP404Response(*this, request) + + urlNotFoundMsg; + } + } else { + return HTTP404Response(*this, request) + + urlNotFoundMsg; + } + + + return ContentResponse::build( + *this, + content, + "text/html; charset=utf-8" + ); +} namespace { diff --git a/src/server/internalServer.h b/src/server/internalServer.h index a9e0070c8..de84f251e 100644 --- a/src/server/internalServer.h +++ b/src/server/internalServer.h @@ -156,6 +156,8 @@ class InternalServer { std::string getLibraryId() const; + std::string getNoJSDownloadPageHTML(const std::string& bookId) const; + private: // types class LockableSuggestionSearcher; typedef ConcurrentCache> SearchCache; diff --git a/src/tools/stringTools.cpp b/src/tools/stringTools.cpp index 3ca8124aa..7ec66deec 100644 --- a/src/tools/stringTools.cpp +++ b/src/tools/stringTools.cpp @@ -415,6 +415,17 @@ bool kiwix::startsWith(const std::string& base, const std::string& start) && std::equal(start.begin(), start.end(), base.begin()); } +std::string kiwix::stripSuffix(const std::string& str, const std::string& suffix) +{ + if (str.size() > suffix.size()) { + const auto subStr = str.substr(str.size() - suffix.size(), str.size()); + if (subStr == suffix) { + return str.substr(0, str.size() - suffix.size()); + } + } + return str; +} + std::vector kiwix::getTitleVariants(const std::string& title) { std::vector variants; variants.push_back(title); diff --git a/src/tools/stringTools.h b/src/tools/stringTools.h index 1f55a22bc..af0527f29 100644 --- a/src/tools/stringTools.h +++ b/src/tools/stringTools.h @@ -93,6 +93,8 @@ std::string extractFromString(const std::string& str); bool startsWith(const std::string& base, const std::string& start); +std::string stripSuffix(const std::string& str, const std::string& suffix); + std::vector getTitleVariants(const std::string& title); } //namespace kiwix #endif diff --git a/static/resources_list.txt b/static/resources_list.txt index 516c8bfc6..71ebe6760 100644 --- a/static/resources_list.txt +++ b/static/resources_list.txt @@ -38,6 +38,7 @@ templates/catalog_v2_languages.xml templates/url_of_search_results_css templates/viewer_settings.js templates/no_js_library_page.html +templates/no_js_download.html opensearchdescription.xml ft_opensearchdescription.xml catalog_v2_searchdescription.xml diff --git a/static/templates/no_js_download.html b/static/templates/no_js_download.html new file mode 100644 index 000000000..d1ba6f249 --- /dev/null +++ b/static/templates/no_js_download.html @@ -0,0 +1,33 @@ + + + + + + + Download book + + + +
+ Download links for {{bookTitle}} +
+ +
Direct
+ + +
Sha256 hash
+ + +
Magnet link
+ + +
Torrent file
+ + + \ No newline at end of file diff --git a/static/templates/no_js_library_page.html b/static/templates/no_js_library_page.html index 3494bd74d..21671cc83 100644 --- a/static/templates/no_js_library_page.html +++ b/static/templates/no_js_library_page.html @@ -44,6 +44,20 @@ .tag__link { pointer-events: none; } + + .book__link__wrapper { + grid-column: 1 / 3; + grid-row: 1 / 3; + } + + .book__link { + grid-row: 2 / 3; + } + + #book__title>a, .book__download a { + text-decoration: none; + all: unset; + } @@ -51,15 +65,18 @@
{{#books}}
-
-
{{title}}
+
{{title}}
+ {{#downloadAvailable}} +
Download
+ {{/downloadAvailable}}
-
{{description}}
-
- + +
{{description}}
+ +
{{langCode}}
{{#tagList}} diff --git a/test/stringTools.cpp b/test/stringTools.cpp index 27cc712b8..d866cda81 100644 --- a/test/stringTools.cpp +++ b/test/stringTools.cpp @@ -163,4 +163,11 @@ TEST(stringTools, urlDecode) EXPECT_EQ(urlDecode(encodedUriDelimSymbols, false), encodedUriDelimSymbols); } +TEST(stringTools, stripSuffix) +{ + EXPECT_EQ(stripSuffix("abc123", "123"), "abc"); + EXPECT_EQ(stripSuffix("abc123", "123456789"), "abc123"); + EXPECT_EQ(stripSuffix("abc123", "987"), "abc123"); +} + }; From a48e2e6f065137b5a614b6c850a6b1ac1ae24b26 Mon Sep 17 00:00:00 2001 From: Nikhil Tanwar <2002nikhiltanwar@gmail.com> Date: Thu, 16 Feb 2023 02:19:15 +0530 Subject: [PATCH 08/14] Add search form for /nojs endpoint Adds an html form to search books by the q= parameter --- include/html_dumper.h | 2 +- src/html_dumper.cpp | 10 +++++++--- src/server/internalServer.cpp | 4 ++-- static/templates/no_js_library_page.html | 6 ++++++ 4 files changed, 16 insertions(+), 6 deletions(-) diff --git a/include/html_dumper.h b/include/html_dumper.h index fd09659db..80eebd8e1 100644 --- a/include/html_dumper.h +++ b/include/html_dumper.h @@ -42,7 +42,7 @@ class HTMLDumper : public LibraryDumper * * @return HTML content */ - std::string dumpPlainHTML() const; + std::string dumpPlainHTML(kiwix::Filter filter) const; }; } diff --git a/src/html_dumper.cpp b/src/html_dumper.cpp index 27be874ab..6cef6b6b9 100644 --- a/src/html_dumper.cpp +++ b/src/html_dumper.cpp @@ -33,10 +33,13 @@ kainjow::mustache::list getTagList(std::string tags) } // unnamed namespace -std::string HTMLDumper::dumpPlainHTML() const +std::string HTMLDumper::dumpPlainHTML(kiwix::Filter filter) const { kainjow::mustache::list booksData; - for ( const auto& bookId : library->getBooksIds() ) { + const auto filteredBooks = library->filter(filter); + const auto searchQuery = filter.getQuery(); + + for ( const auto& bookId : filteredBooks ) { const auto bookObj = library->getBookById(bookId); const auto bookTitle = bookObj.getTitle(); std::string contentId = ""; @@ -65,7 +68,8 @@ std::string HTMLDumper::dumpPlainHTML() const RESOURCE::templates::no_js_library_page_html, kainjow::mustache::object{ {"root", rootLocation}, - {"books", booksData } + {"books", booksData }, + {"searchQuery", searchQuery} } ); } diff --git a/src/server/internalServer.cpp b/src/server/internalServer.cpp index 32aa7752f..060d41860 100644 --- a/src/server/internalServer.cpp +++ b/src/server/internalServer.cpp @@ -783,7 +783,8 @@ std::unique_ptr InternalServer::handle_no_js(const RequestContext& req std::string content; if (urlParts.size() == 1) { - content = htmlDumper.dumpPlainHTML(); + const auto filter = get_search_filter(request); + content = htmlDumper.dumpPlainHTML(filter); } else if ((urlParts.size() == 3) && (urlParts[1] == "download")) { try { const auto bookId = mp_nameMapper->getIdForName(urlParts[2]); @@ -797,7 +798,6 @@ std::unique_ptr InternalServer::handle_no_js(const RequestContext& req + urlNotFoundMsg; } - return ContentResponse::build( *this, content, diff --git a/static/templates/no_js_library_page.html b/static/templates/no_js_library_page.html index 21671cc83..6a43185e5 100644 --- a/static/templates/no_js_library_page.html +++ b/static/templates/no_js_library_page.html @@ -61,6 +61,12 @@ +
+
+ + +
+
{{#books}} From f843ea48f0a373e738cf71229f279622306ea9bd Mon Sep 17 00:00:00 2001 From: Nikhil Tanwar <2002nikhiltanwar@gmail.com> Date: Thu, 16 Feb 2023 02:29:18 +0530 Subject: [PATCH 09/14] Add Results label Shows "x results" label where x = number of books based on filters --- src/html_dumper.cpp | 3 ++- static/templates/no_js_library_page.html | 5 +++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/src/html_dumper.cpp b/src/html_dumper.cpp index 6cef6b6b9..d11a0b5da 100644 --- a/src/html_dumper.cpp +++ b/src/html_dumper.cpp @@ -69,7 +69,8 @@ std::string HTMLDumper::dumpPlainHTML(kiwix::Filter filter) const kainjow::mustache::object{ {"root", rootLocation}, {"books", booksData }, - {"searchQuery", searchQuery} + {"searchQuery", searchQuery}, + {"resultsCount", to_string(filteredBooks.size())} } ); } diff --git a/static/templates/no_js_library_page.html b/static/templates/no_js_library_page.html index 6a43185e5..9a791b050 100644 --- a/static/templates/no_js_library_page.html +++ b/static/templates/no_js_library_page.html @@ -54,6 +54,10 @@ grid-row: 2 / 3; } + .kiwixHomeBody__results { + flex-basis: 100%; + } + #book__title>a, .book__download a { text-decoration: none; all: unset; @@ -69,6 +73,7 @@
+

{{resultsCount}} results

{{#books}}
From 37aadb86fba1514bc30b50988fcca045d65ce6be Mon Sep 17 00:00:00 2001 From: Nikhil Tanwar <2002nikhiltanwar@gmail.com> Date: Sat, 18 Feb 2023 17:55:45 +0530 Subject: [PATCH 10/14] language/category filtering in /nojs endpoint Adds language and category filter in /nojs. Unlike the main page, the filtering is only done after user submits the form. --- include/library.h | 2 ++ src/html_dumper.cpp | 28 +++++++++++++++++++++++- src/library.cpp | 12 ++++++++++ src/library_dumper.cpp | 1 - src/server/internalServer.cpp | 12 +++++++++- static/templates/no_js_library_page.html | 18 +++++++++++++++ 6 files changed, 70 insertions(+), 3 deletions(-) diff --git a/include/library.h b/include/library.h index fa8f24263..3fefa140e 100644 --- a/include/library.h +++ b/include/library.h @@ -120,6 +120,8 @@ class Filter { Filter& maxSize(size_t size); Filter& query(std::string query, bool partial=true); Filter& name(std::string name); + Filter& clearLang(); + Filter& clearCategory(); bool hasQuery() const; const std::string& getQuery() const { return _query; } diff --git a/src/html_dumper.cpp b/src/html_dumper.cpp index d11a0b5da..31aae9259 100644 --- a/src/html_dumper.cpp +++ b/src/html_dumper.cpp @@ -2,6 +2,7 @@ #include "libkiwix-resources.h" #include "tools/otherTools.h" #include "tools.h" +#include "tools/regexTools.h" namespace kiwix { @@ -18,6 +19,13 @@ HTMLDumper::~HTMLDumper() namespace { +std::string humanFriendlyTitle(std::string title) +{ + std::string humanFriendlyString = replaceRegex(title, "_", " "); + humanFriendlyString[0] = toupper(humanFriendlyString[0]); + return humanFriendlyString; +} + kainjow::mustache::list getTagList(std::string tags) { const auto tagsList = kiwix::split(tags, ";", true, false); @@ -38,6 +46,22 @@ std::string HTMLDumper::dumpPlainHTML(kiwix::Filter filter) const kainjow::mustache::list booksData; const auto filteredBooks = library->filter(filter); const auto searchQuery = filter.getQuery(); + auto languages = getLanguageData(); + auto categories = getCategoryData(); + + for (auto &category : categories) { + const auto categoryName = category.get("name")->string_value(); + if (categoryName == filter.getCategory()) { + category["selected"] = true; + } + category["hf_name"] = humanFriendlyTitle(categoryName); + } + + for (auto &language : languages) { + if (language.get("lang_code")->string_value() == filter.getLang()) { + language["selected"] = true; + } + } for ( const auto& bookId : filteredBooks ) { const auto bookObj = library->getBookById(bookId); @@ -70,7 +94,9 @@ std::string HTMLDumper::dumpPlainHTML(kiwix::Filter filter) const {"root", rootLocation}, {"books", booksData }, {"searchQuery", searchQuery}, - {"resultsCount", to_string(filteredBooks.size())} + {"resultsCount", to_string(filteredBooks.size())}, + {"languages", languages}, + {"categories", categories} } ); } diff --git a/src/library.cpp b/src/library.cpp index 4982a70bd..4ce865b7f 100644 --- a/src/library.cpp +++ b/src/library.cpp @@ -878,6 +878,18 @@ Filter& Filter::name(std::string name) return *this; } +Filter& Filter::clearLang() +{ + activeFilters &= ~LANG; + return *this; +} + +Filter& Filter::clearCategory() +{ + activeFilters &= ~CATEGORY; + return *this; +} + #define ACTIVE(X) (activeFilters & (X)) #define FILTER(TAG, TEST) if (ACTIVE(TAG) && !(TEST)) { return false; } bool Filter::hasQuery() const diff --git a/src/library_dumper.cpp b/src/library_dumper.cpp index 81880db3b..04aeaefd7 100644 --- a/src/library_dumper.cpp +++ b/src/library_dumper.cpp @@ -2,7 +2,6 @@ #include "tools/stringTools.h" #include "tools/otherTools.h" #include "tools.h" -#include "tools/regexTools.h" namespace kiwix { diff --git a/src/server/internalServer.cpp b/src/server/internalServer.cpp index 060d41860..799ed8e5b 100644 --- a/src/server/internalServer.cpp +++ b/src/server/internalServer.cpp @@ -783,7 +783,17 @@ std::unique_ptr InternalServer::handle_no_js(const RequestContext& req std::string content; if (urlParts.size() == 1) { - const auto filter = get_search_filter(request); + auto filter = get_search_filter(request); + try { + if (request.get_argument("category") == "") { + filter.clearCategory(); + } + } catch (...) {} + try { + if (request.get_argument("lang") == "") { + filter.clearLang(); + } + } catch (...) {} content = htmlDumper.dumpPlainHTML(filter); } else if ((urlParts.size() == 3) && (urlParts[1] == "download")) { try { diff --git a/static/templates/no_js_library_page.html b/static/templates/no_js_library_page.html index 9a791b050..d96f2ed7f 100644 --- a/static/templates/no_js_library_page.html +++ b/static/templates/no_js_library_page.html @@ -66,6 +66,24 @@
+
+
+ +
+
+ +
+
From cc35fe503fca127dedd67be33ae583b209c3e200 Mon Sep 17 00:00:00 2001 From: Nikhil Tanwar <2002nikhiltanwar@gmail.com> Date: Sat, 25 Feb 2023 13:11:09 +0530 Subject: [PATCH 11/14] Translations for /nojs endpoint Uses the string from #846 for translations. A couple new translations are also added for tag. --- src/html_dumper.cpp | 18 ++++++++++++++++-- src/server/i18n.h | 22 ++++++++++++++++++++++ src/server/internalServer.cpp | 17 ++++++++++++++--- src/server/internalServer.h | 2 +- static/skin/i18n/en.json | 4 ++++ static/skin/i18n/qqq.json | 6 +++++- static/skin/i18n/test.json | 4 ++++ static/templates/no_js_download.html | 14 +++++++------- static/templates/no_js_library_page.html | 17 +++++++++-------- 9 files changed, 82 insertions(+), 22 deletions(-) diff --git a/src/html_dumper.cpp b/src/html_dumper.cpp index 31aae9259..a50315bd8 100644 --- a/src/html_dumper.cpp +++ b/src/html_dumper.cpp @@ -3,6 +3,7 @@ #include "tools/otherTools.h" #include "tools.h" #include "tools/regexTools.h" +#include "server/i18n.h" namespace kiwix { @@ -88,15 +89,28 @@ std::string HTMLDumper::dumpPlainHTML(kiwix::Filter filter) const }); } + auto getTranslation = i18n::GetTranslatedStringWithMsgId(m_userLang); + + const auto translations = kainjow::mustache::object{ + getTranslation("search"), + getTranslation("download"), + getTranslation("count-of-matching-books", {{"COUNT", to_string(filteredBooks.size())}}), + getTranslation("book-filtering-all-categories"), + getTranslation("book-filtering-all-languages"), + getTranslation("powered-by-kiwix-html"), + getTranslation("welcome-to-kiwix-server"), + getTranslation("preview-book") + }; + return render_template( RESOURCE::templates::no_js_library_page_html, kainjow::mustache::object{ {"root", rootLocation}, {"books", booksData }, {"searchQuery", searchQuery}, - {"resultsCount", to_string(filteredBooks.size())}, {"languages", languages}, - {"categories", categories} + {"categories", categories}, + {"translations", translations} } ); } diff --git a/src/server/i18n.h b/src/server/i18n.h index 23236074a..e1cbcc68f 100644 --- a/src/server/i18n.h +++ b/src/server/i18n.h @@ -69,6 +69,28 @@ private: const std::string m_lang; }; +class GetTranslatedStringWithMsgId +{ + typedef kainjow::mustache::basic_data<std::string> MustacheString; + typedef std::pair<std::string, MustacheString> MsgIdAndTranslation; + +public: + explicit GetTranslatedStringWithMsgId(const std::string& lang) : m_lang(lang) {} + + MsgIdAndTranslation operator()(const std::string& key) const + { + return {key, getTranslatedString(m_lang, key)}; + } + + MsgIdAndTranslation operator()(const std::string& key, const Parameters& params) const + { + return {key, expandParameterizedString(m_lang, key, params)}; + } + +private: + const std::string m_lang; +}; + } // namespace i18n struct ParameterizedMessage diff --git a/src/server/internalServer.cpp b/src/server/internalServer.cpp index 799ed8e5b..52f32be76 100644 --- a/src/server/internalServer.cpp +++ b/src/server/internalServer.cpp @@ -759,16 +759,25 @@ std::unique_ptr<Response> InternalServer::handle_viewer_settings(const RequestCo return ContentResponse::build(*this, RESOURCE::templates::viewer_settings_js, data, "application/javascript; charset=utf-8"); } -std::string InternalServer::getNoJSDownloadPageHTML(const std::string& bookId) const +std::string InternalServer::getNoJSDownloadPageHTML(const std::string& bookId, const std::string& userLang) const { const auto book = mp_library->getBookById(bookId); auto bookUrl = kiwix::stripSuffix(book.getUrl(), ".meta4"); + auto getTranslation = i18n::GetTranslatedStringWithMsgId(userLang); + const auto translations = kainjow::mustache::object{ + getTranslation("download-links-heading", {{"BOOK_TITLE", book.getTitle()}}), + getTranslation("download-links-title"), + getTranslation("direct-download-link-text"), + getTranslation("hash-download-link-text"), + getTranslation("magnet-link-text"), + getTranslation("torrent-download-link-text") + }; return render_template( RESOURCE::templates::no_js_download_html, kainjow::mustache::object{ {"url", bookUrl}, - {"bookTitle", book.getTitle()} + {"translations", translations} } ); } @@ -780,6 +789,8 @@ std::unique_ptr<Response> InternalServer::handle_no_js(const RequestContext& req HTMLDumper htmlDumper(mp_library, mp_nameMapper); htmlDumper.setRootLocation(m_root); htmlDumper.setLibraryId(getLibraryId()); + auto userLang = request.get_user_language(); + htmlDumper.setUserLanguage(userLang); std::string content; if (urlParts.size() == 1) { @@ -798,7 +809,7 @@ std::unique_ptr<Response> InternalServer::handle_no_js(const RequestContext& req } else if ((urlParts.size() == 3) && (urlParts[1] == "download")) { try { const auto bookId = mp_nameMapper->getIdForName(urlParts[2]); - content = getNoJSDownloadPageHTML(bookId); + content = getNoJSDownloadPageHTML(bookId, userLang); } catch (const std::out_of_range&) { return HTTP404Response(*this, request) + urlNotFoundMsg; diff --git a/src/server/internalServer.h b/src/server/internalServer.h index de84f251e..867b324e0 100644 --- a/src/server/internalServer.h +++ b/src/server/internalServer.h @@ -156,7 +156,7 @@ class InternalServer { std::string getLibraryId() const; - std::string getNoJSDownloadPageHTML(const std::string& bookId) const; + std::string getNoJSDownloadPageHTML(const std::string& bookId, const std::string& userLang) const; private: // types class LockableSuggestionSearcher; diff --git a/static/skin/i18n/en.json b/static/skin/i18n/en.json index acf2b0131..e8a3d26b1 100644 --- a/static/skin/i18n/en.json +++ b/static/skin/i18n/en.json @@ -47,4 +47,8 @@ , "filter-by-tag": "Filter by tag \"{{TAG}}\"" , "stop-filtering-by-tag": "Stop filtering by tag \"{{TAG}}\"" , "library-opds-feed-parameterised": "Library OPDS Feed - entries matching {{#LANG}}\nLanguage: {{LANG}} {{/LANG}}{{#CATEGORY}}\nCategory: {{CATEGORY}} {{/CATEGORY}}{{#TAG}}\nTag: {{TAG}} {{/TAG}}{{#Q}}\nQuery: {{Q}} {{/Q}}" + , "welcome-to-kiwix-server": "Welcome to Kiwix Server" + , "download-links-heading": "Download links for <b><i>{{BOOK_TITLE}}</i></b>" + , "download-links-title": "Download book" + , "preview-book": "Preview" } diff --git a/static/skin/i18n/qqq.json b/static/skin/i18n/qqq.json index 8d2acf869..069f5e774 100644 --- a/static/skin/i18n/qqq.json +++ b/static/skin/i18n/qqq.json @@ -48,5 +48,9 @@ "filter-by-tag": "Hint for a link that would load results filtered by a single tag", "stop-filtering-by-tag": "Tooltip for the button that cancels filtering by tag", "library-opds-feed-all-entries": "Hint for the library OPDS feed for all entries", - "library-opds-feed-parameterised": "Hint for the library OPDS feed for filtered entries" + "library-opds-feed-parameterised": "Hint for the library OPDS feed for filtered entries", + "welcome-to-kiwix-server": "Title shown in browser's title bar/page tab", + "download-links-heading": "Heading for no-js download page", + "download-links-title": "Title for no-js download page", + "preview-book": "Tooltip of book-tile leading to the book" } diff --git a/static/skin/i18n/test.json b/static/skin/i18n/test.json index b2e02e6b4..c48c181a9 100644 --- a/static/skin/i18n/test.json +++ b/static/skin/i18n/test.json @@ -36,4 +36,8 @@ , "filter-by-tag": "Filter [I18N] by [TESTING] tag \"{{TAG}}\"" , "stop-filtering-by-tag": "[I18N] Stop filtering [TESTING] by tag \"{{TAG}}\"" , "library-opds-feed-parameterised": "[I18N] Library OPDS Feed - [TESTING] entries matching {{#LANG}}\nLanguage: {{LANG}} {{/LANG}}{{#CATEGORY}}\nCategory: {{CATEGORY}} {{/CATEGORY}}{{#TAG}}\nTag: {{TAG}} {{/TAG}}{{#Q}}\nQuery: {{Q}} {{/Q}}" + , "welcome-to-kiwix-server": "[I18N] Welcome to Kiwix Server [TESTING]" + , "download-links-heading": "[I18N] Download links for <b><i>{{BOOK_TITLE}}</i></b> [TESTING]" + , "download-links-title": "[I18N TESTING]Download book" + , "preview-book": "[I18N] Preview [TESTING]" } diff --git a/static/templates/no_js_download.html b/static/templates/no_js_download.html index d1ba6f249..5bddee319 100644 --- a/static/templates/no_js_download.html +++ b/static/templates/no_js_download.html @@ -4,30 +4,30 @@ <meta charset="UTF-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> - <title>Download book + {{translations.download-links-title}}
- Download links for {{bookTitle}} + {{{translations.download-links-heading}}}
-
Direct
+
{{translations.direct-download-link-text}}
 -
Sha256 hash
+
{{translations.hash-download-link-text}}
 -
Magnet link
+
{{translations.magnet-link-text}}
 -
Torrent file
+
{{translations.torrent-download-link-text}}
 \ No newline at end of file diff --git a/static/templates/no_js_library_page.html b/static/templates/no_js_library_page.html index d96f2ed7f..728eb251f 100644 --- a/static/templates/no_js_library_page.html +++ b/static/templates/no_js_library_page.html @@ -4,7 +4,7 @@ - Welcome to Kiwix Server + {{translations.welcome-to-kiwix-server}}
- + {{#categories}} {{/categories}} @@ -85,13 +85,13 @@
- - + +
-

{{resultsCount}} results

+

{{translations.count-of-matching-books}}

{{#books}}
@@ -99,10 +99,10 @@
{{title}}
{{#downloadAvailable}} -
Download
+
{{translations.download}}
{{/downloadAvailable}}
- +
{{description}}
@@ -117,5 +117,6 @@ {{/books}}
+
{{{translations.powered-by-kiwix-html}}}
\ No newline at end of file From 951e15c665d3bf5ca0439c5999a339337cd38d57 Mon Sep 17 00:00:00 2001 From: Nikhil Tanwar <2002nikhiltanwar@gmail.com> Date: Mon, 27 Feb 2023 23:54:53 +0530 Subject: [PATCH 12/14] No results display in /nojs Shows a link to reset filter if there are no books. --- src/html_dumper.cpp | 4 +++- static/skin/i18n/en.json | 2 +- static/skin/i18n/test.json | 2 +- static/skin/index.js | 2 +- static/templates/no_js_library_page.html | 18 ++++++++++++++++++ test/server.cpp | 4 ++-- 6 files changed, 26 insertions(+), 6 deletions(-) diff --git a/src/html_dumper.cpp b/src/html_dumper.cpp index a50315bd8..4896821bf 100644 --- a/src/html_dumper.cpp +++ b/src/html_dumper.cpp @@ -99,7 +99,8 @@ std::string HTMLDumper::dumpPlainHTML(kiwix::Filter filter) const getTranslation("book-filtering-all-languages"), getTranslation("powered-by-kiwix-html"), getTranslation("welcome-to-kiwix-server"), - getTranslation("preview-book") + getTranslation("preview-book"), + getTranslation("welcome-page-overzealous-filter", {{"URL", "?lang="}}) }; return render_template( @@ -110,6 +111,7 @@ std::string HTMLDumper::dumpPlainHTML(kiwix::Filter filter) const {"searchQuery", searchQuery}, {"languages", languages}, {"categories", categories}, + {"noResults", filteredBooks.size() == 0}, {"translations", translations} } ); diff --git a/static/skin/i18n/en.json b/static/skin/i18n/en.json index e8a3d26b1..aaea04978 100644 --- a/static/skin/i18n/en.json +++ b/static/skin/i18n/en.json @@ -28,7 +28,7 @@ , "random-page-button-text": "Go to a randomly selected page" , "searchbox-tooltip": "Search '{{BOOK_TITLE}}'" , "confusion-of-tongues": "Two or more books in different languages would participate in search, which may lead to confusing results." - , "welcome-page-overzealous-filter": "No result. Would you like to reset filter?" + , "welcome-page-overzealous-filter": "No result. Would you like to reset filter?" , "powered-by-kiwix-html": "Powered by Kiwix" , "search": "Search" , "book-filtering-all-categories": "All categories" diff --git a/static/skin/i18n/test.json b/static/skin/i18n/test.json index c48c181a9..7686471ab 100644 --- a/static/skin/i18n/test.json +++ b/static/skin/i18n/test.json @@ -17,7 +17,7 @@ , "home-button-text": "[I18N TESTING] Jump to the main page of '{{BOOK_TITLE}}'" , "random-page-button-text": "[I18N TESTING] I am tired of determinism" , "searchbox-tooltip": "[I18N TESTING] Let's search in '{{BOOK_TITLE}}'" - , "welcome-page-overzealous-filter": "[I18N TESTING] Nothing found. Reset filter" + , "welcome-page-overzealous-filter": "[I18N TESTING] Nothing found. Reset filter" , "powered-by-kiwix-html": "[I18N TESTING] Powered by Kiwix (nominal power: 1.23 kW)" , "search": "[I18N Search TESTING]" , "book-filtering-all-categories": "All [I18N TESTING] categories" diff --git a/static/skin/index.js b/static/skin/index.js index 1f3bd448b..43854ba97 100644 --- a/static/skin/index.js +++ b/static/skin/index.js @@ -315,7 +315,7 @@ const kiwixHomeBody = document.querySelector('.kiwixHomeBody'); const divTag = document.createElement('div'); divTag.setAttribute('class', 'noResults'); - divTag.innerHTML = $t("welcome-page-overzealous-filter"); + divTag.innerHTML = $t("welcome-page-overzealous-filter", {URL: '#lang='}); kiwixHomeBody.append(divTag); kiwixHomeBody.setAttribute('style', 'display: flex; justify-content: center; align-items: center'); loader.setAttribute('style', 'position: absolute; top: 50%'); diff --git a/static/templates/no_js_library_page.html b/static/templates/no_js_library_page.html index 728eb251f..edab66fc6 100644 --- a/static/templates/no_js_library_page.html +++ b/static/templates/no_js_library_page.html @@ -90,6 +90,24 @@
+ {{#noResults}} + +
+ {{{translations.welcome-page-overzealous-filter}}} +
+ + {{/noResults}}

{{translations.count-of-matching-books}}

{{#books}} diff --git a/test/server.cpp b/test/server.cpp index 59a6b23dc..7f29e2644 100644 --- a/test/server.cpp +++ b/test/server.cpp @@ -63,7 +63,7 @@ const ResourceCollection resources200Compressible{ { DYNAMIC_CONTENT, "/ROOT%23%3F/skin/index.css" }, { STATIC_CONTENT, "/ROOT%23%3F/skin/index.css?cacheid=e4d76d16" }, { DYNAMIC_CONTENT, "/ROOT%23%3F/skin/index.js" }, - { STATIC_CONTENT, "/ROOT%23%3F/skin/index.js?cacheid=78cfd6a2" }, + { STATIC_CONTENT, "/ROOT%23%3F/skin/index.js?cacheid=d38d9ef1" }, { DYNAMIC_CONTENT, "/ROOT%23%3F/skin/iso6391To3.js" }, { STATIC_CONTENT, "/ROOT%23%3F/skin/iso6391To3.js?cacheid=ecde2bb3" }, { DYNAMIC_CONTENT, "/ROOT%23%3F/skin/isotope.pkgd.min.js" }, @@ -284,7 +284,7 @@ R"EXPECTEDRESULT( href="/ROOT%23%3F/skin/index.css?cacheid=e4d76d16" - + Date: Sun, 19 Mar 2023 18:40:46 +0530 Subject: [PATCH 13/14] Tests for /nojs Added 4 tests for /nojs endpoint Test 1: no_js_default - Without any filters Test 2: no_js_eng_lang - With lang=eng as filter Test 3: no_js_no_books - For 0 results case Test 4: no_js_download - To test download page --- test/library_server.cpp | 253 ++++++++++++++++++++++++++++++++++++++++ test/server.cpp | 6 + 2 files changed, 259 insertions(+) diff --git a/test/library_server.cpp b/test/library_server.cpp index d5270a200..a472f2356 100644 --- a/test/library_server.cpp +++ b/test/library_server.cpp @@ -945,6 +945,259 @@ TEST_F(LibraryServerTest, no_name_mapper_catalog_v2_individual_entry_access) EXPECT_EQ(r1->status, 404); } +#define HTML_PREAMBLE \ + "\n" \ + "\n" \ + " \n" \ + " \n" \ + " \n" \ + " \n" \ + " Welcome to Kiwix Server\n" \ + " \n" \ + " \n" \ + " \n" \ + " \n" \ + " \n" \ + " \n" \ + " \n" \ + " \n" \ + " \n" \ + " \n" \ + " \n" \ + " \n" \ + " \n" \ + "
\n" +#define CHARLES_RAY_BOOK_HTML \ + "
\n" \ + "
\n" \ + "
\n" \ + "
\n" \ + "
Charles, Ray
\n" \ + "
Download
\n" \ + "
\n" \ + " \n" \ + "
Wikipedia articles about Ray Charles
\n" \ + " \n" \ + "
\n" \ + "
fra
\n" \ + "
\n" \ + " unittest\n" \ + " wikipedia\n" \ + "
\n" \ + "
\n" \ + "
\n" + +#define RAY_CHARLES_BOOK_HTML \ + "
\n" \ + "
\n" \ + "
\n" \ + "
\n" \ + "
Ray Charles
\n" \ + "
Download
\n" \ + "
\n" \ + " \n" \ + "
Wikipedia articles about Ray Charles
\n" \ + " \n" \ + "
\n" \ + "
eng
\n" \ + "
\n" \ + " public_tag_without_a_value\n" \ + " wikipedia\n" \ + "
\n" \ + "
\n" \ + "
\n" + +#define RAY_CHARLES_UNCTZ_BOOK_HTML \ + "
\n" \ + "
\n" \ + "
\n" \ + "
\n" \ + "
Ray (uncategorized) Charles
\n" \ + "
Download
\n" \ + "
\n" \ + " \n" \ + "
No category is assigned to this library entry.
\n" \ + " \n" \ + "
\n" \ + "
rus,eng
\n" \ + "
\n" \ + " public_tag_with_a_value:value_of_a_public_tag\n" \ + " wikipedia\n" \ + "
\n" \ + "
\n" \ + "
\n" + +#define FINAL_HTML_TEXT \ + "
\n" \ + "
\n" \ + "
Powered by Kiwix
\n" \ + " \n" \ + "" + +#define FILTERS_HTML(SELECTED_ENG) \ + "
\n" \ + "
\n" \ + " \n" \ + "
\n" \ + "
\n" \ + " \n" \ + "
\n" \ + "
\n" \ + "
\n" \ + " \n" \ + " \n" \ + "
\n" \ + "
\n" + +#define HOME_BODY_TEXT(X) \ + "
\n" \ + " \n" \ + "
\n" \ + "

" X " book(s)

\n" + +#define HOME_BODY_0_RESULTS \ + "
\n" \ + " \n" \ + "
\n" \ + " No result. Would you like to reset filter?\n" \ + "
\n" \ + " \n" \ + "
\n" \ + "

0 book(s)

\n" \ + " \n" + +#define RAY_CHARLES_UNCTZ_DOWNLOAD \ + "\n" \ + "\n" \ + "\n" \ + " \n" \ + " \n" \ + " \n" \ + " Download book\n" \ + "\n" \ + "\n" \ + "\n" \ + "
\n" \ + " Download links for Ray (uncategorized) Charles\n" \ + "
\n" \ + " \n" \ + "
Direct
\n" \ + " \n" \ + " \n" \ + "
Sha256 hash
\n" \ + " \n" \ + " \n" \ + "
Magnet link
\n" \ + " \n" \ + " \n" \ + "
Torrent file
\n" \ + " \n" \ + "\n" \ + "" + +TEST_F(LibraryServerTest, noJS) { + // no_js_default + auto r = zfs1_->GET("/ROOT%23%3F/nojs"); + EXPECT_EQ(r->status, 200); + EXPECT_EQ(r->body, + HTML_PREAMBLE + FILTERS_HTML("") + HOME_BODY_TEXT("3") + CHARLES_RAY_BOOK_HTML + RAY_CHARLES_BOOK_HTML + RAY_CHARLES_UNCTZ_BOOK_HTML + FINAL_HTML_TEXT); + + // no_js_eng_lang + r = zfs1_->GET("/ROOT%23%3F/nojs?lang=eng"); + EXPECT_EQ(r->status, 200); + EXPECT_EQ(r->body, + HTML_PREAMBLE + FILTERS_HTML(" selected ") + HOME_BODY_TEXT("2") + RAY_CHARLES_UNCTZ_BOOK_HTML + RAY_CHARLES_BOOK_HTML + FINAL_HTML_TEXT); + + // no_js_no_books + r = zfs1_->GET("/ROOT%23%3F/nojs?lang=fas"); + EXPECT_EQ(r->status, 200); + EXPECT_EQ(r->body, + HTML_PREAMBLE + FILTERS_HTML("") + HOME_BODY_0_RESULTS + FINAL_HTML_TEXT); + + // no_js_download + r = zfs1_->GET("/ROOT%23%3F/nojs/download/zimfile"); + EXPECT_EQ(r->status, 200); + EXPECT_EQ(r->body, RAY_CHARLES_UNCTZ_DOWNLOAD); +} #undef EXPECT_SEARCH_RESULTS diff --git a/test/server.cpp b/test/server.cpp index 7f29e2644..c9cbe4f2a 100644 --- a/test/server.cpp +++ b/test/server.cpp @@ -97,6 +97,8 @@ const ResourceCollection resources200Compressible{ { ZIM_CONTENT, "/ROOT%23%3F/raw/zimfile/content/A/index" }, { ZIM_CONTENT, "/ROOT%23%3F/raw/zimfile/content/A/Ray_Charles" }, + + { DYNAMIC_CONTENT, "/ROOT%23%3F/nojs"}, }; const ResourceCollection resources200Uncompressible{ @@ -179,6 +181,8 @@ const ResourceCollection resources200Uncompressible{ { DYNAMIC_CONTENT, "/ROOT%23%3F/suggest?content=zimfile" }, { ZIM_CONTENT, "/ROOT%23%3F/raw/zimfile/meta/Creator" }, { ZIM_CONTENT, "/ROOT%23%3F/raw/zimfile/meta/Title" }, + + { DYNAMIC_CONTENT, "/ROOT%23%3F/nojs/download/zimfile"}, }; ResourceCollection all200Resources() @@ -395,6 +399,8 @@ const char* urls404[] = { // zimfile has no Favicon nor Illustration_48x48@1 meta item "/ROOT%23%3F/raw/zimfile/meta/Favicon", "/ROOT%23%3F/raw/zimfile/meta/Illustration_48x48@1", + + "/ROOT%23%3F/nojs/download/thiszimdoesntexist" }; TEST_F(ServerTest, 404) From 25f589ee7309dc9b2a859ae49b89390f06196485 Mon Sep 17 00:00:00 2001 From: Nikhil Tanwar <2002nikhiltanwar@gmail.com> Date: Tue, 28 Mar 2023 23:24:52 +0530 Subject: [PATCH 14/14] noscript text on welcome page Added a