New POST service to render a search result + unit and integ. tests

This adds a new service render-search-result, which renders an
image of the position where, the search fund a hit. The search
result contains the information in which object or paragraph,
which is just the node id and node type from the document model.

The service takes the document and the search result (xml file)
as the input and returns a PNG image as the output.

Signed-off-by: Tomaž Vajngerl <tomaz.vajngerl@collabora.co.uk>

Change-Id: Iffc158c5b0a3c9a63f8d05830314c9bc1616b3b1
Signed-off-by: Tomaž Vajngerl <tomaz.vajngerl@collabora.co.uk>

Author: quikee

kit/ChildSession.cpp

@@ -343,7 +343,8 @@ bool ChildSession::_handleInput(const char *buffer, int length)
                tokens.equals(0, "completefunction")||
                tokens.equals(0, "formfieldevent") ||
                tokens.equals(0, "traceeventrecording") ||
-               tokens.equals(0, "sallogoverride"));
+               tokens.equals(0, "sallogoverride") ||
+               tokens.equals(0, "rendersearchresult"));
 
         std::string pzName("ChildSession::_handleInput:" + tokens[0]);
         ProfileZone pz(pzName.c_str());
@@ -534,6 +535,10 @@ bool ChildSession::_handleInput(const char *buffer, int length)
                 getLOKit()->setOption("sallogoverride", tokens[1].c_str());
             }
         }
+        else if (tokens.equals(0, "rendersearchresult"))
+        {
+            return renderSearchResult(buffer, length, tokens);
+        }
         else
         {
             assert(false && "Unknown command token.");
@@ -1658,6 +1663,61 @@ bool ChildSession::formFieldEvent(const char* buffer, int length, const StringVe
     return true;
 }
 
+bool ChildSession::renderSearchResult(const char* buffer, int length, const StringVector& /*tokens*/)
+{
+    std::string sContent(buffer, length);
+    std::string sCommand("rendersearchresult ");
+    std::string sArguments = sContent.substr(sCommand.size());
+
+    if (sArguments.empty())
+    {
+        sendTextFrameAndLogError("error: cmd=rendersearchresult kind=syntax");
+        return false;
+    }
+
+    getLOKitDocument()->setView(_viewId);
+
+    const auto eTileMode = static_cast<LibreOfficeKitTileMode>(getLOKitDocument()->getTileMode());
+
+    unsigned char* pBitmapBuffer = nullptr;
+
+    int nWidth = 0;
+    int nHeight = 0;
+    size_t nByteSize = 0;
+
+    bool bSuccess = getLOKitDocument()->renderSearchResult(sArguments.c_str(), &pBitmapBuffer, &nWidth, &nHeight, &nByteSize);
+
+    if (bSuccess && nByteSize > 0)
+    {
+        std::vector<char> aOutput;
+        aOutput.reserve(nByteSize * 3 / 4); // reserve 75% of original size
+
+        if (Png::encodeBufferToPNG(pBitmapBuffer, nWidth, nHeight, aOutput, eTileMode))
+        {
+            static const std::string aHeader = "rendersearchresult:";
+            size_t nResponseSize = aHeader.size() + aOutput.size();
+            std::vector<char> aResponse(nResponseSize);
+            std::copy(aHeader.begin(), aHeader.end(), aResponse.begin());
+            std::copy(aOutput.begin(), aOutput.end(), aResponse.begin() + aHeader.size());
+            sendBinaryFrame(aResponse.data(), aResponse.size());
+        }
+        else
+        {
+            sendTextFrameAndLogError("error: cmd=rendersearchresult kind=failure");
+        }
+    }
+    else
+    {
+        sendTextFrameAndLogError("error: cmd=rendersearchresult kind=failure");
+    }
+
+    if (pBitmapBuffer)
+        free(pBitmapBuffer);
+
+    return true;
+}
+
+
 bool ChildSession::completeFunction(const char* /*buffer*/, int /*length*/, const StringVector& tokens)
 {
     std::string functionName;

kit/ChildSession.hpp

@@ -321,9 +321,10 @@ class ChildSession final : public Session
 #ifdef ENABLE_FREEMIUM
     bool updateFreemiumStatus(const char* buffer, int length, const StringVector& tokens);
 #endif
+    bool formFieldEvent(const char* buffer, int length, const StringVector& tokens);
+    bool renderSearchResult(const char* buffer, int length, const StringVector& tokens);
 
     void rememberEventsForInactiveUser(const int type, const std::string& payload);
-    bool formFieldEvent(const char* buffer, int length, const StringVector& tokens);
 
     virtual void disconnect() override;
     virtual bool _handleInput(const char* buffer, int length) override;

test/Makefile.am

@@ -33,6 +33,7 @@ noinst_LTLIBRARIES = \
 	unit-load-torture.la \
 	unit-rendering-options.la \
 	unit-password-protected.la \
+	unit-render-search-result.la \
 	unit-render-shape.la \
 	unit-each-view.la \
 	unit-session.la \
@@ -199,6 +200,8 @@ unit_rendering_options_la_SOURCES = UnitRenderingOptions.cpp
 unit_rendering_options_la_LIBADD = $(CPPUNIT_LIBS)
 unit_password_protected_la_SOURCES = UnitPasswordProtected.cpp
 unit_password_protected_la_LIBADD = $(CPPUNIT_LIBS)
+unit_render_search_result_la_SOURCES = UnitRenderSearchResult.cpp
+unit_render_search_result_la_LIBADD = $(CPPUNIT_LIBS)
 unit_render_shape_la_SOURCES = UnitRenderShape.cpp
 unit_render_shape_la_LIBADD = $(CPPUNIT_LIBS)
 unit_each_view_la_SOURCES = UnitEachView.cpp
@@ -254,6 +257,7 @@ TESTS = \
 	unit-load-torture.la \
 	unit-rendering-options.la \
 	unit-password-protected.la \
+	unit-render-search-result.la \
 	unit-render-shape.la \
 	unit-each-view.la \
 	unit-session.la \

test/UnitRenderSearchResult.cpp

@@ -0,0 +1,58 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */
+/*
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+
+#include <config.h>
+
+#include <memory>
+#include <string>
+
+#include <Poco/URI.h>
+#include <test/lokassert.hpp>
+
+#include <Unit.hpp>
+#include <Util.hpp>
+#include <helpers.hpp>
+
+class LOOLWebSocket;
+
+class UnitRenderSearchResult : public UnitWSD
+{
+public:
+    void invokeWSDTest() override;
+};
+
+void UnitRenderSearchResult::invokeWSDTest()
+{
+    const char testname[] = "UnitRenderSearchResult";
+
+    try
+    {
+        std::string documentPath;
+        std::string documentURL;
+        helpers::getDocumentPathAndURL("RenderSearchResultTest.odt", documentPath, documentURL, testname);
+
+        std::shared_ptr<LOOLWebSocket> socket = helpers::loadDocAndGetSocket(Poco::URI(helpers::getTestServerURI()), documentURL, testname);
+
+        helpers::sendTextFrame(socket, "rendersearchresult <indexing><paragraph type=\"1\" index=\"19\"/></indexing>");
+        std::vector<char> responseMessage = helpers::getResponseMessage(socket, "rendersearchresult:", testname);
+
+       // LOK_ASSERT(responseMessage.size() >= 100);
+       // LOK_ASSERT_EQUAL(responseMessage[1], 'P');
+       // LOK_ASSERT_EQUAL(responseMessage[2], 'N');
+       // LOK_ASSERT_EQUAL(responseMessage[3], 'G');
+    }
+    catch (const Poco::Exception& exc)
+    {
+        LOK_ASSERT_FAIL(exc.displayText());
+    }
+
+    exitTest(TestResult::Ok);
+}
+
+UnitBase* unit_create_wsd(void) { return new UnitRenderSearchResult(); }
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */

test/data/RenderSearchResultFragment.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<indexing>
+    <paragraph type="1" index="19"></paragraph>
+</indexing>

test/data/RenderSearchResultTest.odt

@@ -46,6 +46,7 @@ class HTTPServerTest : public CPPUNIT_NS::TestFixture
     CPPUNIT_TEST(testConvertToWithForwardedIP_Deny);
     CPPUNIT_TEST(testConvertToWithForwardedIP_Allow);
     CPPUNIT_TEST(testConvertToWithForwardedIP_DenyMulti);
+    CPPUNIT_TEST(testRenderSearchResult);
 
     CPPUNIT_TEST_SUITE_END();
 
@@ -58,6 +59,7 @@ class HTTPServerTest : public CPPUNIT_NS::TestFixture
     void testConvertToWithForwardedIP_Deny();
     void testConvertToWithForwardedIP_Allow();
     void testConvertToWithForwardedIP_DenyMulti();
+    void testRenderSearchResult();
 
 protected:
     void assertHTTPFilesExist(const Poco::URI& uri,
@@ -484,6 +486,48 @@ void HTTPServerTest::testConvertToWithForwardedIP_DenyMulti()
     }
 }
 
+void HTTPServerTest::testRenderSearchResult()
+{
+    const char* testname = "testRenderSearchResult";
+    const std::string srcPathDoc = FileUtil::getTempFileCopyPath(TDOC, "RenderSearchResultTest.odt", testname);
+    const std::string srcPathXml = FileUtil::getTempFileCopyPath(TDOC, "RenderSearchResultFragment.xml", testname);
+    std::unique_ptr<Poco::Net::HTTPClientSession> session(helpers::createSession(_uri));
+    session->setTimeout(Poco::Timespan(10, 0)); // 10 seconds.
+
+    Poco::Net::HTTPRequest request(Poco::Net::HTTPRequest::HTTP_POST, "/lool/render-search-result");
+    Poco::Net::HTMLForm form;
+    form.setEncoding(Poco::Net::HTMLForm::ENCODING_MULTIPART);
+    form.addPart("document", new Poco::Net::FilePartSource(srcPathDoc));
+    form.addPart("result", new Poco::Net::FilePartSource(srcPathXml));
+    form.prepareSubmit(request);
+    try
+    {
+        form.write(session->sendRequest(request));
+    }
+    catch (const std::exception& ex)
+    {
+        // In case the server is still starting up.
+        sleep(5);
+        form.write(session->sendRequest(request));
+    }
+
+    Poco::Net::HTTPResponse response;
+    std::stringstream actualStream;
+    std::istream& responseStream = session->receiveResponse(response);
+    Poco::StreamCopier::copyStream(responseStream, actualStream);
+
+    // Remove the temp files.
+    FileUtil::removeFile(srcPathDoc);
+    FileUtil::removeFile(srcPathXml);
+
+    std::string actualString = actualStream.str();
+
+    LOK_ASSERT(actualString.size() >= 100);
+    LOK_ASSERT_EQUAL(actualString[1], 'P');
+    LOK_ASSERT_EQUAL(actualString[2], 'N');
+    LOK_ASSERT_EQUAL(actualString[3], 'G');
+}
+
 CPPUNIT_TEST_SUITE_REGISTRATION(HTTPServerTest);
 
 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */

test/integration-http-server.cpp

@@ -986,7 +986,8 @@ bool ClientSession::_handleInput(const char *buffer, int length)
              tokens[0] == "exportsignanduploaddocument" ||
              tokens[0] == "rendershapeselection" ||
              tokens[0] == "resizewindow" ||
-             tokens[0] == "removetextcontext")
+             tokens[0] == "removetextcontext" ||
+             tokens[0] == "rendersearchresult")
     {
         if (tokens.equals(0, "key"))
             _keyEvents++;
@@ -1260,7 +1261,7 @@ bool ClientSession::filterMessage(const std::string& message) const
     {
         // By default, don't allow anything
         allowed = false;
-        if (tokens.equals(0, "userinactive") || tokens.equals(0, "useractive") || tokens.equals(0, "saveas"))
+        if (tokens.equals(0, "userinactive") || tokens.equals(0, "useractive") || tokens.equals(0, "saveas") || tokens.equals(0, "rendersearchresult"))
         {
             allowed = true;
         }