libreoffice-online/common/Message.hpp

185 lines
6 KiB
C++
Raw Normal View History

/* -*- 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/.
*/
#pragma once
#include <atomic>
#include <string>
#include <vector>
#include <functional>
#include "Protocol.hpp"
#include "Log.hpp"
/// The payload type used to send/receive data.
class Message
{
public:
enum class Type { Text, JSON, Binary };
enum class Dir { In, Out };
/// Construct a text message.
/// message must include the full first-line.
Message(const std::string& message,
const enum Dir dir) :
_forwardToken(getForwardToken(message.data(), message.size())),
_data(skipWhitespace(message.data() + _forwardToken.size()), message.data() + message.size()),
_tokens(Util::tokenize(_data.data(), _data.size())),
_id(makeId(dir)),
_firstLine(LOOLProtocol::getFirstLine(_data.data(), _data.size())),
_abbr(_id + ' ' + LOOLProtocol::getAbbreviatedMessage(_data.data(), _data.size())),
_type(detectType())
{
LOG_TRC("Message " << _abbr);
}
/// Construct a message from a string with type and
/// reserve extra space (total, including message).
/// message must include the full first-line.
Message(const std::string& message,
const enum Dir dir,
const size_t reserve) :
_forwardToken(getForwardToken(message.data(), message.size())),
_data(std::max(reserve, message.size())),
_tokens(Util::tokenize(message.data() + _forwardToken.size(), message.size() - _forwardToken.size())),
_id(makeId(dir)),
_firstLine(LOOLProtocol::getFirstLine(message)),
_abbr(_id + ' ' + LOOLProtocol::getAbbreviatedMessage(message)),
_type(detectType())
{
_data.resize(message.size());
const char* offset = skipWhitespace(message.data() + _forwardToken.size());
std::memcpy(_data.data(), offset, message.size() - (offset - message.data()));
LOG_TRC("Message " << _abbr);
}
/// Construct a message from a character array with type.
/// Note: p must include the full first-line.
Message(const char* p,
const size_t len,
const enum Dir dir) :
_forwardToken(getForwardToken(p, len)),
_data(skipWhitespace(p + _forwardToken.size()), p + len),
_tokens(Util::tokenize(_data.data(), _data.size())),
_id(makeId(dir)),
_firstLine(LOOLProtocol::getFirstLine(_data.data(), _data.size())),
_abbr(_id + ' ' + LOOLProtocol::getAbbreviatedMessage(_data.data(), _data.size())),
_type(detectType())
{
LOG_TRC("Message " << _abbr);
}
size_t size() const { return _data.size(); }
const std::vector<char>& data() const { return _data; }
const StringVector& tokens() const { return _tokens; }
const std::string& forwardToken() const { return _forwardToken; }
std::string firstToken() const { return _tokens[0]; }
const std::string& firstLine() const { return _firstLine; }
std::string operator[](size_t index) const { return _tokens[index]; }
bool getTokenInteger(const std::string& name, int& value)
{
return LOOLProtocol::getTokenInteger(_tokens, name, value);
}
/// Return the abbreviated message for logging purposes.
const std::string& abbr() const { return _abbr; }
const std::string& id() const { return _id; }
/// Returns the json part of the message, if any.
std::string jsonString() const
{
if (_tokens.size() > 1 && _tokens[1].size() && _tokens[1][0] == '{')
{
const size_t firstTokenSize = _tokens[0].size();
return std::string(_data.data() + firstTokenSize, _data.size() - firstTokenSize);
}
return std::string();
}
/// Append more data to the message.
void append(const char* p, const size_t len)
{
const size_t curSize = _data.size();
_data.resize(curSize + len);
std::memcpy(_data.data() + curSize, p, len);
}
/// Returns true if and only if the payload is considered Binary.
bool isBinary() const { return _type == Type::Binary; }
/// Allows some in-line re-writing of the message
void rewriteDataBody(const std::function<bool (std::vector<char> &)>& func)
{
if (func(_data))
{
// Check - just the body.
assert(_firstLine == LOOLProtocol::getFirstLine(_data.data(), _data.size()));
assert(_abbr == _id + ' ' + LOOLProtocol::getAbbreviatedMessage(_data.data(), _data.size()));
assert(_type == detectType());
}
}
private:
/// Constructs a unique ID.
static std::string makeId(const enum Dir dir)
{
static std::atomic<unsigned> Counter;
return (dir == Dir::In ? 'i' : 'o') + std::to_string(++Counter);
}
Type detectType() const
{
if (_tokens.equals(0, "tile:") ||
_tokens.equals(0, "tilecombine:") ||
_tokens.equals(0, "renderfont:") ||
_tokens.equals(0, "windowpaint:"))
{
return Type::Binary;
}
if (_data[_data.size() - 1] == '}')
{
return Type::JSON;
}
// All others are plain text.
return Type::Text;
}
std::string getForwardToken(const char* buffer, int length)
{
std::string forward = LOOLProtocol::getFirstToken(buffer, length);
return (forward.find('-') != std::string::npos ? forward : std::string());
}
const char* skipWhitespace(const char* p)
{
while (p && *p == ' ')
{
++p;
}
return p;
}
private:
const std::string _forwardToken;
std::vector<char> _data;
const StringVector _tokens;
const std::string _id;
const std::string _firstLine;
const std::string _abbr;
const Type _type;
};
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */