/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */
/*
 * Copyright the Collabora Online contributors.
 *
 * SPDX-License-Identifier: MPL-2.0
 *
 * 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/.
 */

/*
 * Unit test for insert and delete operations.
 */

#include <config.h>

#include <Poco/Exception.h>
#include <Poco/URI.h>
#include <test/lokassert.hpp>

#include <Png.hpp>
#include <Unit.hpp>
#include <helpers.hpp>

#include <chrono>
#include <memory>
#include <ostream>
#include <string>

using namespace std::literals;

namespace
{
std::vector<std::string> getPartHashCodes(const Poco::SharedPtr<Poco::JSON::Object> status)
{
    std::vector<std::string> partHashes;

    for (std::size_t i = 0; i < status->getArray("parts")->size(); i++)
    {
        partHashes.push_back(status->getArray("parts")->getObject(i)->get("part").toString());
    }

    return partHashes;
}

// .uno:InsertPage can sometimes send status: messages more than once, so drain the
// previous messages, explicitly ask for current status and get the part hash codes.
std::vector<std::string> drainAndGetPartHashCodes(
    const std::shared_ptr<http::WebSocketSession>& socket, const std::string& testname,
    Poco::JSON::Parser& parser)
{
    helpers::drain(socket, testname);
    helpers::sendTextFrame(socket, "status", testname);
    const std::string response = helpers::getResponseString(socket, "status:", testname);
    LOK_ASSERT_MESSAGE("did not receive a status: message as expected", !response.empty());
    const Poco::Dynamic::Var statusJsonVar = parser.parse(response.substr(7));
    const auto& status = statusJsonVar.extract<Poco::JSON::Object::Ptr>();
    return getPartHashCodes(status);
}
}

/// Test suite for insertion/deletion.
class UnitInsertDelete : public UnitWSD
{
    TestResult testInsertDelete();
    TestResult testInsertKeepsSlideTiles();
    TestResult testPasteBlank();
    TestResult testGetTextSelection();
    TestResult testCursorPosition();

public:
    UnitInsertDelete()
        : UnitWSD("UnitInsertDelete")
    {
    }

    void invokeWSDTest() override;
};

UnitBase::TestResult UnitInsertDelete::testInsertDelete()
{
    try
    {
        std::vector<std::string> currentPartHashes;
        std::string response;

        // Load a document
        std::string documentPath, documentURL;
        helpers::getDocumentPathAndURL("insert-delete.odp", documentPath, documentURL, testname);

        std::shared_ptr<SocketPoll> socketPoll = std::make_shared<SocketPoll>(testname);
        socketPoll->startThread();

        std::shared_ptr<http::WebSocketSession> socket = helpers::loadDocAndGetSession(
            socketPoll, Poco::URI(helpers::getTestServerURI()), documentURL, testname);

        // check total slides 1
        TST_LOG("Expecting 1 slide.");
        helpers::sendTextFrame(socket, "status", testname);
        response = helpers::getResponseString(socket, "status:", testname);
        LOK_ASSERT_MESSAGE("did not receive a status: message as expected", !response.empty());

        Poco::JSON::Parser parser;
        Poco::Dynamic::Var statusJsonVar = parser.parse(response.substr(7));
        const Poco::SharedPtr<Poco::JSON::Object>& statusJsonObject = statusJsonVar.extract<Poco::JSON::Object::Ptr>();

        currentPartHashes = getPartHashCodes(statusJsonObject);

        LOK_ASSERT_EQUAL(static_cast<std::size_t>(1), currentPartHashes.size());

        const std::string slide1Hash = currentPartHashes[0];

        // insert 10 slides
        TST_LOG("Inserting 10 slides.");
        for (size_t it = 1; it <= 10; it++)
        {
            helpers::sendTextFrame(socket, "uno .uno:InsertPage", testname);
            response = helpers::getResponseString(socket, "status:", testname);

            LOK_ASSERT_MESSAGE("did not receive a status: message as expected",
                                   !response.empty());

            statusJsonVar = parser.parse(response.substr(7));
            const Poco::SharedPtr<Poco::JSON::Object>& loopStatusJsonObject = statusJsonVar.extract<Poco::JSON::Object::Ptr>();

            currentPartHashes = getPartHashCodes(loopStatusJsonObject);

            //FIXME: enable this when fixed
            //LOK_ASSERT_EQUAL(it + 1, currentPartHashes.size());
        }

        currentPartHashes = drainAndGetPartHashCodes(socket, testname, parser);
        LOK_ASSERT_EQUAL(static_cast<std::size_t>(11), currentPartHashes.size());

        LOK_ASSERT_MESSAGE("Hash code of slide #1 changed after inserting extra slides.",
                               currentPartHashes[0] == slide1Hash);

        const std::vector<std::string> parts_after_insert = currentPartHashes;

        // delete 10 slides
        TST_LOG("Deleting 10 slides.");
        for (size_t it = 1; it <= 10; it++)
        {
            // Explicitly delete the nth slide, named by its unique id. Past the
            // end of the shrinking list, stay on the last slide, which is where
            // an out-of-range index used to be clamped.
            const std::size_t partIndex = std::min(it, currentPartHashes.size() - 1);
            helpers::sendTextFrame(socket, "setclientpart part=" + currentPartHashes[partIndex],
                                   testname);
            helpers::sendTextFrame(socket, "uno .uno:DeletePage", testname);
            response = helpers::getResponseString(socket, "status:", testname);
            LOK_ASSERT_MESSAGE("did not receive a status: message as expected",
                                   !response.empty());

            statusJsonVar = parser.parse(response.substr(7));
            const Poco::SharedPtr<Poco::JSON::Object>& loopStatusJsonObject = statusJsonVar.extract<Poco::JSON::Object::Ptr>();

            currentPartHashes = getPartHashCodes(loopStatusJsonObject);

            LOK_ASSERT_EQUAL(11 - it, currentPartHashes.size());
        }

        LOK_ASSERT_MESSAGE("Hash code of slide #1 changed after deleting extra slides.",
                               currentPartHashes[0] == slide1Hash);

        // undo delete slides
        TST_LOG("Undoing 10 slide deletes.");
        for (size_t it = 1; it <= 10; it++)
        {
            helpers::sendTextFrame(socket, "uno .uno:Undo", testname);
            response = helpers::getResponseString(socket, "status:", testname);
            LOK_ASSERT_MESSAGE("did not receive a status: message as expected",
                                   !response.empty());

            statusJsonVar = parser.parse(response.substr(7));
            const Poco::SharedPtr<Poco::JSON::Object>& loopStatusJsonObject = statusJsonVar.extract<Poco::JSON::Object::Ptr>();

            currentPartHashes = getPartHashCodes(loopStatusJsonObject);

            LOK_ASSERT_EQUAL(it + 1, currentPartHashes.size());
        }

        currentPartHashes = drainAndGetPartHashCodes(socket, testname, parser);
        LOK_ASSERT_EQUAL(static_cast<std::size_t>(11), currentPartHashes.size());

        LOK_ASSERT_MESSAGE("Hash code of slide #1 changed after undoing slide delete.",
                               currentPartHashes[0] == slide1Hash);

        const std::vector<std::string> parts_after_undo = currentPartHashes;

        LOK_ASSERT_MESSAGE("Hash codes changed between deleting and undo.",
                               parts_after_insert == parts_after_undo);

        // redo inserted slides
        TST_LOG("Redoing 10 slide deletes.");
        for (size_t it = 1; it <= 10; it++)
        {
            helpers::sendTextFrame(socket, "uno .uno:Redo", testname);
            response = helpers::getResponseString(socket, "status:", testname);
            LOK_ASSERT_MESSAGE("did not receive a status: message as expected",
                                   !response.empty());

            statusJsonVar = parser.parse(response.substr(7));
            const Poco::SharedPtr<Poco::JSON::Object>& loopStatusJsonObject = statusJsonVar.extract<Poco::JSON::Object::Ptr>();

            currentPartHashes = getPartHashCodes(loopStatusJsonObject);

            LOK_ASSERT_EQUAL(11 - it, currentPartHashes.size());
        }

        LOK_ASSERT_MESSAGE("Hash code of slide #1 changed after redoing slide delete.",
                               currentPartHashes[0] == slide1Hash);

        // check total slides 1
        TST_LOG("Expecting 1 slide.");
        helpers::sendTextFrame(socket, "status", testname);
        response = helpers::getResponseString(socket, "status:", testname);
        LOK_ASSERT_MESSAGE("did not receive a status: message as expected", !response.empty());

        statusJsonVar = parser.parse(response.substr(7));
        const Poco::SharedPtr<Poco::JSON::Object>& checkStatusJsonObject = statusJsonVar.extract<Poco::JSON::Object::Ptr>();
        currentPartHashes = getPartHashCodes(checkStatusJsonObject);

        LOK_ASSERT_EQUAL((long unsigned int)1, currentPartHashes.size());
    }
    catch (const Poco::Exception& exc)
    {
        LOK_ASSERT_FAIL(exc.displayText());
    }
    return TestResult::Ok;
}

UnitBase::TestResult UnitInsertDelete::testInsertKeepsSlideTiles()
{
    try
    {
        // Load a presentation with a single slide, which shows no page-number or page-count
        // field.
        std::string documentPath, documentURL;
        helpers::getDocumentPathAndURL("insert-delete.odp", documentPath, documentURL, testname);

        std::shared_ptr<SocketPoll> socketPoll = std::make_shared<SocketPoll>(testname);
        socketPoll->startThread();

        std::shared_ptr<http::WebSocketSession> socket = helpers::loadDocAndGetSession(
            socketPoll, Poco::URI(helpers::getTestServerURI()), documentURL, testname);

        // Grow the document to two slides, so the later insertions and deletions happen on
        // the second slide while the first one stays put.
        helpers::sendTextFrame(socket, "uno .uno:InsertPage", testname);

        Poco::JSON::Parser parser;
        std::vector<std::string> partIds = drainAndGetPartHashCodes(socket, testname, parser);
        LOK_ASSERT_EQUAL(static_cast<std::size_t>(2), partIds.size());
        const std::string firstSlideId = partIds[0];

        // Hold a tile of the first slide.
        helpers::sendTextFrame(socket,
                               "tile nviewid=0 part=" + firstSlideId +
                                   " width=256 height=256 tileposx=0 tileposy=0 "
                                   "tilewidth=3840 tileheight=3840",
                               testname);
        const std::vector<char> tile = helpers::getTileMessage(socket, testname);
        LOK_ASSERT_MESSAGE("did not receive a tile of the first slide", !tile.empty());
        helpers::drain(socket, testname);

        // Check that no invalidation received on the socket names the first slide. Tiles are
        // keyed by each slide's stable unique id, so the first slide's tiles stay valid when
        // the other slides change.
        auto assertFirstSlideTilesValid = [&](const std::string& when)
        {
            for (;;)
            {
                const std::string invalidation = helpers::getResponseString(
                    socket, "invalidatetiles:", testname, std::chrono::milliseconds(1000));
                if (invalidation.empty())
                    break;
                LOK_ASSERT_MESSAGE("the first slide's tiles were invalidated " + when + ": " +
                                       invalidation,
                                   invalidation.find("part=" + firstSlideId + ' ') ==
                                           std::string::npos &&
                                       invalidation.find("EMPTY, " + firstSlideId + ',') ==
                                           std::string::npos);
            }
        };

        // Insert a slide after the current second one.
        TST_LOG("Inserting a slide after the first one.");
        helpers::sendTextFrame(socket, "uno .uno:InsertPage", testname);
        std::string response = helpers::getResponseString(socket, "status:", testname);
        LOK_ASSERT_MESSAGE("did not receive a status: message as expected", !response.empty());
        assertFirstSlideTilesValid("after inserting a slide");

        // Delete the current slide again.
        TST_LOG("Deleting the inserted slide.");
        helpers::sendTextFrame(socket, "uno .uno:DeletePage", testname);
        response = helpers::getResponseString(socket, "status:", testname);
        LOK_ASSERT_MESSAGE("did not receive a status: message as expected", !response.empty());
        assertFirstSlideTilesValid("after deleting a slide");

        socket->asyncShutdown();
        LOK_ASSERT_MESSAGE("Expected successful disconnection of the WebSocket",
                           socket->waitForDisconnection(std::chrono::seconds(5)));
    }
    catch (const Poco::Exception& exc)
    {
        LOK_ASSERT_FAIL(exc.displayText());
    }
    return TestResult::Ok;
}

UnitBase::TestResult UnitInsertDelete::testPasteBlank()
{
    try
    {
        // Load a document and make it empty, then paste nothing into it.
        std::string documentPath, documentURL;
        helpers::getDocumentPathAndURL("hello.odt", documentPath, documentURL, testname);

        std::shared_ptr<SocketPoll> socketPoll = std::make_shared<SocketPoll>(testname);
        socketPoll->startThread();

        std::shared_ptr<http::WebSocketSession> wsSession = helpers::loadDocAndGetSession(
            socketPoll, Poco::URI(helpers::getTestServerURI()), documentURL, testname);

        // Drain the 'textselection:' issued upon loading, which confuses the following SelectAll.
        helpers::getResponseMessage(wsSession, "textselection:", testname);

        TST_LOG("deleteAll");
        helpers::deleteAll(wsSession, testname, 3s);

        // Paste nothing into it.
        TST_LOG("paste mimetype=text/plain;charset=utf-8");
        helpers::sendAndDrain(wsSession, "paste mimetype=text/plain;charset=utf-8\n", testname, "",
                              500ms);

        // Check if the document contains the pasted text.
        TST_LOG("selectAll");
        helpers::selectAll(wsSession, testname, 200ms, 2);

        TST_LOG("gettextselection");
        helpers::sendTextFrame(wsSession, "gettextselection mimetype=text/plain;charset=utf-8", testname);
        TST_LOG("getResponseString");
        const std::string prefix = "textselectioncontent: ";
        const std::string text = helpers::getResponseString(wsSession, prefix, testname);
        LOK_ASSERT_EQUAL(prefix, text);

        socketPoll->joinThread();
    }
    catch (const Poco::Exception& exc)
    {
        LOK_ASSERT_FAIL(exc.displayText());
    }
    return TestResult::Ok;
}

UnitBase::TestResult UnitInsertDelete::testGetTextSelection()
{
    try
    {
        std::string documentPath, documentURL;
        helpers::getDocumentPathAndURL("hello.odt", documentPath, documentURL, testname);

        Poco::URI uri(helpers::getTestServerURI());

        std::shared_ptr<SocketPoll> socketPoll = std::make_shared<SocketPoll>("InsertDeletePoll");
        socketPoll->startThread();

        std::shared_ptr<http::WebSocketSession> socket =
            helpers::loadDocAndGetSession(socketPoll, uri, documentURL, testname);

        std::shared_ptr<http::WebSocketSession> socket2 =
            helpers::loadDocAndGetSession(socketPoll, uri, documentURL, testname);

        static const std::string expected = "Hello world";
        const std::string selection = helpers::getAllText(socket, testname, expected);
        LOK_ASSERT_EQUAL("textselectioncontent: " + expected, selection);
    }
    catch (const Poco::Exception& exc)
    {
        LOK_ASSERT_FAIL(exc.displayText());
    }
    return TestResult::Ok;
}

UnitBase::TestResult UnitInsertDelete::testCursorPosition()
{
    try
    {
        // Load a document.
        std::string docPath;
        std::string documentURL;
        std::string response;

        helpers::getDocumentPathAndURL("Example.odt", docPath, documentURL, testname);
        Poco::URI uri(helpers::getTestServerURI());

        std::shared_ptr<SocketPoll> socketPoll = std::make_shared<SocketPoll>("InsertDeletePoll");
        socketPoll->startThread();

        std::shared_ptr<http::WebSocketSession> socket0 =
            helpers::loadDocAndGetSession(socketPoll, uri, documentURL, testname);

        // receive cursor position
        response = helpers::getResponseString(socket0, "invalidatecursor:", testname);

        Poco::JSON::Parser parser0;
        const Poco::Dynamic::Var result0 = parser0.parse(response.substr(17));
        const auto& command0 = result0.extract<Poco::JSON::Object::Ptr>();
        LOK_ASSERT_MESSAGE("missing property rectangle", command0->has("rectangle"));

        StringVector cursorTokens(
            StringVector::tokenize(command0->get("rectangle").toString(), ','));
        LOK_ASSERT_EQUAL(static_cast<size_t>(4), cursorTokens.size());

        // Create second view
        std::shared_ptr<http::WebSocketSession> socket1 =
            helpers::loadDocAndGetSession(socketPoll, uri, documentURL, testname);

        //receive view cursor position
        response = helpers::getResponseString(socket1, "invalidateviewcursor:", testname);

        Poco::JSON::Parser parser;
        const Poco::Dynamic::Var result = parser.parse(response.substr(21));
        const auto& command = result.extract<Poco::JSON::Object::Ptr>();
        LOK_ASSERT_MESSAGE("missing property rectangle", command->has("rectangle"));

        StringVector viewTokens(
            StringVector::tokenize(command->get("rectangle").toString(), ','));
        LOK_ASSERT_EQUAL(static_cast<size_t>(4), viewTokens.size());

        // check both cursor should be equal
        LOK_ASSERT_EQUAL(cursorTokens[0], viewTokens[0]);
        LOK_ASSERT_EQUAL(cursorTokens[1], viewTokens[1]);
        LOK_ASSERT_EQUAL(cursorTokens[2], viewTokens[2]);
        LOK_ASSERT_EQUAL(cursorTokens[3], viewTokens[3]);
    }
    catch (const Poco::Exception& exc)
    {
        LOK_ASSERT_FAIL(exc.displayText());
    }
    return TestResult::Ok;
}

void UnitInsertDelete::invokeWSDTest()
{
    UnitBase::TestResult result = TestResult::Ok;

    result = testInsertDelete();
    if (result != TestResult::Ok)
        exitTest(result);

    result = testInsertKeepsSlideTiles();
    if (result != TestResult::Ok)
        exitTest(result);

    result = testPasteBlank();
    if (result != TestResult::Ok)
        exitTest(result);

    result = testGetTextSelection();
    if (result != TestResult::Ok)
        exitTest(result);

    result = testCursorPosition();
    if (result != TestResult::Ok)
        exitTest(result);

    exitTest(TestResult::Ok);
}

UnitBase* unit_create_wsd(void) { return new UnitInsertDelete(); }

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */