367 lines
11 KiB
C++
367 lines
11 KiB
C++
/*
|
|
* Copyright (C) 2019 Emeric Poupon
|
|
*
|
|
* This file is part of LMS.
|
|
*
|
|
* LMS is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* LMS is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with LMS. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#include "SubsonicResponse.hpp"
|
|
|
|
#include <cassert>
|
|
#include <climits>
|
|
#include <cmath>
|
|
|
|
#include <boost/property_tree/xml_parser.hpp>
|
|
|
|
#include "core/String.hpp"
|
|
#include "core/Version.hpp"
|
|
|
|
#include "ProtocolVersion.hpp"
|
|
|
|
namespace lms::api::subsonic
|
|
{
|
|
void Response::Node::setValue(std::string_view value)
|
|
{
|
|
assert(_children.empty() && _childrenArrays.empty() && _childrenValues.empty());
|
|
_value = string{ value };
|
|
}
|
|
|
|
void Response::Node::setValue(long long value)
|
|
{
|
|
assert(_children.empty() && _childrenArrays.empty() && _childrenValues.empty());
|
|
_value = value;
|
|
}
|
|
|
|
void Response::Node::setAttribute(Key key, std::string_view value)
|
|
{
|
|
_attributes[key] = string{ value };
|
|
}
|
|
|
|
void Response::Node::addChild(Key key, Node&& node)
|
|
{
|
|
assert(!_value);
|
|
assert(!_children.contains(key));
|
|
_children[key] = std::move(node);
|
|
}
|
|
|
|
void Response::Node::createEmptyArrayChild(Key key)
|
|
{
|
|
assert(!_value);
|
|
assert(_children.find(key) == std::cend(_children));
|
|
_childrenArrays.emplace(key, vector<Node>{});
|
|
}
|
|
|
|
void Response::Node::addArrayChild(Key key, Node&& node)
|
|
{
|
|
assert(!_value);
|
|
assert(!_children.contains(key));
|
|
_childrenArrays[key].emplace_back(std::move(node));
|
|
}
|
|
|
|
void Response::Node::createEmptyArrayValue(Key key)
|
|
{
|
|
assert(!_value);
|
|
assert(!_children.contains(key));
|
|
_childrenValues.emplace(key, ValuesType{});
|
|
}
|
|
|
|
void Response::Node::addArrayValue(Key key, std::string_view value)
|
|
{
|
|
assert(!_value);
|
|
assert(!_children.contains(key));
|
|
auto& values{ _childrenValues[key] };
|
|
values.emplace_back(string{ value });
|
|
assert(std::all_of(std::cbegin(values) + 1, std::cend(values), [&](const ValueType& value) { return value.index() == values.front().index(); }));
|
|
}
|
|
|
|
void Response::Node::addArrayValue(Key key, long long value)
|
|
{
|
|
assert(!_value);
|
|
auto& values{ _childrenValues[key] };
|
|
values.emplace_back(value);
|
|
assert(std::all_of(std::cbegin(values) + 1, std::cend(values), [&](const ValueType& value) { return value.index() == values.front().index(); }));
|
|
}
|
|
|
|
Response::Node& Response::Node::createChild(Key key)
|
|
{
|
|
assert(!_value);
|
|
return _children[key];
|
|
}
|
|
|
|
Response::Node& Response::Node::createArrayChild(Key key)
|
|
{
|
|
assert(!_value);
|
|
assert(!_children.contains(key));
|
|
_childrenArrays[key].emplace_back();
|
|
return _childrenArrays[key].back();
|
|
}
|
|
|
|
void Response::Node::setVersionAttribute(ProtocolVersion protocolVersion)
|
|
{
|
|
setAttribute("version", std::to_string(protocolVersion.major) + "." + std::to_string(protocolVersion.minor) + "." + std::to_string(protocolVersion.patch));
|
|
}
|
|
|
|
Response Response::createOkResponse(ProtocolVersion protocolVersion)
|
|
{
|
|
return createResponseCommon(protocolVersion);
|
|
}
|
|
|
|
Response Response::createFailedResponse(ProtocolVersion protocolVersion, const Error& error)
|
|
{
|
|
return createResponseCommon(protocolVersion, &error);
|
|
}
|
|
|
|
Response Response::createResponseCommon(ProtocolVersion protocolVersion, const Error* error)
|
|
{
|
|
Response response;
|
|
Node& responseNode{ response._root.createChild("subsonic-response") };
|
|
|
|
responseNode.setAttribute("status", error ? "failed" : "ok");
|
|
responseNode.setVersionAttribute(protocolVersion);
|
|
|
|
if (error)
|
|
{
|
|
Node& errorNode{ responseNode.createChild("error") };
|
|
errorNode.setAttribute("code", static_cast<int>(error->getCode()));
|
|
errorNode.setAttribute("message", error->getMessage());
|
|
}
|
|
|
|
// OpenSubsonic mandatory fields
|
|
// No big deal to send them even for legacy clients
|
|
responseNode.setAttribute("type", "lms");
|
|
responseNode.setAttribute("serverVersion", core::getVersion());
|
|
responseNode.setAttribute("openSubsonic", true);
|
|
|
|
return response;
|
|
}
|
|
|
|
void Response::addNode(Node::Key key, Node&& node)
|
|
{
|
|
return _root._children["subsonic-response"].addChild(key, std::move(node));
|
|
}
|
|
|
|
Response::Node& Response::createNode(Node::Key key)
|
|
{
|
|
return _root._children["subsonic-response"].createChild(key);
|
|
}
|
|
|
|
Response::Node& Response::createArrayNode(Node::Key key)
|
|
{
|
|
return _root._children["subsonic-response"].createArrayChild(key);
|
|
}
|
|
|
|
void Response::write(std::ostream& os, ResponseFormat format) const
|
|
{
|
|
switch (format)
|
|
{
|
|
case ResponseFormat::xml:
|
|
writeXML(os);
|
|
break;
|
|
case ResponseFormat::json:
|
|
writeJSON(os);
|
|
break;
|
|
}
|
|
}
|
|
|
|
void Response::writeXML(std::ostream& os) const
|
|
{
|
|
std::function<boost::property_tree::ptree(const Node&)> nodeToPropertyTree = [&](const Node& node) {
|
|
boost::property_tree::ptree res;
|
|
|
|
auto valueToPropertyTree = [](const Node::ValueType& value) {
|
|
boost::property_tree::ptree res;
|
|
std::visit([&](const auto& rawValue) {
|
|
using RawValueType = std::decay_t<decltype(rawValue)>;
|
|
if constexpr (std::is_same_v<RawValueType, Node::string>)
|
|
res.put_value(core::stringUtils::replaceInString(rawValue, "\n", "\\n"));
|
|
else
|
|
res.put_value(rawValue);
|
|
},
|
|
value);
|
|
|
|
return res;
|
|
};
|
|
|
|
if (node._value)
|
|
{
|
|
res = valueToPropertyTree(*node._value);
|
|
}
|
|
else
|
|
{
|
|
for (const auto& [key, childNode] : node._children)
|
|
{
|
|
boost::property_tree::ptree& tree{ res.add_child(std::string{ key.str() }, nodeToPropertyTree(childNode)) };
|
|
// Hardcoded attribute to simplify createOkResponse calls
|
|
if (key == "subsonic-response")
|
|
tree.put("<xmlattr>.xmlns", "http://subsonic.org/restapi");
|
|
}
|
|
|
|
for (const auto& [key, childArrayNodes] : node._childrenArrays)
|
|
{
|
|
for (const Node& childNode : childArrayNodes)
|
|
res.add_child(std::string{ key.str() }, nodeToPropertyTree(childNode));
|
|
}
|
|
|
|
for (const auto& [key, childArrayValues] : node._childrenValues)
|
|
{
|
|
for (const Response::Node::ValueType& value : childArrayValues)
|
|
res.add_child(std::string{ key.str() }, valueToPropertyTree(value));
|
|
}
|
|
}
|
|
|
|
for (const auto& [key, value] : node._attributes)
|
|
{
|
|
if (std::holds_alternative<Node::string>(value))
|
|
res.put("<xmlattr>." + std::string{ key.str() }, std::get<Node::string>(value));
|
|
else if (std::holds_alternative<bool>(value))
|
|
res.put("<xmlattr>." + std::string{ key.str() }, std::get<bool>(value));
|
|
else if (std::holds_alternative<float>(value))
|
|
res.put("<xmlattr>." + std::string{ key.str() }, std::get<float>(value));
|
|
else if (std::holds_alternative<long long>(value))
|
|
res.put("<xmlattr>." + std::string{ key.str() }, std::get<long long>(value));
|
|
else
|
|
assert(false);
|
|
}
|
|
|
|
return res;
|
|
};
|
|
|
|
const boost::property_tree::ptree root{ nodeToPropertyTree(_root) };
|
|
boost::property_tree::write_xml(os, root);
|
|
}
|
|
|
|
void Response::JsonSerializer::serializeNode(std::ostream& os, const Response::Node& node)
|
|
{
|
|
os << '{';
|
|
|
|
bool first{ true };
|
|
|
|
for (const auto& [key, value] : node._attributes)
|
|
{
|
|
if (!first)
|
|
os << ',';
|
|
|
|
serializeEscapedString(os, key.str());
|
|
os << ':';
|
|
serializeValue(os, value);
|
|
|
|
first = false;
|
|
}
|
|
|
|
// Values are handled manually (using attributes) in json format
|
|
assert(!node._value);
|
|
|
|
for (const auto& [key, childNode] : node._children)
|
|
{
|
|
if (!first)
|
|
os << ',';
|
|
|
|
serializeEscapedString(os, key.str());
|
|
os << ':';
|
|
serializeNode(os, childNode);
|
|
|
|
first = false;
|
|
}
|
|
|
|
for (const auto& [key, childArrayNodes] : node._childrenArrays)
|
|
{
|
|
if (!first)
|
|
os << ',';
|
|
|
|
serializeEscapedString(os, key.str());
|
|
os << ":[";
|
|
|
|
bool firstChild{ true };
|
|
for (const Response::Node& childNode : childArrayNodes)
|
|
{
|
|
if (!firstChild)
|
|
os << ",";
|
|
|
|
serializeNode(os, childNode);
|
|
firstChild = false;
|
|
}
|
|
os << ']';
|
|
|
|
first = false;
|
|
}
|
|
|
|
for (const auto& [key, childValues] : node._childrenValues)
|
|
{
|
|
if (!first)
|
|
os << ',';
|
|
|
|
serializeEscapedString(os, key.str());
|
|
os << ":[";
|
|
|
|
bool firstChild{ true };
|
|
for (const Node::ValueType& childValue : childValues)
|
|
{
|
|
if (!firstChild)
|
|
os << ",";
|
|
|
|
serializeValue(os, childValue);
|
|
|
|
firstChild = false;
|
|
}
|
|
os << ']';
|
|
|
|
first = false;
|
|
}
|
|
|
|
os << '}';
|
|
}
|
|
|
|
void Response::JsonSerializer::serializeValue(std::ostream& os, const Node::ValueType& value)
|
|
{
|
|
if (std::holds_alternative<Node::string>(value))
|
|
{
|
|
serializeEscapedString(os, std::get<Node::string>(value));
|
|
}
|
|
else if (std::holds_alternative<bool>(value))
|
|
{
|
|
os << (std::get<bool>(value) ? "true" : "false");
|
|
}
|
|
else if (std::holds_alternative<float>(value))
|
|
{
|
|
const float d{ std::get<float>(value) };
|
|
if (std::isnan(d) || std::fabs(d) == std::numeric_limits<float>::infinity())
|
|
os << "null";
|
|
else
|
|
os << d;
|
|
}
|
|
else if (std::holds_alternative<long long>(value))
|
|
{
|
|
os << std::get<long long>(value);
|
|
}
|
|
else
|
|
{
|
|
assert(false);
|
|
}
|
|
}
|
|
|
|
void Response::JsonSerializer::serializeEscapedString(std::ostream& os, std::string_view str)
|
|
{
|
|
os << '\"';
|
|
core::stringUtils::writeJsonEscapedString(os, str);
|
|
os << '\"';
|
|
}
|
|
|
|
void Response::writeJSON(std::ostream& os) const
|
|
{
|
|
JsonSerializer serializer;
|
|
serializer.serializeNode(os, _root);
|
|
}
|
|
} // namespace lms::api::subsonic
|