15afe2c0fb
We always one bunch of tiles (e.g. all tiles invalidated) and we are waiting until client send tileprocessed message back for all tiles before sending the new tiles. By canceltiles message we drop every previously requested tiles and make wsd ready to send new tiles, which will be requested by the client in theory. Change-Id: I9901420ada549e962ffaf5e6bd58e52b86bd129d
1759 lines
60 KiB
C++
1759 lines
60 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/.
|
|
*/
|
|
|
|
#include <config.h>
|
|
|
|
#include "DocumentBroker.hpp"
|
|
|
|
#include <atomic>
|
|
#include <cassert>
|
|
#include <chrono>
|
|
#include <ctime>
|
|
#include <fstream>
|
|
#include <sstream>
|
|
|
|
#include <Poco/DigestStream.h>
|
|
#include <Poco/Exception.h>
|
|
#include <Poco/JSON/Object.h>
|
|
#include <Poco/Path.h>
|
|
#include <Poco/SHA1Engine.h>
|
|
#include <Poco/StreamCopier.h>
|
|
#include <Poco/StringTokenizer.h>
|
|
|
|
#include "Admin.hpp"
|
|
#include "ClientSession.hpp"
|
|
#include "Exceptions.hpp"
|
|
#include "LOOLWSD.hpp"
|
|
#include "SenderQueue.hpp"
|
|
#include "Storage.hpp"
|
|
#include "TileCache.hpp"
|
|
#include <common/Log.hpp>
|
|
#include <common/Message.hpp>
|
|
#include <common/Protocol.hpp>
|
|
#include <common/Unit.hpp>
|
|
|
|
#include <sys/types.h>
|
|
#include <sys/wait.h>
|
|
|
|
using namespace LOOLProtocol;
|
|
|
|
using Poco::JSON::Object;
|
|
|
|
void ChildProcess::setDocumentBroker(const std::shared_ptr<DocumentBroker>& docBroker)
|
|
{
|
|
assert(docBroker && "Invalid DocumentBroker instance.");
|
|
_docBroker = docBroker;
|
|
|
|
// Add the prisoner socket to the docBroker poll.
|
|
docBroker->addSocketToPoll(_socket);
|
|
}
|
|
|
|
namespace
|
|
{
|
|
|
|
/// Returns the cache path for a given document URI.
|
|
std::string getCachePath(const std::string& uri)
|
|
{
|
|
Poco::SHA1Engine digestEngine;
|
|
|
|
digestEngine.update(uri.c_str(), uri.size());
|
|
|
|
return LOOLWSD::Cache + '/' +
|
|
Poco::DigestEngine::digestToHex(digestEngine.digest()).insert(3, "/").insert(2, "/").insert(1, "/");
|
|
}
|
|
}
|
|
|
|
Poco::URI DocumentBroker::sanitizeURI(const std::string& uri)
|
|
{
|
|
// The URI of the document should be url-encoded.
|
|
std::string decodedUri;
|
|
Poco::URI::decode(uri, decodedUri);
|
|
Poco::URI uriPublic(decodedUri);
|
|
|
|
if (uriPublic.isRelative() || uriPublic.getScheme() == "file")
|
|
{
|
|
// TODO: Validate and limit access to local paths!
|
|
uriPublic.normalize();
|
|
}
|
|
|
|
if (uriPublic.getPath().empty())
|
|
{
|
|
throw std::runtime_error("Invalid URI.");
|
|
}
|
|
|
|
// We decoded access token before embedding it in loleaflet.html
|
|
// So, we need to decode it now to get its actual value
|
|
Poco::URI::QueryParameters queryParams = uriPublic.getQueryParameters();
|
|
for (auto& param: queryParams)
|
|
{
|
|
// look for encoded query params (access token as of now)
|
|
if (param.first == "access_token")
|
|
{
|
|
std::string decodedToken;
|
|
Poco::URI::decode(param.second, decodedToken);
|
|
param.second = decodedToken;
|
|
}
|
|
}
|
|
|
|
uriPublic.setQueryParameters(queryParams);
|
|
return uriPublic;
|
|
}
|
|
|
|
std::string DocumentBroker::getDocKey(const Poco::URI& uri)
|
|
{
|
|
// If multiple host-names are used to access us, then
|
|
// they must be aliases. Permission to access aliased hosts
|
|
// is checked at the point of accepting incoming connections.
|
|
// At this point storing the hostname artificially discriminates
|
|
// between aliases and forces same document (when opened from
|
|
// alias hosts) to load as separate documents and sharing doesn't
|
|
// work. Worse, saving overwrites one another.
|
|
std::string docKey;
|
|
Poco::URI::encode(uri.getPath(), "", docKey);
|
|
return docKey;
|
|
}
|
|
|
|
/// The Document Broker Poll - one of these in a thread per document
|
|
class DocumentBroker::DocumentBrokerPoll final : public TerminatingPoll
|
|
{
|
|
/// The DocumentBroker owning us.
|
|
DocumentBroker& _docBroker;
|
|
|
|
public:
|
|
DocumentBrokerPoll(const std::string &threadName, DocumentBroker& docBroker) :
|
|
TerminatingPoll(threadName),
|
|
_docBroker(docBroker)
|
|
{
|
|
}
|
|
|
|
virtual void pollingThread()
|
|
{
|
|
// Delegate to the docBroker.
|
|
_docBroker.pollThread();
|
|
}
|
|
};
|
|
|
|
std::atomic<unsigned> DocumentBroker::DocBrokerId(1);
|
|
|
|
DocumentBroker::DocumentBroker(const std::string& uri,
|
|
const Poco::URI& uriPublic,
|
|
const std::string& docKey,
|
|
const std::string& childRoot) :
|
|
_uriOrig(uri),
|
|
_uriPublic(uriPublic),
|
|
_docKey(docKey),
|
|
_docId(Util::encodeId(DocBrokerId++, 3)),
|
|
_childRoot(childRoot),
|
|
_cacheRoot(getCachePath(uriPublic.toString())),
|
|
_documentChangedInStorage(false),
|
|
_lastSaveTime(std::chrono::steady_clock::now()),
|
|
_lastSaveRequestTime(std::chrono::steady_clock::now() - std::chrono::milliseconds(COMMAND_TIMEOUT_MS)),
|
|
_markToDestroy(false),
|
|
_closeRequest(false),
|
|
_isLoaded(false),
|
|
_isModified(false),
|
|
_cursorPosX(0),
|
|
_cursorPosY(0),
|
|
_cursorWidth(0),
|
|
_cursorHeight(0),
|
|
_poll(new DocumentBrokerPoll("docbroker_" + _docId, *this)),
|
|
_stop(false),
|
|
_closeReason("stopped"),
|
|
_tileVersion(0),
|
|
_debugRenderedTileCount(0)
|
|
{
|
|
assert(!_docKey.empty());
|
|
assert(!_childRoot.empty());
|
|
|
|
LOG_INF("DocumentBroker [" << _uriPublic.toString() <<
|
|
"] created with docKey [" << _docKey << "] and root [" << _childRoot << "]");
|
|
}
|
|
|
|
void DocumentBroker::startThread()
|
|
{
|
|
_poll->startThread();
|
|
}
|
|
|
|
void DocumentBroker::assertCorrectThread() const
|
|
{
|
|
_poll->assertCorrectThread();
|
|
}
|
|
|
|
// The inner heart of the DocumentBroker - our poll loop.
|
|
void DocumentBroker::pollThread()
|
|
{
|
|
LOG_INF("Starting docBroker polling thread for docKey [" << _docKey << "].");
|
|
|
|
_threadStart = std::chrono::steady_clock::now();
|
|
|
|
// Request a kit process for this doc.
|
|
do
|
|
{
|
|
static const int timeoutMs = COMMAND_TIMEOUT_MS * 5;
|
|
_childProcess = getNewChild_Blocks();
|
|
if (_childProcess ||
|
|
std::chrono::duration_cast<std::chrono::milliseconds>(std::chrono::steady_clock::now() -
|
|
_threadStart).count() > timeoutMs)
|
|
break;
|
|
|
|
// Nominal time between retries, lest we busy-loop. getNewChild could also wait, so don't double that here.
|
|
std::this_thread::sleep_for(std::chrono::milliseconds(CHILD_REBALANCE_INTERVAL_MS / 10));
|
|
}
|
|
while (!_stop && _poll->continuePolling() && !TerminationFlag && !ShutdownRequestFlag);
|
|
|
|
if (!_childProcess)
|
|
{
|
|
// Let the client know we can't serve now.
|
|
LOG_ERR("Failed to get new child.");
|
|
|
|
// FIXME: need to notify all clients and shut this down ...
|
|
// FIXME: return something good down the websocket ...
|
|
#if 0
|
|
const std::string msg = SERVICE_UNAVAILABLE_INTERNAL_ERROR;
|
|
ws.sendMessage(msg);
|
|
// abnormal close frame handshake
|
|
ws.shutdown(WebSocketHandler::StatusCodes::ENDPOINT_GOING_AWAY);
|
|
#endif
|
|
stop("Failed to get new child.");
|
|
|
|
// Stop to mark it done and cleanup.
|
|
_poll->stop();
|
|
_poll->removeSockets();
|
|
|
|
// Async cleanup.
|
|
LOOLWSD::doHousekeeping();
|
|
|
|
LOG_INF("Finished docBroker polling thread for docKey [" << _docKey << "].");
|
|
return;
|
|
}
|
|
|
|
_childProcess->setDocumentBroker(shared_from_this());
|
|
LOG_INF("Doc [" << _docKey << "] attached to child [" << _childProcess->getPid() << "].");
|
|
|
|
static const bool AutoSaveEnabled = !std::getenv("LOOL_NO_AUTOSAVE");
|
|
static const size_t IdleDocTimeoutSecs = LOOLWSD::getConfigValue<int>(
|
|
"per_document.idle_timeout_secs", 3600);
|
|
|
|
// Used to accumulate B/W deltas.
|
|
uint64_t adminSent = 0;
|
|
uint64_t adminRecv = 0;
|
|
auto lastBWUpdateTime = std::chrono::steady_clock::now();
|
|
auto last30SecCheckTime = std::chrono::steady_clock::now();
|
|
|
|
// Main polling loop goodness.
|
|
while (!_stop && _poll->continuePolling() && !TerminationFlag)
|
|
{
|
|
_poll->poll(SocketPoll::DefaultPollTimeoutMs);
|
|
|
|
const auto now = std::chrono::steady_clock::now();
|
|
|
|
if (std::chrono::duration_cast<std::chrono::milliseconds>
|
|
(now - lastBWUpdateTime).count() >= 5 * 1000)
|
|
{
|
|
lastBWUpdateTime = now;
|
|
uint64_t sent, recv;
|
|
getIOStats(sent, recv);
|
|
// send change since last notification.
|
|
Admin::instance().addBytes(getDocKey(),
|
|
// connection drop transiently reduces this.
|
|
(sent > adminSent ? (sent - adminSent): uint64_t(0)),
|
|
(recv > adminRecv ? (recv - adminRecv): uint64_t(0)));
|
|
LOG_DBG("Doc [" << _docKey << "] added sent: " << sent << " recv: " << recv << " bytes to totals");
|
|
adminSent = sent;
|
|
adminRecv = recv;
|
|
}
|
|
|
|
if (isSaving() &&
|
|
std::chrono::duration_cast<std::chrono::milliseconds>
|
|
(now - _lastSaveRequestTime).count() <= COMMAND_TIMEOUT_MS)
|
|
{
|
|
// We are saving, nothing more to do but wait (until we save or we timeout).
|
|
continue;
|
|
}
|
|
|
|
if (ShutdownRequestFlag || _closeRequest)
|
|
{
|
|
const std::string reason = ShutdownRequestFlag ? "recycling" : _closeReason;
|
|
LOG_INF("Autosaving DocumentBroker for docKey [" << getDocKey() << "] for " << reason);
|
|
if (!autoSave(isPossiblyModified()))
|
|
{
|
|
LOG_INF("Terminating DocumentBroker for docKey [" << getDocKey() << "].");
|
|
stop(reason);
|
|
}
|
|
}
|
|
else if (AutoSaveEnabled && !_stop &&
|
|
std::chrono::duration_cast<std::chrono::seconds>(now - last30SecCheckTime).count() >= 30)
|
|
{
|
|
LOG_TRC("Triggering an autosave.");
|
|
autoSave(false);
|
|
last30SecCheckTime = std::chrono::steady_clock::now();
|
|
}
|
|
|
|
// Remove idle documents after 1 hour.
|
|
const bool idle = (isLoaded() && getIdleTimeSecs() >= IdleDocTimeoutSecs);
|
|
if (idle)
|
|
{
|
|
// Stop if there is nothing to save.
|
|
LOG_INF("Autosaving idle DocumentBroker for docKey [" << getDocKey() << "] to kill.");
|
|
if (!autoSave(isPossiblyModified()))
|
|
{
|
|
LOG_INF("Terminating idle DocumentBroker for docKey [" << getDocKey() << "].");
|
|
stop("idle");
|
|
}
|
|
}
|
|
else if (_sessions.empty() && (isLoaded() || _markToDestroy))
|
|
{
|
|
// If all sessions have been removed, no reason to linger.
|
|
LOG_INF("Terminating dead DocumentBroker for docKey [" << getDocKey() << "].");
|
|
stop("dead");
|
|
}
|
|
}
|
|
|
|
LOG_INF("Finished polling doc [" << _docKey << "]. stop: " << _stop << ", continuePolling: " <<
|
|
_poll->continuePolling() << ", ShutdownRequestFlag: " << ShutdownRequestFlag <<
|
|
", TerminationFlag: " << TerminationFlag << ", closeReason: " << _closeReason << ". Flushing socket.");
|
|
|
|
if (_isModified)
|
|
{
|
|
std::stringstream state;
|
|
dumpState(state);
|
|
LOG_ERR("DocumentBroker stopping although modified " << state.str());
|
|
}
|
|
|
|
// Flush socket data first.
|
|
const int flushTimeoutMs = POLL_TIMEOUT_MS * 2; // ~1000ms
|
|
const auto flushStartTime = std::chrono::steady_clock::now();
|
|
while (_poll->getSocketCount())
|
|
{
|
|
const auto now = std::chrono::steady_clock::now();
|
|
const int elapsedMs = std::chrono::duration_cast<std::chrono::milliseconds>(now - flushStartTime).count();
|
|
if (elapsedMs > flushTimeoutMs)
|
|
break;
|
|
|
|
_poll->poll(std::min(flushTimeoutMs - elapsedMs, POLL_TIMEOUT_MS / 5));
|
|
}
|
|
|
|
LOG_INF("Finished flushing socket for doc [" << _docKey << "]. stop: " << _stop << ", continuePolling: " <<
|
|
_poll->continuePolling() << ", ShutdownRequestFlag: " << ShutdownRequestFlag <<
|
|
", TerminationFlag: " << TerminationFlag << ". Terminating child with reason: [" << _closeReason << "].");
|
|
|
|
// Terminate properly while we can.
|
|
terminateChild(_closeReason);
|
|
|
|
// Stop to mark it done and cleanup.
|
|
_poll->stop();
|
|
_poll->removeSockets();
|
|
|
|
// Async cleanup.
|
|
LOOLWSD::doHousekeeping();
|
|
|
|
// Remove all tiles related to this document from the cache if configured so.
|
|
if (_tileCache && !LOOLWSD::TileCachePersistent)
|
|
_tileCache->completeCleanup();
|
|
|
|
LOG_INF("Finished docBroker polling thread for docKey [" << _docKey << "].");
|
|
}
|
|
|
|
bool DocumentBroker::isAlive() const
|
|
{
|
|
if (!_stop || _poll->isAlive())
|
|
return true; // Polling thread not started or still running.
|
|
|
|
// Shouldn't have live child process outside of the polling thread.
|
|
return _childProcess && _childProcess->isAlive();
|
|
}
|
|
|
|
DocumentBroker::~DocumentBroker()
|
|
{
|
|
assertCorrectThread();
|
|
|
|
Admin::instance().rmDoc(_docKey);
|
|
|
|
LOG_INF("~DocumentBroker [" << _docKey <<
|
|
"] destroyed with " << _sessions.size() << " sessions left.");
|
|
|
|
// Do this early - to avoid operating on _childProcess from two threads.
|
|
_poll->joinThread();
|
|
|
|
if (!_sessions.empty())
|
|
{
|
|
LOG_WRN("DocumentBroker [" << _docKey << "] still has unremoved sessions.");
|
|
}
|
|
|
|
// Need to first make sure the child exited, socket closed,
|
|
// and thread finished before we are destroyed.
|
|
_childProcess.reset();
|
|
}
|
|
|
|
void DocumentBroker::joinThread()
|
|
{
|
|
_poll->joinThread();
|
|
}
|
|
|
|
void DocumentBroker::stop(const std::string& reason)
|
|
{
|
|
LOG_DBG("Closing DocumentBroker for docKey [" << _docKey << "] with reason: " << reason);
|
|
_closeReason = reason; // used later in the polling loop
|
|
_stop = true;
|
|
_poll->wakeup();
|
|
}
|
|
|
|
bool DocumentBroker::load(const std::shared_ptr<ClientSession>& session, const std::string& jailId)
|
|
{
|
|
assertCorrectThread();
|
|
|
|
const std::string sessionId = session->getId();
|
|
|
|
LOG_INF("Loading [" << _docKey << "] for session [" << sessionId << "] and jail [" << jailId << "].");
|
|
|
|
{
|
|
bool result;
|
|
if (UnitWSD::get().filterLoad(sessionId, jailId, result))
|
|
return result;
|
|
}
|
|
|
|
if (_markToDestroy)
|
|
{
|
|
// Tearing down.
|
|
LOG_WRN("Will not load document marked to destroy. DocKey: [" << _docKey << "].");
|
|
return false;
|
|
}
|
|
|
|
_jailId = jailId;
|
|
|
|
// The URL is the publicly visible one, not visible in the chroot jail.
|
|
// We need to map it to a jailed path and copy the file there.
|
|
|
|
// user/doc/jailId
|
|
const Poco::Path jailPath(JAILED_DOCUMENT_ROOT, jailId);
|
|
std::string jailRoot = getJailRoot();
|
|
|
|
LOG_INF("jailPath: " << jailPath.toString() << ", jailRoot: " << jailRoot);
|
|
|
|
bool firstInstance = false;
|
|
if (_storage == nullptr)
|
|
{
|
|
// Pass the public URI to storage as it needs to load using the token
|
|
// and other storage-specific data provided in the URI.
|
|
const Poco::URI& uriPublic = session->getPublicUri();
|
|
LOG_DBG("Loading, and creating new storage instance for URI [" << uriPublic.toString() << "].");
|
|
|
|
_storage = StorageBase::create(uriPublic, jailRoot, jailPath.toString());
|
|
if (_storage == nullptr)
|
|
{
|
|
// We should get an exception, not null.
|
|
LOG_ERR("Failed to create Storage instance for [" << _docKey << "] in " << jailPath.toString());
|
|
return false;
|
|
}
|
|
firstInstance = true;
|
|
}
|
|
|
|
assert(_storage != nullptr);
|
|
|
|
// Call the storage specific fileinfo functions
|
|
std::string userid, username;
|
|
std::string userExtraInfo;
|
|
std::string watermarkText;
|
|
std::chrono::duration<double> getInfoCallDuration(0);
|
|
WopiStorage* wopiStorage = dynamic_cast<WopiStorage*>(_storage.get());
|
|
if (wopiStorage != nullptr)
|
|
{
|
|
std::unique_ptr<WopiStorage::WOPIFileInfo> wopifileinfo = wopiStorage->getWOPIFileInfo(session->getAuthorization());
|
|
userid = wopifileinfo->_userid;
|
|
username = wopifileinfo->_username;
|
|
userExtraInfo = wopifileinfo->_userExtraInfo;
|
|
watermarkText = wopifileinfo->_watermarkText;
|
|
|
|
if (!wopifileinfo->_userCanWrite ||
|
|
LOOLWSD::IsViewFileExtension(wopiStorage->getFileExtension()))
|
|
{
|
|
LOG_DBG("Setting the session as readonly");
|
|
session->setReadOnly();
|
|
}
|
|
|
|
// Construct a JSON containing relevant WOPI host properties
|
|
Object::Ptr wopiInfo = new Object();
|
|
if (!wopifileinfo->_postMessageOrigin.empty())
|
|
{
|
|
// Update the scheme to https if ssl or ssl termination is on
|
|
if (wopifileinfo->_postMessageOrigin.substr(0, 7) == "http://" &&
|
|
(LOOLWSD::isSSLEnabled() || LOOLWSD::isSSLTermination()))
|
|
{
|
|
wopifileinfo->_postMessageOrigin.replace(0, 4, "https");
|
|
LOG_DBG("Updating PostMessageOrgin scheme to HTTPS. Updated origin is [" << wopifileinfo->_postMessageOrigin << "].");
|
|
}
|
|
|
|
wopiInfo->set("PostMessageOrigin", wopifileinfo->_postMessageOrigin);
|
|
}
|
|
|
|
// If print, export are disabled, order client to hide these options in the UI
|
|
if (wopifileinfo->_disablePrint)
|
|
wopifileinfo->_hidePrintOption = true;
|
|
if (wopifileinfo->_disableExport)
|
|
wopifileinfo->_hideExportOption = true;
|
|
|
|
wopiInfo->set("BaseFileName", wopiStorage->getFileInfo()._filename);
|
|
wopiInfo->set("HidePrintOption", wopifileinfo->_hidePrintOption);
|
|
wopiInfo->set("HideSaveOption", wopifileinfo->_hideSaveOption);
|
|
wopiInfo->set("HideExportOption", wopifileinfo->_hideExportOption);
|
|
wopiInfo->set("DisablePrint", wopifileinfo->_disablePrint);
|
|
wopiInfo->set("DisableExport", wopifileinfo->_disableExport);
|
|
wopiInfo->set("DisableCopy", wopifileinfo->_disableCopy);
|
|
wopiInfo->set("DisableInactiveMessages", wopifileinfo->_disableInactiveMessages);
|
|
wopiInfo->set("UserCanNotWriteRelative", wopifileinfo->_userCanNotWriteRelative);
|
|
if (wopifileinfo->_hideChangeTrackingControls != WopiStorage::WOPIFileInfo::TriState::Unset)
|
|
wopiInfo->set("HideChangeTrackingControls", wopifileinfo->_hideChangeTrackingControls == WopiStorage::WOPIFileInfo::TriState::True);
|
|
|
|
std::ostringstream ossWopiInfo;
|
|
wopiInfo->stringify(ossWopiInfo);
|
|
// Contains PostMessageOrigin property which is necessary to post messages to parent
|
|
// frame. Important to send this message immediately and not enqueue it so that in case
|
|
// document load fails, loleaflet is able to tell its parent frame via PostMessage API.
|
|
session->sendMessage("wopi: " + ossWopiInfo.str());
|
|
|
|
// Mark the session as 'Document owner' if WOPI hosts supports it
|
|
if (userid == _storage->getFileInfo()._ownerId)
|
|
{
|
|
LOG_DBG("Session [" << sessionId << "] is the document owner");
|
|
session->setDocumentOwner(true);
|
|
}
|
|
|
|
getInfoCallDuration = wopifileinfo->_callDuration;
|
|
|
|
// Pass the ownership to client session
|
|
session->setWopiFileInfo(wopifileinfo);
|
|
}
|
|
else
|
|
{
|
|
LocalStorage* localStorage = dynamic_cast<LocalStorage*>(_storage.get());
|
|
if (localStorage != nullptr)
|
|
{
|
|
std::unique_ptr<LocalStorage::LocalFileInfo> localfileinfo = localStorage->getLocalFileInfo();
|
|
userid = localfileinfo->_userid;
|
|
username = localfileinfo->_username;
|
|
|
|
if (LOOLWSD::IsViewFileExtension(localStorage->getFileExtension()))
|
|
{
|
|
LOG_DBG("Setting the session as readonly");
|
|
session->setReadOnly();
|
|
}
|
|
}
|
|
}
|
|
|
|
#if ENABLE_SUPPORT_KEY
|
|
if (!LOOLWSD::OverrideWatermark.empty())
|
|
watermarkText = LOOLWSD::OverrideWatermark;
|
|
#endif
|
|
|
|
LOG_DBG("Setting username [" << username << "] and userId [" <<
|
|
userid << "] for session [" << sessionId << "]");
|
|
session->setUserId(userid);
|
|
session->setUserName(username);
|
|
session->setUserExtraInfo(userExtraInfo);
|
|
session->setWatermarkText(watermarkText);
|
|
|
|
// Basic file information was stored by the above getWOPIFileInfo() or getLocalFileInfo() calls
|
|
const StorageBase::FileInfo fileInfo = _storage->getFileInfo();
|
|
if (!fileInfo.isValid())
|
|
{
|
|
LOG_ERR("Invalid fileinfo for URI [" << session->getPublicUri().toString() << "].");
|
|
return false;
|
|
}
|
|
|
|
if (firstInstance)
|
|
{
|
|
_documentLastModifiedTime = fileInfo._modifiedTime;
|
|
LOG_DBG("Document timestamp: " << _documentLastModifiedTime);
|
|
}
|
|
else
|
|
{
|
|
// Check if document has been modified by some external action
|
|
LOG_TRC("Document modified time: " << fileInfo._modifiedTime);
|
|
static const Poco::Timestamp Zero(Poco::Timestamp::fromEpochTime(0));
|
|
if (_documentLastModifiedTime != Zero &&
|
|
fileInfo._modifiedTime != Zero &&
|
|
_documentLastModifiedTime != fileInfo._modifiedTime)
|
|
{
|
|
LOG_TRC("Document " << _docKey << "] has been modified behind our back. " <<
|
|
"Informing all clients. Expected: " << _documentLastModifiedTime <<
|
|
", Actual: " << fileInfo._modifiedTime);
|
|
|
|
_documentChangedInStorage = true;
|
|
std::string message = "close: documentconflict";
|
|
if (_isModified)
|
|
message = "error: cmd=storage kind=documentconflict";
|
|
|
|
session->sendTextFrame(message);
|
|
broadcastMessage(message);
|
|
}
|
|
}
|
|
|
|
// Let's load the document now, if not loaded.
|
|
if (!_storage->isLoaded())
|
|
{
|
|
std::string localPath = _storage->loadStorageFileToLocal(session->getAuthorization());
|
|
|
|
// Check if we have a prefilter "plugin" for this document format
|
|
for (const auto& plugin : LOOLWSD::PluginConfigurations)
|
|
{
|
|
try
|
|
{
|
|
const std::string extension(plugin->getString("prefilter.extension"));
|
|
const std::string newExtension(plugin->getString("prefilter.newextension"));
|
|
const std::string commandLine(plugin->getString("prefilter.commandline"));
|
|
|
|
if (localPath.length() > extension.length()+1 &&
|
|
strcasecmp(localPath.substr(localPath.length() - extension.length() -1).data(), (std::string(".") + extension).data()) == 0)
|
|
{
|
|
// Extension matches, try the conversion. We convert the file to another one in
|
|
// the same (jail) directory, with just the new extension tacked on.
|
|
|
|
const std::string newRootPath = _storage->getRootFilePath() + "." + newExtension;
|
|
|
|
// The commandline must contain the space-separated substring @INPUT@ that is
|
|
// replaced with the input file name, and @OUTPUT@ for the output file name.
|
|
Poco::StringTokenizer tokenizer(commandLine, " ");
|
|
if (tokenizer.replace("@INPUT@", _storage->getRootFilePath()) != 1 ||
|
|
tokenizer.replace("@OUTPUT@", newRootPath) != 1)
|
|
throw Poco::NotFoundException();
|
|
|
|
|
|
std::vector<std::string> args;
|
|
for (std::size_t i = 1; i < tokenizer.count(); ++i)
|
|
args.emplace_back(tokenizer[i]);
|
|
|
|
int process = Util::spawnProcess(tokenizer[0], args);
|
|
int status = -1;
|
|
const int rc = ::waitpid(process, &status, 0);
|
|
if (rc != 0)
|
|
{
|
|
LOG_ERR("Conversion from " << extension << " to " << newExtension << " failed (" << rc << ").");
|
|
return false;
|
|
}
|
|
|
|
_storage->setRootFilePath(newRootPath);
|
|
localPath += "." + newExtension;
|
|
}
|
|
|
|
// We successfully converted the file to something LO can use; break out of the for
|
|
// loop.
|
|
break;
|
|
}
|
|
catch (const Poco::NotFoundException&)
|
|
{
|
|
// This plugin is not a proper prefilter one
|
|
}
|
|
}
|
|
|
|
std::ifstream istr(localPath, std::ios::binary);
|
|
Poco::SHA1Engine sha1;
|
|
Poco::DigestOutputStream dos(sha1);
|
|
Poco::StreamCopier::copyStream(istr, dos);
|
|
dos.close();
|
|
LOG_INF("SHA1 for DocKey [" << _docKey << "] of [" << localPath << "]: " <<
|
|
Poco::DigestEngine::digestToHex(sha1.digest()));
|
|
|
|
// LibreOffice can't open files with '#' in the name
|
|
std::string localPathEncoded;
|
|
Poco::URI::encode(localPath,"#",localPathEncoded);
|
|
_uriJailed = Poco::URI(Poco::URI("file://"), localPathEncoded);
|
|
|
|
_filename = fileInfo._filename;
|
|
|
|
// Use the local temp file's timestamp.
|
|
_lastFileModifiedTime = Poco::File(_storage->getRootFilePath()).getLastModified();
|
|
_tileCache.reset(new TileCache(_storage->getUri(), _lastFileModifiedTime, _cacheRoot));
|
|
_tileCache->setThreadOwner(std::this_thread::get_id());
|
|
}
|
|
|
|
LOOLWSD::dumpNewSessionTrace(getJailId(), sessionId, _uriOrig, _storage->getRootFilePath());
|
|
|
|
// Since document has been loaded, send the stats if its WOPI
|
|
if (wopiStorage != nullptr)
|
|
{
|
|
// Get the time taken to load the file from storage
|
|
auto callDuration = wopiStorage->getWopiLoadDuration();
|
|
// Add the time taken to check file info
|
|
callDuration += getInfoCallDuration;
|
|
const std::string msg = "stats: wopiloadduration " + std::to_string(callDuration.count());
|
|
LOG_TRC("Sending to Client [" << msg << "].");
|
|
session->sendTextFrame(msg);
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
bool DocumentBroker::saveToStorage(const std::string& sessionId,
|
|
bool success, const std::string& result, bool force)
|
|
{
|
|
assertCorrectThread();
|
|
|
|
if (force)
|
|
{
|
|
LOG_TRC("Document will be saved forcefully to storage.");
|
|
_storage->forceSave();
|
|
}
|
|
|
|
const bool res = saveToStorageInternal(sessionId, success, result);
|
|
|
|
// If marked to destroy, or session is disconnected, remove.
|
|
const auto it = _sessions.find(sessionId);
|
|
if (_markToDestroy || (it != _sessions.end() && it->second->isCloseFrame()))
|
|
removeSessionInternal(sessionId);
|
|
|
|
// If marked to destroy, then this was the last session.
|
|
if (_markToDestroy || _sessions.empty())
|
|
{
|
|
// Stop so we get cleaned up and removed.
|
|
_stop = true;
|
|
}
|
|
|
|
return res;
|
|
}
|
|
|
|
bool DocumentBroker::saveAsToStorage(const std::string& sessionId, const std::string& saveAsPath, const std::string& saveAsFilename)
|
|
{
|
|
assertCorrectThread();
|
|
|
|
return saveToStorageInternal(sessionId, true, "", saveAsPath, saveAsFilename);
|
|
}
|
|
|
|
bool DocumentBroker::saveToStorageInternal(const std::string& sessionId,
|
|
bool success, const std::string& result,
|
|
const std::string& saveAsPath, const std::string& saveAsFilename)
|
|
{
|
|
assertCorrectThread();
|
|
|
|
// Record that we got a response to avoid timeing out on saving.
|
|
_lastSaveResponseTime = std::chrono::steady_clock::now();
|
|
|
|
const bool isSaveAs = !saveAsPath.empty();
|
|
|
|
// If save requested, but core didn't save because document was unmodified
|
|
// notify the waiting thread, if any.
|
|
LOG_TRC("Saving to storage docKey [" << _docKey << "] for session [" << sessionId <<
|
|
"]. Success: " << success << ", result: " << result);
|
|
if (!success && result == "unmodified")
|
|
{
|
|
LOG_DBG("Save skipped as document [" << _docKey << "] was not modified.");
|
|
_lastSaveTime = std::chrono::steady_clock::now();
|
|
_poll->wakeup();
|
|
return true;
|
|
}
|
|
|
|
const auto it = _sessions.find(sessionId);
|
|
if (it == _sessions.end())
|
|
{
|
|
LOG_ERR("Session with sessionId [" << sessionId << "] not found while saving docKey [" << _docKey << "].");
|
|
return false;
|
|
}
|
|
|
|
// Check that we are actually about to upload a successfully saved document.
|
|
if (!success)
|
|
{
|
|
LOG_ERR("Cannot save docKey [" << _docKey << "], the .uno:Save has failed in LOK.");
|
|
it->second->sendTextFrame("error: cmd=storage kind=savefailed");
|
|
return false;
|
|
}
|
|
|
|
const Authorization auth = it->second->getAuthorization();
|
|
const std::string uri = isSaveAs? saveAsPath: it->second->getPublicUri().toString();
|
|
|
|
// If the file timestamp hasn't changed, skip saving.
|
|
const Poco::Timestamp newFileModifiedTime = Poco::File(_storage->getRootFilePath()).getLastModified();
|
|
if (!isSaveAs && newFileModifiedTime == _lastFileModifiedTime)
|
|
{
|
|
// Nothing to do.
|
|
LOG_DBG("Skipping unnecessary saving to URI [" << uri << "] with docKey [" << _docKey <<
|
|
"]. File last modified " << _lastFileModifiedTime.elapsed() / 1000000 << " seconds ago.");
|
|
_poll->wakeup();
|
|
return true;
|
|
}
|
|
|
|
LOG_DBG("Persisting [" << _docKey << "] after saving to URI [" << uri << "].");
|
|
|
|
assert(_storage && _tileCache);
|
|
StorageBase::SaveResult storageSaveResult = _storage->saveLocalFileToStorage(auth, saveAsPath, saveAsFilename);
|
|
if (storageSaveResult.getResult() == StorageBase::SaveResult::OK)
|
|
{
|
|
if (!isSaveAs)
|
|
{
|
|
// Saved and stored; update flags.
|
|
setModified(false);
|
|
_lastFileModifiedTime = newFileModifiedTime;
|
|
_tileCache->saveLastModified(_lastFileModifiedTime);
|
|
_lastSaveTime = std::chrono::steady_clock::now();
|
|
|
|
// Save the storage timestamp.
|
|
_documentLastModifiedTime = _storage->getFileInfo()._modifiedTime;
|
|
|
|
// After a successful save, we are sure that document in the storage is same as ours
|
|
_documentChangedInStorage = false;
|
|
|
|
LOG_DBG("Saved docKey [" << _docKey << "] to URI [" << uri << "] and updated timestamps. " <<
|
|
" Document modified timestamp: " << _documentLastModifiedTime);
|
|
|
|
// Resume polling.
|
|
_poll->wakeup();
|
|
}
|
|
else
|
|
{
|
|
// normalize the url (mainly to " " -> "%20")
|
|
std::string url = Poco::URI(storageSaveResult.getSaveAsUrl()).toString();
|
|
|
|
// encode the name
|
|
std::string encodedName;
|
|
Poco::URI::encode(storageSaveResult.getSaveAsName(), "", encodedName);
|
|
|
|
it->second->sendTextFrame("saveas: url=" + url + " filename=" + encodedName);
|
|
|
|
LOG_DBG("Saved As docKey [" << _docKey << "] to URI [" << url <<
|
|
" with name '" << encodedName << "'] successfully.");
|
|
}
|
|
return true;
|
|
}
|
|
else if (storageSaveResult.getResult() == StorageBase::SaveResult::DISKFULL)
|
|
{
|
|
LOG_WRN("Disk full while saving docKey [" << _docKey << "] to URI [" << uri <<
|
|
"]. Making all sessions on doc read-only and notifying clients.");
|
|
|
|
// Make everyone readonly and tell everyone that storage is low on diskspace.
|
|
for (const auto& sessionIt : _sessions)
|
|
{
|
|
sessionIt.second->setReadOnly();
|
|
sessionIt.second->sendTextFrame("error: cmd=storage kind=savediskfull");
|
|
}
|
|
}
|
|
else if (storageSaveResult.getResult() == StorageBase::SaveResult::UNAUTHORIZED)
|
|
{
|
|
LOG_ERR("Cannot save docKey [" << _docKey << "] to storage URI [" << uri << "]. Invalid or expired access token. Notifying client.");
|
|
it->second->sendTextFrame("error: cmd=storage kind=saveunauthorized");
|
|
}
|
|
else if (storageSaveResult.getResult() == StorageBase::SaveResult::FAILED)
|
|
{
|
|
//TODO: Should we notify all clients?
|
|
LOG_ERR("Failed to save docKey [" << _docKey << "] to URI [" << uri << "]. Notifying client.");
|
|
it->second->sendTextFrame("error: cmd=storage kind=savefailed");
|
|
}
|
|
else if (storageSaveResult.getResult() == StorageBase::SaveResult::DOC_CHANGED)
|
|
{
|
|
LOG_ERR("PutFile says that Document changed in storage");
|
|
_documentChangedInStorage = true;
|
|
std::string message = "close: documentconflict";
|
|
if (_isModified)
|
|
message = "error: cmd=storage kind=documentconflict";
|
|
|
|
broadcastMessage(message);
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
void DocumentBroker::setLoaded()
|
|
{
|
|
if (!_isLoaded)
|
|
{
|
|
_isLoaded = true;
|
|
_loadDuration = std::chrono::duration_cast<std::chrono::milliseconds>(
|
|
std::chrono::steady_clock::now() - _threadStart);
|
|
LOG_TRC("Document loaded in " << _loadDuration.count() << "ms");
|
|
}
|
|
}
|
|
|
|
bool DocumentBroker::autoSave(const bool force)
|
|
{
|
|
assertCorrectThread();
|
|
|
|
LOG_TRC("autoSave(): forceful? " << force);
|
|
if (_sessions.empty() || _storage == nullptr || !_isLoaded ||
|
|
!_childProcess->isAlive() || (!_isModified && !force))
|
|
{
|
|
// Nothing to do.
|
|
LOG_TRC("Nothing to autosave [" << _docKey << "].");
|
|
return false;
|
|
}
|
|
|
|
// Remember the last save time, since this is the predicate.
|
|
LOG_TRC("Checking to autosave [" << _docKey << "].");
|
|
|
|
// Which session to use when auto saving ?
|
|
std::string savingSessionId;
|
|
for (auto& sessionIt : _sessions)
|
|
{
|
|
// Save the document using an editable session, or first ...
|
|
if (savingSessionId.empty() || !sessionIt.second->isReadOnly())
|
|
{
|
|
savingSessionId = sessionIt.second->getId();
|
|
}
|
|
|
|
// or if any of the sessions is document owner, use that.
|
|
if (sessionIt.second->isDocumentOwner())
|
|
{
|
|
savingSessionId = sessionIt.second->getId();
|
|
break;
|
|
}
|
|
}
|
|
|
|
bool sent = false;
|
|
if (force)
|
|
{
|
|
LOG_TRC("Sending forced save command for [" << _docKey << "].");
|
|
// Don't terminate editing as this can be invoked by the admin OOM, but otherwise force saving anyway.
|
|
sent = sendUnoSave(savingSessionId, /*dontTerminateEdit=*/ true, /*dontSaveIfUnmodified=*/ true, /*isAutosave=*/ false);
|
|
}
|
|
else if (_isModified)
|
|
{
|
|
const std::chrono::steady_clock::time_point now = std::chrono::steady_clock::now();
|
|
const std::chrono::milliseconds::rep inactivityTimeMs = std::chrono::duration_cast<std::chrono::milliseconds>(now - _lastActivityTime).count();
|
|
const std::chrono::milliseconds::rep timeSinceLastSaveMs = std::chrono::duration_cast<std::chrono::milliseconds>(now - _lastSaveTime).count();
|
|
LOG_TRC("Time since last save of docKey [" << _docKey << "] is " << timeSinceLastSaveMs <<
|
|
"ms and most recent activity was " << inactivityTimeMs << "ms ago.");
|
|
|
|
static const int idleSaveDurationMs = LOOLWSD::getConfigValue<int>("per_document.idlesave_duration_secs", 30) * 1000;
|
|
static const int autoSaveDurationMs = LOOLWSD::getConfigValue<int>("per_document.autosave_duration_secs", 300) * 1000;
|
|
// Either we've been idle long enough, or it's auto-save time.
|
|
if (inactivityTimeMs >= idleSaveDurationMs ||
|
|
timeSinceLastSaveMs >= autoSaveDurationMs)
|
|
{
|
|
LOG_TRC("Sending timed save command for [" << _docKey << "].");
|
|
sent = sendUnoSave(savingSessionId, /*dontTerminateEdit=*/ true, /*dontSaveIfUnmodified=*/ true, /*isAutosave=*/ true);
|
|
}
|
|
}
|
|
|
|
return sent;
|
|
}
|
|
|
|
bool DocumentBroker::sendUnoSave(const std::string& sessionId, bool dontTerminateEdit, bool dontSaveIfUnmodified, bool isAutosave)
|
|
{
|
|
assertCorrectThread();
|
|
|
|
LOG_INF("Saving doc [" << _docKey << "].");
|
|
|
|
if (_sessions.find(sessionId) != _sessions.end())
|
|
{
|
|
// Invalidate the timestamp to force persisting.
|
|
_lastFileModifiedTime = Poco::Timestamp::fromEpochTime(0);
|
|
|
|
// We do not want save to terminate editing mode if we are in edit mode now
|
|
|
|
std::ostringstream oss;
|
|
// arguments init
|
|
oss << "{";
|
|
|
|
if (dontTerminateEdit)
|
|
{
|
|
oss << "\"DontTerminateEdit\":"
|
|
<< "{"
|
|
<< "\"type\":\"boolean\","
|
|
<< "\"value\":true"
|
|
<< "}";
|
|
}
|
|
|
|
if (dontSaveIfUnmodified)
|
|
{
|
|
if (dontTerminateEdit)
|
|
oss << ",";
|
|
|
|
oss << "\"DontSaveIfUnmodified\":"
|
|
<< "{"
|
|
<< "\"type\":\"boolean\","
|
|
<< "\"value\":true"
|
|
<< "}";
|
|
}
|
|
|
|
// arguments end
|
|
oss << "}";
|
|
|
|
assert(_storage);
|
|
_storage->setIsAutosave(isAutosave || UnitWSD::get().isAutosave());
|
|
|
|
const std::string saveArgs = oss.str();
|
|
LOG_TRC(".uno:Save arguments: " << saveArgs);
|
|
const auto command = "uno .uno:Save " + saveArgs;
|
|
forwardToChild(sessionId, command);
|
|
_lastSaveRequestTime = std::chrono::steady_clock::now();
|
|
return true;
|
|
}
|
|
|
|
LOG_ERR("Failed to save doc [" << _docKey << "]: No valid sessions.");
|
|
return false;
|
|
}
|
|
|
|
std::string DocumentBroker::getJailRoot() const
|
|
{
|
|
assert(!_jailId.empty());
|
|
return Poco::Path(_childRoot, _jailId).toString();
|
|
}
|
|
|
|
size_t DocumentBroker::addSession(const std::shared_ptr<ClientSession>& session)
|
|
{
|
|
try
|
|
{
|
|
return addSessionInternal(session);
|
|
}
|
|
catch (const std::exception& exc)
|
|
{
|
|
LOG_ERR("Failed to add session to [" << _docKey << "] with URI [" << session->getPublicUri().toString() << "]: " << exc.what());
|
|
if (_sessions.empty())
|
|
{
|
|
LOG_INF("Doc [" << _docKey << "] has no more sessions. Marking to destroy.");
|
|
_markToDestroy = true;
|
|
}
|
|
|
|
throw;
|
|
}
|
|
}
|
|
|
|
size_t DocumentBroker::addSessionInternal(const std::shared_ptr<ClientSession>& session)
|
|
{
|
|
assertCorrectThread();
|
|
|
|
try
|
|
{
|
|
// First load the document, since this can fail.
|
|
if (!load(session, _childProcess->getJailId()))
|
|
{
|
|
const auto msg = "Failed to load document with URI [" + session->getPublicUri().toString() + "].";
|
|
LOG_ERR(msg);
|
|
throw std::runtime_error(msg);
|
|
}
|
|
}
|
|
catch (const StorageSpaceLowException&)
|
|
{
|
|
LOG_ERR("Out of storage while loading document with URI [" << session->getPublicUri().toString() << "].");
|
|
|
|
// We use the same message as is sent when some of lool's own locations are full,
|
|
// even if in this case it might be a totally different location (file system, or
|
|
// some other type of storage somewhere). This message is not sent to all clients,
|
|
// though, just to all sessions of this document.
|
|
alertAllUsers("internal", "diskfull");
|
|
throw;
|
|
}
|
|
|
|
const std::string id = session->getId();
|
|
|
|
// Request a new session from the child kit.
|
|
const std::string aMessage = "session " + id + ' ' + _docKey + ' ' + _docId;
|
|
_childProcess->sendTextFrame(aMessage);
|
|
|
|
// Tell the admin console about this new doc
|
|
Admin::instance().addDoc(_docKey, getPid(), getFilename(), id, session->getUserName(), session->getUserId());
|
|
|
|
// Add and attach the session.
|
|
_sessions.emplace(session->getId(), session);
|
|
session->setAttached();
|
|
|
|
const size_t count = _sessions.size();
|
|
LOG_TRC("Added " << (session->isReadOnly() ? "readonly" : "non-readonly") <<
|
|
" session [" << id << "] to docKey [" <<
|
|
_docKey << "] to have " << count << " sessions.");
|
|
|
|
return count;
|
|
}
|
|
|
|
size_t DocumentBroker::removeSession(const std::string& id)
|
|
{
|
|
assertCorrectThread();
|
|
|
|
try
|
|
{
|
|
const auto it = _sessions.find(id);
|
|
if (it == _sessions.end())
|
|
{
|
|
LOG_ERR("Invalid or unknown session [" << id << "] to remove.");
|
|
return _sessions.size();
|
|
}
|
|
|
|
// Last view going away, can destroy.
|
|
_markToDestroy = (_sessions.size() <= 1);
|
|
|
|
const bool lastEditableSession = !it->second->isReadOnly() && !haveAnotherEditableSession(id);
|
|
|
|
LOG_INF("Removing session [" << id << "] on docKey [" << _docKey <<
|
|
"]. Have " << _sessions.size() << " sessions. markToDestroy: " << _markToDestroy <<
|
|
", LastEditableSession: " << lastEditableSession);
|
|
|
|
// If last editable, save and don't remove until after uploading to storage.
|
|
if (!lastEditableSession || !autoSave(isPossiblyModified()))
|
|
removeSessionInternal(id);
|
|
}
|
|
catch (const std::exception& ex)
|
|
{
|
|
LOG_ERR("Error while removing session [" << id << "]: " << ex.what());
|
|
}
|
|
|
|
return _sessions.size();
|
|
}
|
|
|
|
size_t DocumentBroker::removeSessionInternal(const std::string& id)
|
|
{
|
|
assertCorrectThread();
|
|
try
|
|
{
|
|
Admin::instance().rmDoc(_docKey, id);
|
|
|
|
auto it = _sessions.find(id);
|
|
if (it != _sessions.end())
|
|
{
|
|
LOOLWSD::dumpEndSessionTrace(getJailId(), id, _uriOrig);
|
|
|
|
const bool readonly = (it->second ? it->second->isReadOnly() : false);
|
|
|
|
// Remove. The caller must have a reference to the session
|
|
// in question, lest we destroy from underneith them.
|
|
_sessions.erase(it);
|
|
const size_t count = _sessions.size();
|
|
|
|
Log::StreamLogger logger = Log::trace();
|
|
if (logger.enabled())
|
|
{
|
|
logger << "Removed " << (readonly ? "readonly" : "non-readonly")
|
|
<< " session [" << id << "] from docKey ["
|
|
<< _docKey << "] to have " << count << " sessions:";
|
|
for (const auto& pair : _sessions)
|
|
logger << pair.second->getId() << ' ';
|
|
|
|
LOG_END(logger);
|
|
}
|
|
|
|
// Let the child know the client has disconnected.
|
|
const std::string msg("child-" + id + " disconnect");
|
|
_childProcess->sendTextFrame(msg);
|
|
|
|
return count;
|
|
}
|
|
else
|
|
{
|
|
LOG_TRC("Session [" << id << "] not found to remove from docKey [" <<
|
|
_docKey << "]. Have " << _sessions.size() << " sessions.");
|
|
}
|
|
}
|
|
catch (const std::exception& ex)
|
|
{
|
|
LOG_ERR("Error while removing session [" << id << "]: " << ex.what());
|
|
}
|
|
|
|
return _sessions.size();
|
|
}
|
|
|
|
void DocumentBroker::addCallback(const SocketPoll::CallbackFn& fn)
|
|
{
|
|
_poll->addCallback(fn);
|
|
}
|
|
|
|
void DocumentBroker::addSocketToPoll(const std::shared_ptr<Socket>& socket)
|
|
{
|
|
_poll->insertNewSocket(socket);
|
|
}
|
|
|
|
void DocumentBroker::alertAllUsers(const std::string& msg)
|
|
{
|
|
assertCorrectThread();
|
|
|
|
if (UnitWSD::get().filterAlertAllusers(msg))
|
|
return;
|
|
|
|
auto payload = std::make_shared<Message>(msg, Message::Dir::Out);
|
|
|
|
LOG_DBG("Alerting all users of [" << _docKey << "]: " << msg);
|
|
for (auto& it : _sessions)
|
|
{
|
|
it.second->enqueueSendMessage(payload);
|
|
}
|
|
}
|
|
|
|
/// Handles input from the prisoner / child kit process
|
|
bool DocumentBroker::handleInput(const std::vector<char>& payload)
|
|
{
|
|
auto message = std::make_shared<Message>(payload.data(), payload.size(), Message::Dir::Out);
|
|
const auto& msg = message->abbr();
|
|
LOG_TRC("DocumentBroker handling child message: [" << msg << "].");
|
|
|
|
LOOLWSD::dumpOutgoingTrace(getJailId(), "0", msg);
|
|
|
|
if (LOOLProtocol::getFirstToken(message->forwardToken(), '-') == "client")
|
|
{
|
|
forwardToClient(message);
|
|
}
|
|
else
|
|
{
|
|
const auto& command = message->firstToken();
|
|
if (command == "tile:")
|
|
{
|
|
handleTileResponse(payload);
|
|
}
|
|
else if (command == "tilecombine:")
|
|
{
|
|
handleTileCombinedResponse(payload);
|
|
}
|
|
else if (command == "errortoall:")
|
|
{
|
|
LOG_CHECK_RET(message->tokens().size() == 3, false);
|
|
std::string cmd, kind;
|
|
LOOLProtocol::getTokenString((*message)[1], "cmd", cmd);
|
|
LOG_CHECK_RET(cmd != "", false);
|
|
LOOLProtocol::getTokenString((*message)[2], "kind", kind);
|
|
LOG_CHECK_RET(kind != "", false);
|
|
Util::alertAllUsers(cmd, kind);
|
|
}
|
|
else if (command == "procmemstats:")
|
|
{
|
|
int dirty;
|
|
if (message->getTokenInteger("dirty", dirty))
|
|
{
|
|
Admin::instance().updateMemoryDirty(_docKey, dirty);
|
|
}
|
|
}
|
|
else
|
|
{
|
|
LOG_ERR("Unexpected message: [" << msg << "].");
|
|
return false;
|
|
}
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
void DocumentBroker::invalidateTiles(const std::string& tiles)
|
|
{
|
|
// Remove from cache.
|
|
_tileCache->invalidateTiles(tiles);
|
|
}
|
|
|
|
void DocumentBroker::handleTileRequest(TileDesc& tile,
|
|
const std::shared_ptr<ClientSession>& session)
|
|
{
|
|
assertCorrectThread();
|
|
std::unique_lock<std::mutex> lock(_mutex);
|
|
|
|
tile.setVersion(++_tileVersion);
|
|
const std::string tileMsg = tile.serialize();
|
|
LOG_TRC("Tile request for " << tileMsg);
|
|
|
|
std::unique_ptr<std::fstream> cachedTile = _tileCache->lookupTile(tile);
|
|
if (cachedTile)
|
|
{
|
|
#if ENABLE_DEBUG
|
|
const std::string response = tile.serialize("tile:") + " renderid=cached\n";
|
|
#else
|
|
const std::string response = tile.serialize("tile:") + '\n';
|
|
#endif
|
|
|
|
std::vector<char> output;
|
|
output.reserve(static_cast<size_t>(4) * tile.getWidth() * tile.getHeight());
|
|
output.resize(response.size());
|
|
std::memcpy(output.data(), response.data(), response.size());
|
|
|
|
assert(cachedTile->is_open());
|
|
cachedTile->seekg(0, std::ios_base::end);
|
|
const size_t pos = output.size();
|
|
std::streamsize size = cachedTile->tellg();
|
|
output.resize(pos + size);
|
|
cachedTile->seekg(0, std::ios_base::beg);
|
|
cachedTile->read(output.data() + pos, size);
|
|
cachedTile->close();
|
|
|
|
session->sendBinaryFrame(output.data(), output.size());
|
|
return;
|
|
}
|
|
|
|
if (tile.getBroadcast())
|
|
{
|
|
for (auto& it: _sessions)
|
|
{
|
|
tileCache().subscribeToTileRendering(tile, it.second);
|
|
}
|
|
}
|
|
else
|
|
{
|
|
tileCache().subscribeToTileRendering(tile, session);
|
|
}
|
|
|
|
// Forward to child to render.
|
|
LOG_DBG("Sending render request for tile (" << tile.getPart() << ',' <<
|
|
tile.getTilePosX() << ',' << tile.getTilePosY() << ").");
|
|
const std::string request = "tile " + tileMsg;
|
|
_childProcess->sendTextFrame(request);
|
|
_debugRenderedTileCount++;
|
|
}
|
|
|
|
void DocumentBroker::handleTileCombinedRequest(TileCombined& tileCombined,
|
|
const std::shared_ptr<ClientSession>& session)
|
|
{
|
|
std::unique_lock<std::mutex> lock(_mutex);
|
|
|
|
LOG_TRC("TileCombined request for " << tileCombined.serialize());
|
|
|
|
// Check which newly requested tiles needs rendering.
|
|
std::vector<TileDesc> tilesNeedsRendering;
|
|
for (auto& tile : tileCombined.getTiles())
|
|
{
|
|
std::unique_ptr<std::fstream> cachedTile = _tileCache->lookupTile(tile);
|
|
if(cachedTile)
|
|
cachedTile->close();
|
|
else
|
|
{
|
|
// Not cached, needs rendering.
|
|
tile.setVersion(++_tileVersion);
|
|
tilesNeedsRendering.push_back(tile);
|
|
_debugRenderedTileCount++;
|
|
}
|
|
}
|
|
|
|
// Send rendering request
|
|
if (!tilesNeedsRendering.empty())
|
|
{
|
|
TileCombined newTileCombined = TileCombined::create(tilesNeedsRendering);
|
|
|
|
// Forward to child to render.
|
|
const std::string req = newTileCombined.serialize("tilecombine");
|
|
LOG_DBG("Sending residual tilecombine: " << req);
|
|
_childProcess->sendTextFrame(req);
|
|
}
|
|
|
|
// Accumulate tiles
|
|
boost::optional<TileCombined>& requestedTiles = session->getRequestedTiles();
|
|
if(requestedTiles == boost::none)
|
|
{
|
|
requestedTiles = TileCombined::create(tileCombined.getTiles());
|
|
}
|
|
// Drop duplicated tiles, but use newer version number
|
|
else
|
|
{
|
|
for (const auto& newTile : tileCombined.getTiles())
|
|
{
|
|
const TileDesc& firstOldTile = requestedTiles.get().getTiles()[0];
|
|
if(newTile.getPart() != firstOldTile.getPart() ||
|
|
newTile.getWidth() != firstOldTile.getWidth() ||
|
|
newTile.getHeight() != firstOldTile.getHeight() ||
|
|
newTile.getTileWidth() != firstOldTile.getTileWidth() ||
|
|
newTile.getTileHeight() != firstOldTile.getTileHeight() )
|
|
{
|
|
LOG_WRN("Different visible area information in tile requests");
|
|
}
|
|
|
|
bool tileFound = false;
|
|
for (auto& oldTile : requestedTiles.get().getTiles())
|
|
{
|
|
if(oldTile.getTilePosX() == newTile.getTilePosX() &&
|
|
oldTile.getTilePosY() == newTile.getTilePosY() )
|
|
{
|
|
oldTile.setVersion(newTile.getVersion());
|
|
oldTile.setOldWireId(newTile.getOldWireId());
|
|
oldTile.setWireId(newTile.getWireId());
|
|
tileFound = true;
|
|
break;
|
|
}
|
|
}
|
|
if(!tileFound)
|
|
requestedTiles.get().getTiles().push_back(newTile);
|
|
}
|
|
}
|
|
|
|
lock.unlock();
|
|
lock.release();
|
|
sendRequestedTiles(session);
|
|
}
|
|
|
|
void DocumentBroker::sendRequestedTiles(const std::shared_ptr<ClientSession>& session)
|
|
{
|
|
assert(session->getTilesOnFly() >= 0);
|
|
std::unique_lock<std::mutex> lock(_mutex);
|
|
|
|
// All tiles were processed on client side what we sent last time, so we can send a new banch of tiles
|
|
// which was invalidated / requested in the meantime
|
|
boost::optional<TileCombined>& requestedTiles = session->getRequestedTiles();
|
|
if(session->getTilesOnFly() == 0 && requestedTiles != boost::none && !requestedTiles.get().getTiles().empty())
|
|
{
|
|
session->setTilesOnFly(requestedTiles.get().getTiles().size());
|
|
|
|
// Satisfy as many tiles from the cache.
|
|
for (auto& tile : requestedTiles.get().getTiles())
|
|
{
|
|
std::unique_ptr<std::fstream> cachedTile = _tileCache->lookupTile(tile);
|
|
if (cachedTile)
|
|
{
|
|
//TODO: Combine the response to reduce latency.
|
|
#if ENABLE_DEBUG
|
|
const std::string response = tile.serialize("tile:") + " renderid=cached\n";
|
|
#else
|
|
const std::string response = tile.serialize("tile:") + "\n";
|
|
#endif
|
|
|
|
std::vector<char> output;
|
|
output.reserve(static_cast<size_t>(4) * tile.getWidth() * tile.getHeight());
|
|
output.resize(response.size());
|
|
std::memcpy(output.data(), response.data(), response.size());
|
|
|
|
assert(cachedTile->is_open());
|
|
cachedTile->seekg(0, std::ios_base::end);
|
|
const auto pos = output.size();
|
|
std::streamsize size = cachedTile->tellg();
|
|
output.resize(pos + size);
|
|
cachedTile->seekg(0, std::ios_base::beg);
|
|
cachedTile->read(output.data() + pos, size);
|
|
cachedTile->close();
|
|
|
|
session->sendBinaryFrame(output.data(), output.size());
|
|
}
|
|
else
|
|
{
|
|
// Not cached, needs rendering. Rendering request was already sent
|
|
tileCache().subscribeToTileRendering(tile, session);
|
|
}
|
|
}
|
|
requestedTiles = boost::none;
|
|
}
|
|
}
|
|
|
|
void DocumentBroker::cancelTileRequests(const std::shared_ptr<ClientSession>& session)
|
|
{
|
|
std::unique_lock<std::mutex> lock(_mutex);
|
|
|
|
// Clear tile requests
|
|
session->setTilesOnFly(0);
|
|
session->getRequestedTiles() = boost::none;
|
|
|
|
const std::string canceltiles = tileCache().cancelTiles(session);
|
|
if (!canceltiles.empty())
|
|
{
|
|
LOG_DBG("Forwarding canceltiles request: " << canceltiles);
|
|
_childProcess->sendTextFrame(canceltiles);
|
|
}
|
|
}
|
|
|
|
void DocumentBroker::handleTileResponse(const std::vector<char>& payload)
|
|
{
|
|
const std::string firstLine = getFirstLine(payload);
|
|
LOG_DBG("Handling tile: " << firstLine);
|
|
|
|
try
|
|
{
|
|
const size_t length = payload.size();
|
|
if (firstLine.size() < static_cast<std::string::size_type>(length) - 1)
|
|
{
|
|
const TileDesc tile = TileDesc::parse(firstLine);
|
|
const char* buffer = payload.data();
|
|
const size_t offset = firstLine.size() + 1;
|
|
|
|
std::unique_lock<std::mutex> lock(_mutex);
|
|
|
|
tileCache().saveTileAndNotify(tile, buffer + offset, length - offset);
|
|
}
|
|
else
|
|
{
|
|
LOG_WRN("Dropping empty tile response: " << firstLine);
|
|
// They will get re-issued if we don't forget them.
|
|
}
|
|
}
|
|
catch (const std::exception& exc)
|
|
{
|
|
LOG_ERR("Failed to process tile response [" << firstLine << "]: " << exc.what() << ".");
|
|
}
|
|
}
|
|
|
|
void DocumentBroker::handleTileCombinedResponse(const std::vector<char>& payload)
|
|
{
|
|
const std::string firstLine = getFirstLine(payload);
|
|
LOG_DBG("Handling tile combined: " << firstLine);
|
|
|
|
try
|
|
{
|
|
const size_t length = payload.size();
|
|
if (firstLine.size() < static_cast<std::string::size_type>(length) - 1)
|
|
{
|
|
const TileCombined tileCombined = TileCombined::parse(firstLine);
|
|
const char* buffer = payload.data();
|
|
size_t offset = firstLine.size() + 1;
|
|
|
|
std::unique_lock<std::mutex> lock(_mutex);
|
|
|
|
for (const auto& tile : tileCombined.getTiles())
|
|
{
|
|
tileCache().saveTileAndNotify(tile, buffer + offset, tile.getImgSize());
|
|
offset += tile.getImgSize();
|
|
}
|
|
}
|
|
else
|
|
{
|
|
LOG_WRN("Dropping empty tilecombine response: " << firstLine);
|
|
// They will get re-issued if we don't forget them.
|
|
}
|
|
}
|
|
catch (const std::exception& exc)
|
|
{
|
|
LOG_ERR("Failed to process tile response [" << firstLine << "]: " << exc.what() << ".");
|
|
}
|
|
}
|
|
|
|
bool DocumentBroker::haveAnotherEditableSession(const std::string& id) const
|
|
{
|
|
assertCorrectThread();
|
|
|
|
for (const auto& it : _sessions)
|
|
{
|
|
if (it.second->getId() != id &&
|
|
it.second->isViewLoaded() &&
|
|
!it.second->isReadOnly())
|
|
{
|
|
// This is a loaded session that is non-readonly.
|
|
return true;
|
|
}
|
|
}
|
|
|
|
// None found.
|
|
return false;
|
|
}
|
|
|
|
void DocumentBroker::setModified(const bool value)
|
|
{
|
|
if (_isModified != value)
|
|
{
|
|
_isModified = value;
|
|
Admin::instance().modificationAlert(_docKey, getPid(), value);
|
|
}
|
|
|
|
_storage->setUserModified(value);
|
|
_tileCache->setUnsavedChanges(value);
|
|
}
|
|
|
|
bool DocumentBroker::isInitialSettingSet(const std::string& name) const
|
|
{
|
|
return _isInitialStateSet.find(name) != _isInitialStateSet.end();
|
|
}
|
|
|
|
void DocumentBroker::setInitialSetting(const std::string& name)
|
|
{
|
|
_isInitialStateSet.emplace(name);
|
|
}
|
|
|
|
bool DocumentBroker::forwardToChild(const std::string& viewId, const std::string& message)
|
|
{
|
|
assertCorrectThread();
|
|
|
|
// Ignore userinactive, useractive message until document is loaded
|
|
if (!isLoaded() && (message == "userinactive" || message == "useractive"))
|
|
{
|
|
return true;
|
|
}
|
|
|
|
LOG_TRC("Forwarding payload to child [" << viewId << "]: " << message);
|
|
|
|
std::string msg = "child-" + viewId + ' ' + message;
|
|
|
|
const auto it = _sessions.find(viewId);
|
|
if (it != _sessions.end())
|
|
{
|
|
assert(!_uriJailed.empty());
|
|
|
|
std::vector<std::string> tokens = LOOLProtocol::tokenize(msg);
|
|
if (tokens.size() > 1 && tokens[1] == "load")
|
|
{
|
|
// The json options must come last.
|
|
msg = tokens[0] + ' ' + tokens[1] + ' ' + tokens[2];
|
|
msg += " jail=" + _uriJailed.toString() + ' ';
|
|
msg += Poco::cat(std::string(" "), tokens.begin() + 3, tokens.end());
|
|
}
|
|
|
|
_childProcess->sendTextFrame(msg);
|
|
return true;
|
|
}
|
|
|
|
// try the not yet created sessions
|
|
LOG_WRN("Child session [" << viewId << "] not found to forward message: " << message);
|
|
|
|
return false;
|
|
}
|
|
|
|
bool DocumentBroker::forwardToClient(const std::shared_ptr<Message>& payload)
|
|
{
|
|
assertCorrectThread();
|
|
|
|
const std::string& msg = payload->abbr();
|
|
const std::string& prefix = payload->forwardToken();
|
|
LOG_TRC("Forwarding payload to [" << prefix << "]: " << msg);
|
|
|
|
std::string name;
|
|
std::string sid;
|
|
if (LOOLProtocol::parseNameValuePair(payload->forwardToken(), name, sid, '-') && name == "client")
|
|
{
|
|
const auto& data = payload->data().data();
|
|
const auto& size = payload->size();
|
|
|
|
if (sid == "all")
|
|
{
|
|
// Broadcast to all.
|
|
// Events could cause the removal of sessions.
|
|
std::map<std::string, std::shared_ptr<ClientSession>> sessions(_sessions);
|
|
for (const auto& pair : sessions)
|
|
{
|
|
pair.second->handleKitToClientMessage(data, size);
|
|
}
|
|
}
|
|
else
|
|
{
|
|
const auto it = _sessions.find(sid);
|
|
if (it != _sessions.end())
|
|
{
|
|
// Take a ref as the session could be removed from _sessions
|
|
// if it's the save confirmation keeping a stopped session alive.
|
|
std::shared_ptr<ClientSession> session = it->second;
|
|
return session->handleKitToClientMessage(data, size);
|
|
}
|
|
else
|
|
{
|
|
LOG_WRN("Client session [" << sid << "] not found to forward message: " << msg);
|
|
}
|
|
}
|
|
}
|
|
else
|
|
{
|
|
LOG_ERR("Unexpected prefix of forward-to-client message: " << prefix);
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
void DocumentBroker::shutdownClients(const std::string& closeReason)
|
|
{
|
|
assertCorrectThread();
|
|
LOG_INF("Terminating " << _sessions.size() << " clients of doc [" << _docKey << "] with reason: " << closeReason);
|
|
|
|
// First copy into local container, since removeSession
|
|
// will erase from _sessions, but will leave the last.
|
|
std::map<std::string, std::shared_ptr<ClientSession>> sessions = _sessions;
|
|
for (const auto& pair : sessions)
|
|
{
|
|
std::shared_ptr<ClientSession> session = pair.second;
|
|
try
|
|
{
|
|
// Notify the client and disconnect.
|
|
session->shutdown(WebSocketHandler::StatusCodes::ENDPOINT_GOING_AWAY, closeReason);
|
|
|
|
// Remove session, save, and mark to destroy.
|
|
removeSession(session->getId());
|
|
}
|
|
catch (const std::exception& exc)
|
|
{
|
|
LOG_WRN("Error while shutting down client [" <<
|
|
session->getName() << "]: " << exc.what());
|
|
}
|
|
}
|
|
}
|
|
|
|
void DocumentBroker::childSocketTerminated()
|
|
{
|
|
assertCorrectThread();
|
|
|
|
if (!_childProcess->isAlive())
|
|
{
|
|
LOG_ERR("Child for doc [" << _docKey << "] terminated prematurely.");
|
|
}
|
|
|
|
// We could restore the kit if this was unexpected.
|
|
// For now, close the connections to cleanup.
|
|
shutdownClients("terminated");
|
|
}
|
|
|
|
void DocumentBroker::terminateChild(const std::string& closeReason)
|
|
{
|
|
assertCorrectThread();
|
|
|
|
LOG_INF("Terminating doc [" << _docKey << "] with reason: " << closeReason);
|
|
|
|
// Close all running sessions first.
|
|
shutdownClients(closeReason);
|
|
|
|
if (_childProcess)
|
|
{
|
|
LOG_INF("Terminating child [" << getPid() << "] of doc [" << _docKey << "].");
|
|
|
|
_childProcess->close();
|
|
}
|
|
|
|
stop(closeReason);
|
|
}
|
|
|
|
void DocumentBroker::closeDocument(const std::string& reason)
|
|
{
|
|
assertCorrectThread();
|
|
|
|
LOG_DBG("Closing DocumentBroker for docKey [" << _docKey << "] with reason: " << reason);
|
|
_closeReason = reason;
|
|
_closeRequest = true;
|
|
}
|
|
|
|
void DocumentBroker::broadcastMessage(const std::string& message)
|
|
{
|
|
assertCorrectThread();
|
|
|
|
LOG_DBG("Broadcasting message [" << message << "] to all sessions.");
|
|
for (const auto& sessionIt : _sessions)
|
|
{
|
|
sessionIt.second->sendTextFrame(message);
|
|
}
|
|
}
|
|
|
|
void DocumentBroker::updateLastActivityTime()
|
|
{
|
|
_lastActivityTime = std::chrono::steady_clock::now();
|
|
Admin::instance().updateLastActivityTime(_docKey);
|
|
}
|
|
|
|
void DocumentBroker::getIOStats(uint64_t &sent, uint64_t &recv)
|
|
{
|
|
sent = 0;
|
|
recv = 0;
|
|
assertCorrectThread();
|
|
for (const auto& sessionIt : _sessions)
|
|
{
|
|
uint64_t s, r;
|
|
sessionIt.second->getIOStats(s, r);
|
|
sent += s;
|
|
recv += r;
|
|
}
|
|
}
|
|
|
|
void DocumentBroker::dumpState(std::ostream& os)
|
|
{
|
|
std::unique_lock<std::mutex> lock(_mutex);
|
|
|
|
uint64_t sent, recv;
|
|
getIOStats(sent, recv);
|
|
|
|
os << " Broker: " << _filename << " pid: " << getPid();
|
|
if (_markToDestroy)
|
|
os << " *** Marked to destroy ***";
|
|
else
|
|
os << " has live sessions";
|
|
if (_isLoaded)
|
|
os << "\n loaded in: " << _loadDuration.count() << "ms";
|
|
else
|
|
os << "\n still loading...";
|
|
os << "\n sent: " << sent;
|
|
os << "\n recv: " << recv;
|
|
os << "\n modified?: " << _isModified;
|
|
os << "\n jail id: " << _jailId;
|
|
os << "\n filename: " << _filename;
|
|
os << "\n public uri: " << _uriPublic.toString();
|
|
os << "\n jailed uri: " << _uriJailed.toString();
|
|
os << "\n doc key: " << _docKey;
|
|
os << "\n doc id: " << _docId;
|
|
os << "\n num sessions: " << _sessions.size();
|
|
const std::time_t t = std::chrono::system_clock::to_time_t(
|
|
std::chrono::system_clock::now()
|
|
+ (_lastSaveTime - std::chrono::steady_clock::now()));
|
|
os << "\n last saved: " << std::ctime(&t);
|
|
os << "\n cursor " << _cursorPosX << ", " << _cursorPosY
|
|
<< "( " << _cursorWidth << "," << _cursorHeight << ")\n";
|
|
|
|
_poll->dumpState(os);
|
|
}
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|