Removed old-style taskbar injection

Double-toolbar in the viewer has gone. Some clean-up has to be performed after this change.
2022-08-11 17:03:57 +04:00 · 2022-08-11 17:03:57 +04:00 · 40c496d401
parent 9a193735fb
commit 40c496d401
7 changed files with 10 additions and 323 deletions
--- a/src/server/response.cpp
+++ b/src/server/response.cpp
@ -337,34 +337,6 @@ void print_response_info(int retCode, MHD_Response* response)
 }


-void ContentResponse::introduce_taskbar(const std::string& lang)
-{
-  i18n::GetTranslatedString t(lang);
-  kainjow::mustache::object data{
-    {"root", m_root},
-    {"content", m_bookName},
-    {"hascontent", (!m_bookName.empty() && !m_bookTitle.empty())},
-    {"title", m_bookTitle},
-    {"withlibrarybutton", m_withLibraryButton},
-    {"LIBRARY_BUTTON_TEXT", t("library-button-text")},
-    {"HOME_BUTTON_TEXT", t("home-button-text", {{"BOOK_TITLE", m_bookTitle}}) },
-    {"RANDOM_PAGE_BUTTON_TEXT", t("random-page-button-text") },
-    {"SEARCHBOX_TOOLTIP", t("searchbox-tooltip", {{"BOOK_TITLE", m_bookTitle}}) },
-  };
-  auto head_content = render_template(RESOURCE::templates::head_taskbar_html, data);
-  m_content = prependToFirstOccurence(
-    m_content,
-    "</head[ \\t]*>",
-    head_content);
-
-  auto taskbar_part = render_template(RESOURCE::templates::taskbar_part_html, data);
-  m_content = appendToFirstOccurence(
-    m_content,
-    "<body[^>]*>",
-    taskbar_part);
-}
-
-
 void ContentResponse::inject_externallinks_blocker()
 {
  kainjow::mustache::data data;
@ -414,9 +386,6 @@ ContentResponse::create_mhd_response(const RequestContext& request)
  if (contentDecorationAllowed()) {
    inject_root_link();

-    if (m_withTaskbar) {
-      introduce_taskbar(request.get_user_language());
-    }
    if (m_blockExternalLinks) {
      inject_externallinks_blocker();
    }
@ -468,14 +437,12 @@ void ContentResponse::set_taskbar(const std::string& bookName, const zim::Archiv
 }


-ContentResponse::ContentResponse(const std::string& root, bool verbose, bool raw, bool withTaskbar, bool withLibraryButton, bool blockExternalLinks, const std::string& content, const std::string& mimetype) :
+ContentResponse::ContentResponse(const std::string& root, bool verbose, bool raw, bool /*withTaskbar*/, bool /*withLibraryButton*/, bool blockExternalLinks, const std::string& content, const std::string& mimetype) :
  Response(verbose),
  m_root(root),
  m_content(content),
  m_mimeType(mimetype),
  m_raw(raw),
-  m_withTaskbar(withTaskbar),
-  m_withLibraryButton(withLibraryButton),
  m_blockExternalLinks(blockExternalLinks),
  m_bookName(""),
  m_bookTitle("")
@ -494,8 +461,8 @@ std::unique_ptr<ContentResponse> ContentResponse::build(
        server.m_root,
        server.m_verbose.load(),
        raw,
-        server.m_withTaskbar && !isHomePage,
-        server.m_withLibraryButton,
+        /*server.m_withTaskbar && !isHomePage*/ false, // XXX
+        /*server.m_withLibraryButton*/ false, // XXX
        server.m_blockExternalLinks,
        content,
        mimetype));
--- a/src/server/response.h
+++ b/src/server/response.h
@ -107,7 +107,6 @@ class ContentResponse : public Response {
  private:
    MHD_Response* create_mhd_response(const RequestContext& request);

-    void introduce_taskbar(const std::string& lang);
    void inject_externallinks_blocker();
    void inject_root_link();
    bool can_compress(const RequestContext& request) const;
@ -119,8 +118,6 @@ class ContentResponse : public Response {
    std::string m_content;
    std::string m_mimeType;
    bool m_raw;
-    bool m_withTaskbar;
-    bool m_withLibraryButton;
    bool m_blockExternalLinks;
    std::string m_bookName;
    std::string m_bookTitle;
--- a/static/resources_list.txt
+++ b/static/resources_list.txt
@ -4,7 +4,6 @@ skin/magnet.png
 skin/download.png
 skin/hash.png
 skin/search-icon.svg
-skin/taskbar.js
 skin/iso6391To3.js
 skin/isotope.pkgd.min.js
 skin/index.js
@ -24,8 +23,6 @@ templates/error.html
 templates/error.xml
 templates/index.html
 templates/suggestion.json
-templates/head_taskbar.html
-templates/taskbar_part.html
 templates/external_blocker_part.html
 templates/captured_external.html
 templates/catalog_entries.xml
--- a/static/skin/taskbar.js
+++ b/static/skin/taskbar.js
@ -1,122 +0,0 @@
-function htmlDecode(input) {
-    var doc = new DOMParser().parseFromString(input, "text/html");
-    return doc.documentElement.textContent;
-}
-
-function setupAutoHidingOfTheToolbar() {
-  let lastScrollTop = 0;
-  const delta = 5;
-  let didScroll = false;
-  const kiwixToolBar = document.querySelector('#kiwixtoolbar');
-
-  window.addEventListener('scroll', () => {
-    didScroll = true;
-  });
-
-  setInterval(function() {
-    if (didScroll) {
-      hasScrolled();
-      didScroll = false;
-    }
-  }, 250);
-
-  function hasScrolled() {
-    const st = document.documentElement.scrollTop || document.body.scrollTop;
-    if (Math.abs(lastScrollTop - st) <= delta)
-        return;
-
-    if (st > lastScrollTop) {
-        kiwixToolBar.style.top = '-100%';
-    } else {
-        kiwixToolBar.style.top = '0';
-    }
-
-    lastScrollTop = st;
-  }
-
-}
-
-document.addEventListener('DOMContentLoaded', function () {
-  const root = document.querySelector(`link[type='root']`).getAttribute("href");
-  const bookName = (window.location.pathname == `${root}/search`)
-    ? (new URLSearchParams(window.location.search)).get('content')
-    : window.location.pathname.split(`${root}/`)[1].split('/')[0];
-
-  const autoCompleteJS = new autoComplete(
-    {
-      selector: "#kiwixsearchbox",
-      placeHolder: document.querySelector("#kiwixsearchbox").title,
-      threshold: 1,
-      debounce: 300,
-      data : {
-        src: async (query) => {
-          try {
-            // Fetch Data from external Source
-            const source = await fetch(`${root}/suggest?content=${encodeURIComponent(bookName)}&term=${encodeURIComponent(query)}`);
-            const data = await source.json();
-            return data;
-          } catch (error) {
-            return error;
-          }
-        },
-        keys: ['label'],
-      },
-      submit: true,
-      searchEngine: (query, record) => {
-        // We accept all records
-        return true;
-      },
-      resultsList: {
-        noResults: true,
-        /* We must display 10 results (requested) + 1 potential link to do a full text search. */
-        maxResults: 11,
-      },
-      resultItem: {
-        element: (item, data) => {
-          let searchLink;
-          if (data.value.kind == "path") {
-            searchLink = `${root}/${bookName}/${htmlDecode(data.value.path)}`;
-          } else {
-            searchLink = `${root}/search?content=${encodeURIComponent(bookName)}&pattern=${encodeURIComponent(htmlDecode(data.value.value))}`;
-          }
-          item.innerHTML = `<a class="suggest" href="${searchLink}">${htmlDecode(data.value.label)}</a>`;
-        },
-        highlight: "autoComplete_highlight",
-        selected: "autoComplete_selected"
-      }
-    }
-  );
-
-  document.querySelector('#kiwixsearchform').addEventListener('submit', function(event) {
-    try {
-      const selectedElemLink = document.querySelector('.autoComplete_selected > a').href;
-      if (selectedElemLink) {
-        event.preventDefault();
-        window.location = selectedElemLink;
-      }
-    } catch (err) {}
-  });
-
-  const kiwixSearchBox = document.querySelector('#kiwixsearchbox');
-  const kiwixSearchForm = document.querySelector('.kiwix_searchform');
-  kiwixSearchBox.addEventListener('focus', () => {
-      kiwixSearchForm.classList.add('full_width');
-      document.querySelector('label[for="kiwix_button_show_toggle"]').classList.add('searching');
-      document.querySelector('.kiwix_button_cont').classList.add('searching');
-  });
-  kiwixSearchBox.addEventListener('blur', () => {
-      kiwixSearchForm.classList.remove('full_width');
-      document.querySelector('label[for="kiwix_button_show_toggle"]').classList.remove('searching');
-      document.querySelector('.kiwix_button_cont').classList.remove('searching');
-  });
-
-  // cybook hack
-  if (navigator.userAgent.indexOf("bookeen/cybook") != -1) {
-      document.querySelector('html').classList.add('cybook');
-  }
-
-  if (document.body.clientWidth < 520) {
-    setupAutoHidingOfTheToolbar();
-  }
-  
-});
--- a/static/templates/head_taskbar.html
+++ b/static/templates/head_taskbar.html
@ -1,4 +0,0 @@
-<link type="text/css" href="{{root}}/skin/taskbar.css?KIWIXCACHEID" rel="Stylesheet" />
-<link type="text/css" href="{{root}}/skin/css/autoComplete.css?KIWIXCACHEID" rel="Stylesheet" />
-<script type="text/javascript" src="{{root}}/skin/taskbar.js?KIWIXCACHEID" defer></script>
-<script type="text/javascript" src="{{root}}/skin/autoComplete.min.js?KIWIXCACHEID"></script>
--- a/static/templates/taskbar_part.html
+++ b/static/templates/taskbar_part.html
@ -1,25 +0,0 @@
-<span class="kiwix">
-  <span id="kiwixtoolbar" class="ui-widget-header">
-    <div class="kiwix_centered">
-      <div class="kiwix_searchform">
-        <form class="kiwixsearch" method="GET" action="{{root}}/search" id="kiwixsearchform">
-          {{#hascontent}}<input type="hidden" name="content" value="{{content}}" />{{/hascontent}}
-          <label for="kiwixsearchbox">&#x1f50d;</label>
-          <input autocomplete="off" id="kiwixsearchbox" name="pattern" type="text" size="50" title="{{{SEARCHBOX_TOOLTIP}}}" aria-label="{{{SEARCHBOX_TOOLTIP}}}">
-        </form>
-      </div>
-        <input type="checkbox" id="kiwix_button_show_toggle">
-        <label for="kiwix_button_show_toggle"><img src="{{root}}/skin/caret.png?KIWIXCACHEID" alt=""></label>
-        <div class="kiwix_button_cont">
-          {{#withlibrarybutton}}
-            <a id="kiwix_serve_taskbar_library_button" title="{{{LIBRARY_BUTTON_TEXT}}}" aria-label="{{{LIBRARY_BUTTON_TEXT}}}" href="{{root}}/"><button>&#x1f3e0;</button></a>
-          {{/withlibrarybutton}}
-          {{#hascontent}}
-          <a id="kiwix_serve_taskbar_home_button" title="{{{HOME_BUTTON_TEXT}}}" aria-label="{{{HOME_BUTTON_TEXT}}}" href="{{root}}/{{content}}/"><button>{{title}}</button></a>
-          <a id="kiwix_serve_taskbar_random_button" title="{{{RANDOM_PAGE_BUTTON_TEXT}}}" aria-label="{{{RANDOM_PAGE_BUTTON_TEXT}}}"
-            href="{{root}}/random?content={{#urlencoded}}{{{content}}}{{/urlencoded}}"><button>&#x1F3B2;</button></a>
-          {{/hascontent}}
-        </div>
-    </div>
-  </span>
-</span>
--- a/test/server.cpp
+++ b/test/server.cpp
@ -43,7 +43,6 @@ typedef std::vector<Resource> ResourceCollection;
 const ResourceCollection resources200Compressible{
  { WITH_ETAG, "/ROOT/" },

-  { WITH_ETAG, "/ROOT/skin/taskbar.js" },
  { WITH_ETAG, "/ROOT/skin/autoComplete.min.js" },
  { WITH_ETAG, "/ROOT/skin/css/autoComplete.css" },
  { WITH_ETAG, "/ROOT/skin/taskbar.css" },
@ -55,8 +54,6 @@ const ResourceCollection resources200Compressible{

  { NO_ETAG,   "/ROOT/suggest?content=zimfile&term=ray" },

-  { NO_ETAG,   "/ROOT/catch/external?source=www.example.com" },
-
  { WITH_ETAG, "/ROOT/content/zimfile/A/index" },
  { WITH_ETAG, "/ROOT/content/zimfile/A/Ray_Charles" },

@ -79,6 +76,8 @@ const ResourceCollection resources200Uncompressible{

  { NO_ETAG, "/ROOT/catalog/v2/illustration/6f1d19d0-633f-087b-fb55-7ac324ff9baf?size=48" },

+  { NO_ETAG,   "/ROOT/catch/external?source=www.example.com" },
+
  { WITH_ETAG, "/ROOT/content/zimfile/I/m/Ray_Charles_classic_piano_pose.jpg" },

  { WITH_ETAG, "/ROOT/content/corner_cases/A/empty.html" },
@ -210,23 +209,13 @@ R"EXPECTEDRESULT(    <link type="text/css" href="./skin/taskbar.css?cacheid=2608
    },
    {
      /* url */ "/ROOT/content/zimfile/A/index",
-R"EXPECTEDRESULT(<link type="root" href="/ROOT"><link type="text/css" href="/ROOT/skin/taskbar.css?cacheid=26082885" rel="Stylesheet" />
-<link type="text/css" href="/ROOT/skin/css/autoComplete.css?cacheid=08951e06" rel="Stylesheet" />
-<script type="text/javascript" src="/ROOT/skin/taskbar.js?cacheid=1aec4a68" defer></script>
-<script type="text/javascript" src="/ROOT/skin/autoComplete.min.js?cacheid=1191aaaf"></script>
-        <label for="kiwix_button_show_toggle"><img src="/ROOT/skin/caret.png?cacheid=22b942b4" alt=""></label>
-)EXPECTEDRESULT"
+      ""
    },
    {
      // Searching in a ZIM file without a full-text index returns
      // a page rendered from static/templates/no_search_result_html
      /* url */ "/ROOT/search?content=poor&pattern=whatever",
 R"EXPECTEDRESULT(    <link type="text/css" href="/ROOT/skin/search_results.css?cacheid=76d39c84" rel="Stylesheet" />
-  <link type="root" href="/ROOT"><link type="text/css" href="/ROOT/skin/taskbar.css?cacheid=26082885" rel="Stylesheet" />
-<link type="text/css" href="/ROOT/skin/css/autoComplete.css?cacheid=08951e06" rel="Stylesheet" />
-<script type="text/javascript" src="/ROOT/skin/taskbar.js?cacheid=1aec4a68" defer></script>
-<script type="text/javascript" src="/ROOT/skin/autoComplete.min.js?cacheid=1191aaaf"></script>
-        <label for="kiwix_button_show_toggle"><img src="/ROOT/skin/caret.png?cacheid=22b942b4" alt=""></label>
 )EXPECTEDRESULT"
    },
  };
@ -442,13 +431,8 @@ public:
  std::string expectedResponse() const;

 private:
-  bool isTranslatedVersion() const;
  virtual std::string pageTitle() const;
  std::string pageCssLink() const;
-  std::string hiddenBookNameInput() const;
-  std::string searchPatternInput() const;
-  std::string taskbarLinks() const;
-  std::string goToWelcomePageText() const;
 };

 std::string TestContentIn404HtmlResponse::expectedResponse() const
@ -464,40 +448,8 @@ std::string TestContentIn404HtmlResponse::expectedResponse() const
 )FRAG",

    R"FRAG(
-  <link type="root" href="/ROOT"><link type="text/css" href="/ROOT/skin/taskbar.css?cacheid=26082885" rel="Stylesheet" />
-<link type="text/css" href="/ROOT/skin/css/autoComplete.css?cacheid=08951e06" rel="Stylesheet" />
-<script type="text/javascript" src="/ROOT/skin/taskbar.js?cacheid=1aec4a68" defer></script>
-<script type="text/javascript" src="/ROOT/skin/autoComplete.min.js?cacheid=1191aaaf"></script>
-</head>
-  <body><span class="kiwix">
-  <span id="kiwixtoolbar" class="ui-widget-header">
-    <div class="kiwix_centered">
-      <div class="kiwix_searchform">
-        <form class="kiwixsearch" method="GET" action="/ROOT/search" id="kiwixsearchform">
-          )FRAG",
-
-  R"FRAG(
-          <label for="kiwixsearchbox">&#x1f50d;</label>
-)FRAG",
-
-  R"FRAG(        </form>
-      </div>
-        <input type="checkbox" id="kiwix_button_show_toggle">
-        <label for="kiwix_button_show_toggle"><img src="/ROOT/skin/caret.png?cacheid=22b942b4" alt=""></label>
-        <div class="kiwix_button_cont">
-            <a id="kiwix_serve_taskbar_library_button" title=")FRAG",
-
-  R"FRAG(" aria-label=")FRAG",
-
-  R"FRAG(" href="/ROOT/"><button>&#x1f3e0;</button></a>
-          )FRAG",
-
-  R"FRAG(
-        </div>
-    </div>
-  </span>
-</span>
-)FRAG",
+  <link type="root" href="/ROOT"></head>
+  <body>)FRAG",

  R"FRAG(  </body>
 </html>
@ -509,18 +461,8 @@ std::string TestContentIn404HtmlResponse::expectedResponse() const
       + frag[1]
       + pageCssLink()
       + frag[2]
-       + hiddenBookNameInput()
-       + frag[3]
-       + searchPatternInput()
-       + frag[4]
-       + goToWelcomePageText()
-       + frag[5]
-       + goToWelcomePageText()
-       + frag[6]
-       + taskbarLinks()
-       + frag[7]
       + expectedBody
-       + frag[8];
+       + frag[3];
 }

 std::string TestContentIn404HtmlResponse::pageTitle() const
@ -540,71 +482,6 @@ std::string TestContentIn404HtmlResponse::pageCssLink() const
       + R"(" rel="Stylesheet" />)";
 }

-std::string TestContentIn404HtmlResponse::hiddenBookNameInput() const
-{
-  return bookName.empty()
-       ? ""
-       : R"(<input type="hidden" name="content" value=")" + bookName + R"(" />)";
-}
-
-std::string TestContentIn404HtmlResponse::searchPatternInput() const
-{
-  const std::string searchboxTooltip = isTranslatedVersion()
-                                    ? "Որոնել '" + bookTitle + "'֊ում"
-                                    : "Search '" + bookTitle + "'";
-  return R"(          <input autocomplete="off" id="kiwixsearchbox" name="pattern" type="text" size="50" title=")"
-       + searchboxTooltip
-       + R"(" aria-label=")"
-       + searchboxTooltip
-       + R"(">
-)";
-}
-
-std::string TestContentIn404HtmlResponse::taskbarLinks() const
-{
-  if ( bookName.empty() )
-    return "";
-
-  const auto goToMainPageOfBook = isTranslatedVersion()
-                                ? "Դեպի '" + bookTitle + "'֊ի գլխավոր էջը"
-                                : "Go to the main page of '" + bookTitle + "'";
-
-  const std::string goToRandomPage = isTranslatedVersion()
-                                   ? "Բացել պատահական էջ"
-                                   : "Go to a randomly selected page";
-
-  return R"(<a id="kiwix_serve_taskbar_home_button" title=")"
-       + goToMainPageOfBook
-       + R"(" aria-label=")"
-       + goToMainPageOfBook
-       + R"(" href="/ROOT/)"
-       + bookName
-       + R"(/"><button>)"
-       + bookTitle
-       + R"(</button></a>
-          <a id="kiwix_serve_taskbar_random_button" title=")"
-       + goToRandomPage
-       + R"(" aria-label=")"
-       + goToRandomPage
-       + R"("
-            href="/ROOT/random?content=)"
-       + bookName
-       + R"("><button>&#x1F3B2;</button></a>)";
-}
-
-bool TestContentIn404HtmlResponse::isTranslatedVersion() const
-{
-  return url.find("userlang=hy") != std::string::npos;
-}
-
-std::string TestContentIn404HtmlResponse::goToWelcomePageText() const
-{
-  return isTranslatedVersion()
-       ? "Գրադարանի էջ"
-       : "Go to welcome page";
-}
-
-
 class TestContentIn400HtmlResponse : public TestContentIn404HtmlResponse
 {
 public:
@ -1156,7 +1033,7 @@ TEST_F(ServerTest, RawEntry)
  p = zfs1_->GET("/ROOT/content/zimfile/A/Ray_Charles");
  EXPECT_EQ(200, p->status);
  EXPECT_NE(std::string(p->body), std::string(entry.getItem(true).getData()));
-  EXPECT_TRUE(p->body.find("taskbar") != std::string::npos);
+  EXPECT_TRUE(p->body.find("<link type=\"root\" href=\"/ROOT\">") != std::string::npos);
 }

 TEST_F(ServerTest, HeadMethodIsSupported)