1aacfdf460
The API req->param["name"] to access parameters in the path part of the URL was buggy - it forgot to do URL decoding and the result of our use of it in Scylla was bugs like #5883 - where special characters in certain REST API requests got botched up (encoded by the client, then not decoded by the server). The solution is to replace all uses of req->param["name"] by the new req->get_path_param("name"), which does the decoding correctly. Unfortunately we needed to change 104 (!) callers in this patch, but the transformation is mostly mechanical and there is no functional changes in this patch. Another set of changes was to bring req, not req->param, to a few functions that want to get the path param. This patch avoids the numerous deprecation warnings we had before, and more importantly, it fixes #5883. Signed-off-by: Nadav Har'El <nyh@scylladb.com>
108 lines
3.0 KiB
C++
108 lines
3.0 KiB
C++
/*
|
|
* Copyright 2018-present ScyllaDB
|
|
*/
|
|
|
|
/*
|
|
* SPDX-License-Identifier: AGPL-3.0-or-later
|
|
*/
|
|
|
|
#include "api/config.hh"
|
|
#include "api/api-doc/config.json.hh"
|
|
#include "db/config.hh"
|
|
#include <sstream>
|
|
#include <boost/algorithm/string/replace.hpp>
|
|
#include <seastar/http/exception.hh>
|
|
|
|
namespace api {
|
|
using namespace seastar::httpd;
|
|
|
|
template<class T>
|
|
json::json_return_type get_json_return_type(const T& val) {
|
|
return json::json_return_type(val);
|
|
}
|
|
|
|
/*
|
|
* As commented on db::seed_provider_type is not used
|
|
* and probably never will.
|
|
*
|
|
* Just in case, we will return its name
|
|
*/
|
|
template<>
|
|
json::json_return_type get_json_return_type(const db::seed_provider_type& val) {
|
|
return json::json_return_type(val.class_name);
|
|
}
|
|
|
|
std::string_view format_type(std::string_view type) {
|
|
if (type == "int") {
|
|
return "integer";
|
|
}
|
|
return type;
|
|
}
|
|
|
|
future<> get_config_swagger_entry(std::string_view name, const std::string& description, std::string_view type, bool& first, output_stream<char>& os) {
|
|
std::stringstream ss;
|
|
if (first) {
|
|
first=false;
|
|
} else {
|
|
ss <<',';
|
|
};
|
|
ss << "\"/v2/config/" << name <<"\": {"
|
|
"\"get\": {"
|
|
"\"description\": \"" << boost::replace_all_copy(boost::replace_all_copy(boost::replace_all_copy(description,"\n","\\n"),"\"", "''"), "\t", " ") <<"\","
|
|
"\"operationId\": \"find_config_"<< name <<"\","
|
|
"\"produces\": ["
|
|
"\"application/json\""
|
|
"],"
|
|
"\"tags\": [\"config\"],"
|
|
"\"parameters\": ["
|
|
"],"
|
|
"\"responses\": {"
|
|
"\"200\": {"
|
|
"\"description\": \"Config value\","
|
|
"\"schema\": {"
|
|
"\"type\": \"" << format_type(type) << "\""
|
|
"}"
|
|
"},"
|
|
"\"default\": {"
|
|
"\"description\": \"unexpected error\","
|
|
"\"schema\": {"
|
|
"\"$ref\": \"#/definitions/ErrorModel\""
|
|
"}"
|
|
"}"
|
|
"}"
|
|
"}"
|
|
"}";
|
|
return os.write(ss.str());
|
|
}
|
|
|
|
namespace cs = httpd::config_json;
|
|
|
|
void set_config(std::shared_ptr < api_registry_builder20 > rb, http_context& ctx, routes& r, const db::config& cfg, bool first) {
|
|
rb->register_function(r, [&cfg, first] (output_stream<char>& os) {
|
|
return do_with(first, [&os, &cfg] (bool& first) {
|
|
auto f = make_ready_future();
|
|
for (auto&& cfg_ref : cfg.values()) {
|
|
auto&& cfg = cfg_ref.get();
|
|
f = f.then([&os, &first, &cfg] {
|
|
return get_config_swagger_entry(cfg.name(), std::string(cfg.desc()), cfg.type_name(), first, os);
|
|
});
|
|
}
|
|
return f;
|
|
});
|
|
});
|
|
|
|
cs::find_config_id.set(r, [&cfg] (const_req r) {
|
|
auto id = r.get_path_param("id");
|
|
for (auto&& cfg_ref : cfg.values()) {
|
|
auto&& cfg = cfg_ref.get();
|
|
if (id == cfg.name()) {
|
|
return cfg.value_as_json();
|
|
}
|
|
}
|
|
throw bad_param_exception(sstring("No such config entry: ") + id);
|
|
});
|
|
}
|
|
|
|
}
|
|
|