libreoffice-online/loolwsd/ChildSession.hpp
Ashod Nakashian e08503e275 loolwsd: save and replay doc state changes
Document state changes come in with the same
event ID. We need to store them in a separate
map (also renamed the old 'states' map to 'events').

All important events are now replayed correctly and traced.

Change-Id: I52346b0d252730ba5cedb091b14898479c2a52c5
Reviewed-on: https://gerrit.libreoffice.org/30466
Reviewed-by: Ashod Nakashian <ashnakash@gmail.com>
Tested-by: Ashod Nakashian <ashnakash@gmail.com>
2016-11-01 13:26:49 +00:00

140 lines
5.5 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */
/*
* This file is part of the LibreOffice project.
*
* 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/.
*/
#ifndef INCLUDED_CHILDSESSION_HPP
#define INCLUDED_CHILDSESSION_HPP
#include <mutex>
#include <Poco/NotificationQueue.h>
#include <Poco/Thread.h>
#include "Common.hpp"
#include "LOOLKit.hpp"
#include "LOOLSession.hpp"
#include "LibreOfficeKit.hpp"
class ChildSession;
/// An abstract interface that defines the
/// DocumentManager interface and functionality.
class IDocumentManager
{
public:
/// Reqest loading a document, or a new view, if one exists.
virtual std::shared_ptr<lok::Document> onLoad(const std::string& sessionId,
const std::string& jailedFilePath,
const std::string& userName,
const std::string& docPassword,
const std::string& renderOpts,
const bool haveDocPassword)
= 0;
/// Unload a client session, which unloads the document
/// if it is the last and only.
virtual void onUnload(const ChildSession& session) = 0;
/// Send updated view info to all active sessions
virtual void notifyViewInfo(const std::vector<int>& viewIds) = 0;
/// Get a view ID <-> UserInfo map.
virtual std::map<int, UserInfo> getViewInfo() = 0;
virtual std::mutex& getMutex() = 0;
virtual std::shared_ptr<TileQueue>& getTileQueue() = 0;
virtual bool sendTextFrame(const std::string& message) = 0;
};
/// Represents a session to the WSD process, in a Kit process. Note that this is not a singleton.
class ChildSession final : public LOOLSession
{
public:
/// Create a new ChildSession
/// ws The socket between master and kit (jailed).
/// loKit The LOKit instance.
/// loKitDocument The instance to an existing document (when opening
/// a new view) or nullptr (when first view).
/// jailId The JailID of the jail root directory,
// used by downloadas to construct jailed path.
ChildSession(const std::string& id,
const std::string& jailId,
IDocumentManager& docManager);
virtual ~ChildSession();
bool getStatus(const char* buffer, int length);
bool getPartPageRectangles(const char* buffer, int length);
int getViewId() const { return _viewId; }
void setViewId(const int viewId) { _viewId = viewId; }
const std::string& getViewUserId() const { return _userId; }
const std::string& getViewUserName() const { return _userName; }
void loKitCallback(const int nType, const std::string& rPayload);
bool sendTextFrame(const char* buffer, const int length) override
{
const auto msg = "client-" + getId() + ' ' + std::string(buffer, length);
const auto lock = getLock();
return _docManager.sendTextFrame(msg);
}
bool sendTextFrame(const std::string& text)
{
return sendTextFrame(text.data(), text.size());
}
private:
bool loadDocument(const char* buffer, int length, Poco::StringTokenizer& tokens);
bool sendFontRendering(const char* buffer, int length, Poco::StringTokenizer& tokens);
bool getCommandValues(const char* buffer, int length, Poco::StringTokenizer& tokens);
bool clientZoom(const char* buffer, int length, Poco::StringTokenizer& tokens);
bool clientVisibleArea(const char* buffer, int length, Poco::StringTokenizer& tokens);
bool downloadAs(const char* buffer, int length, Poco::StringTokenizer& tokens);
bool getChildId();
bool getTextSelection(const char* buffer, int length, Poco::StringTokenizer& tokens);
bool paste(const char* buffer, int length, Poco::StringTokenizer& tokens);
bool insertFile(const char* buffer, int length, Poco::StringTokenizer& tokens);
bool keyEvent(const char* buffer, int length, Poco::StringTokenizer& tokens);
bool mouseEvent(const char* buffer, int length, Poco::StringTokenizer& tokens);
bool unoCommand(const char* buffer, int length, Poco::StringTokenizer& tokens);
bool selectText(const char* buffer, int length, Poco::StringTokenizer& tokens);
bool selectGraphic(const char* buffer, int length, Poco::StringTokenizer& tokens);
bool resetSelection(const char* buffer, int length, Poco::StringTokenizer& tokens);
bool saveAs(const char* buffer, int length, Poco::StringTokenizer& tokens);
bool setClientPart(const char* buffer, int length, Poco::StringTokenizer& tokens);
bool setPage(const char* buffer, int length, Poco::StringTokenizer& tokens);
virtual void disconnect() override;
virtual bool _handleInput(const char* buffer, int length) override;
private:
const std::string _jailId;
IDocumentManager& _docManager;
/// View ID, returned by createView() or 0 by default.
int _viewId;
/// Whether document has been opened succesfuly
bool _isDocLoaded;
std::shared_ptr<lok::Document> _loKitDocument;
std::string _docType;
std::map<std::string, std::string> _lastDocStates;
std::map<int, std::string> _lastDocEvents;
/// Synchronize _loKitDocument access.
/// This should be owned by Document.
static std::recursive_mutex Mutex;
};
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */