Добавил исходный код

This commit is contained in:
2024-02-22 20:39:38 +03:00
parent ba6c43c852
commit dcbf32b1a4
35 changed files with 799 additions and 0 deletions
+18
View File
@@ -0,0 +1,18 @@
# Модуль контроллеров -- обработчиков запросов
project(la_controllers)
# Собираем исходные файлы
file(GLOB_RECURSE SOURCES src/*.cpp)
# Создаём библиотеку
add_library(${PROJECT_NAME} ${SOURCES})
# Указываем директории с заголовочными файлами
target_include_directories(${PROJECT_NAME} PUBLIC include)
# Подключаем зависимости
target_link_libraries(${PROJECT_NAME}
la_json
la_storage
la_utils
)
@@ -0,0 +1,14 @@
#pragma once
#include <controllers/controller_base.h>
namespace controllers::anomaly_logs {
/// @brief Получение аномальных логов
class Get : public ControllerBase {
public:
/// @brief Оператор вызова
/// @param[in] parameters Параметры
/// @returns Ответ
json operator()(const json& parameters) const override;
};
}
@@ -0,0 +1,18 @@
#pragma once
#include <string>
#include <json/json.h>
namespace controllers {
class ControllerBase {
public:
/// @brief Деструктор
virtual ~ControllerBase() = default;
/// @brief Вызов логики контроллера
/// @param[in] parameters Параметры
/// @returns Ответ контроллера
virtual json operator()(const json& parameters) const = 0;
};
}
@@ -0,0 +1,14 @@
#pragma once
#include <controllers/controller_base.h>
namespace controllers::logs_clusters {
/// @brief Создание кластера логов
class Create : public ControllerBase {
public:
/// @brief Оператор вызова
/// @param[in] parameters Параметры
/// @returns Ответ
json operator()(const json& parameters) const override;
};
}
@@ -0,0 +1,14 @@
#pragma once
#include <controllers/controller_base.h>
namespace controllers::logs_clusters {
/// @brief Получение кластеров логов
class Get : public ControllerBase {
public:
/// @brief Оператор вызова
/// @param[in] parameters Параметры
/// @returns Ответ
json operator()(const json& parameters) const override;
};
}
@@ -0,0 +1,14 @@
#pragma once
#include <controllers/controller_base.h>
namespace controllers::statistics {
/// @brief Получение статистики
class Get : public ControllerBase {
public:
/// @brief Оператор вызова
/// @param[in] parameters Параметры
/// @returns Ответ
json operator()(const json& parameters) const override;
};
}
@@ -0,0 +1,17 @@
#pragma once
#include <string_view>
namespace controllers::anomaly_logs::fields {
/// @defgroup Поля запроса
/// @{
constexpr std::string_view last_id = "last_id";
/// @}
/// @defgroup Поля ответа
/// @{
constexpr std::string_view id = "id";
constexpr std::string_view class_id = "class_id";
constexpr std::string_view data = "data";
/// @}
}
@@ -0,0 +1,29 @@
#include "query.h"
#include <sstream>
#include <storage/postgresql/postgresql_storage.h>
namespace controllers::anomaly_logs::details {
std::vector<AnomalyLog> GetAnomalyLogs(int64_t last_id) {
std::ostringstream query;
query << "select id, cluster_id, data from anomaly_logs where id > " << last_id << ";";
auto pqxx_result = PostgreSqlStorage::Get().Do(query.str());
std::vector<AnomalyLog> result;
result.reserve(pqxx_result.size());
for (const auto& row : pqxx_result) {
AnomalyLog anomaly_log{
row[0].as<int64_t>(),
row[1].as<int64_t>(),
row[2].as<std::string>(),
};
result.push_back(std::move(anomaly_log));
}
return result;
}
}
@@ -0,0 +1,14 @@
#pragma once
#include <string>
#include <vector>
namespace controllers::anomaly_logs::details {
struct AnomalyLog {
int64_t id;
int64_t class_id;
std::string data;
};
std::vector<AnomalyLog> GetAnomalyLogs(int64_t last_id);
}
+27
View File
@@ -0,0 +1,27 @@
#include <controllers/anomaly_logs/get.h>
#include <utils/utils.h>
#include "details/fields.h"
#include "details/query.h"
using namespace controllers::anomaly_logs;
json Get::operator()(const json& parameters) const {
utils::CheckForRequiredFields(parameters, { fields::last_id });
auto last_index = parameters[fields::last_id].get<int64_t>();
auto anomaly_logs = details::GetAnomalyLogs(last_index);
json result = json::array();
for (auto& log : anomaly_logs) {
json item = json::object();
item[fields::id] = log.id;
item[fields::class_id] = log.class_id;
item[fields::data] = std::move(log.data);
result.push_back(std::move(item));
}
return result;
}
+15
View File
@@ -0,0 +1,15 @@
#include <controllers/logs_clusters/create.h>
#include <utils/utils.h>
#include "details/fields.h"
#include "details/query.h"
using namespace controllers::logs_clusters;
json Create::operator()(const json& parameters) const {
utils::CheckForRequiredFields(parameters, { fields::id, fields::name, fields::description, fields::recommendation });
details::CreateLogsCluster({parameters[fields::id], parameters[fields::name], parameters[fields::description], parameters[fields::recommendation]});
return {};
}
@@ -0,0 +1,13 @@
#pragma once
#include <string_view>
namespace controllers::logs_clusters::fields {
/// @defgroup Поля ответа
/// @{
constexpr std::string_view id = "id";
constexpr std::string_view name = "name";
constexpr std::string_view description = "description";
constexpr std::string_view recommendation = "recommendation";
/// @}
}
@@ -0,0 +1,42 @@
#include "query.h"
#include <sstream>
#include <storage/postgresql/postgresql_storage.h>
namespace controllers::logs_clusters::details {
std::vector<LogsCluster> GetLogsClusters() {
std::ostringstream query;
query << "select id, name, description, recommendation from logs_clusters;";
auto pqxx_result = PostgreSqlStorage::Get().Do(query.str());
std::vector<LogsCluster> result;
result.reserve(pqxx_result.size());
for (const auto& row : pqxx_result) {
LogsCluster logs_cluster{
row[0].as<int64_t>(),
row[1].as<std::string>(),
row[2].as<std::string>(),
row[3].as<std::string>(),
};
result.push_back(std::move(logs_cluster));
}
return result;
}
void CreateLogsCluster(const LogsCluster& cluster) {
std::ostringstream query;
query << "insert into logs_clusters (id, name, description, recommendation) values ("
<< cluster.id << ", "
<< "'" << cluster.name << "', "
<< "'" << cluster.description << "', "
<< "'" << cluster.recommendation << "'"
<< ");";
PostgreSqlStorage::Get().Do(query.str());
}
}
@@ -0,0 +1,17 @@
#pragma once
#include <string>
#include <vector>
namespace controllers::logs_clusters::details {
struct LogsCluster {
int64_t id;
std::string name;
std::string description;
std::string recommendation;
};
std::vector<LogsCluster> GetLogsClusters();
void CreateLogsCluster(const LogsCluster& cluster);
}
+24
View File
@@ -0,0 +1,24 @@
#include <controllers/logs_clusters/get.h>
#include <utils/utils.h>
#include "details/fields.h"
#include "details/query.h"
using namespace controllers::logs_clusters;
json Get::operator()(const json& parameters) const {
auto clusters = details::GetLogsClusters();
json result = json::array();
for (auto& cluster : clusters) {
json item = json::object();
item[fields::id] = cluster.id;
item[fields::name] = std::move(cluster.name);
item[fields::description] = std::move(cluster.description);
item[fields::recommendation] = std::move(cluster.recommendation);
result.push_back(std::move(item));
}
return result;
}
@@ -0,0 +1,24 @@
#include "query.h"
#include <sstream>
#include <storage/postgresql/postgresql_storage.h>
namespace controllers::statistics::details {
std::vector<Statistic> GetStatistics() {
std::ostringstream query;
query << "select name, value from statistics;";
auto pqxx_result = PostgreSqlStorage::Get().Do(query.str());
std::vector<Statistic> result;
result.reserve(pqxx_result.size());
for (const auto& row : pqxx_result) {
Statistic statistic{ row[0].as<std::string>(), row[1].as<size_t>() };
result.push_back(std::move(statistic));
}
return result;
}
}
@@ -0,0 +1,13 @@
#pragma once
#include <string>
#include <vector>
namespace controllers::statistics::details {
struct Statistic {
std::string name;
size_t value;
};
std::vector<Statistic> GetStatistics();
}
+16
View File
@@ -0,0 +1,16 @@
#include <controllers/statistics/get.h>
#include "details/query.h"
using namespace controllers::statistics;
json Get::operator()(const json& parameters) const {
auto statistics = details::GetStatistics();
json result;
for (auto& statistic : statistics) {
result[std::move(statistic.name)] = statistic.value;
}
return result;
}
+14
View File
@@ -0,0 +1,14 @@
# Модуль для работы с json
project(la_json)
# Создаём библиотеку
add_library(${PROJECT_NAME} INTERFACE)
# Указываем директории с заголовочными файлами
target_include_directories(${PROJECT_NAME}
INTERFACE
${CMAKE_CURRENT_SOURCE_DIR}/include
)
# Подключаем зависимости
target_link_libraries(${PROJECT_NAME} INTERFACE nlohmann_json)
+5
View File
@@ -0,0 +1,5 @@
#pragma once
#include <nlohmann/json.hpp>
using json = nlohmann::json;
+20
View File
@@ -0,0 +1,20 @@
# Модуль для работы с серверной частью и исполняемым приложением
project(la_server)
# Собираем исходные файлы
file(GLOB_RECURSE SOURCES src/*.cpp)
# Создаём исполняемое приложение
add_executable(${PROJECT_NAME} ${SOURCES})
# Указываем директории с заголовочными файлами
target_include_directories(${PROJECT_NAME} PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/include)
# Подключаем зависимости
target_link_libraries(${PROJECT_NAME}
la_configuration
la_controllers
la_json
la_storage
userver-core
)
+44
View File
@@ -0,0 +1,44 @@
#pragma once
#include <string>
enum class LogLevel {
Debug,
Access,
Info,
Warning,
Error,
Severe,
};
/// @brief Функция логирования
using LogFunction = void (*)(LogLevel, const char*);
class Logger {
public:
/// @brief Получение экземпляра класса Logger
static Logger& Get();
/// @brief Задание настроек логирования
/// @param[in] max_log_level Максимальный уровень логирования
/// @param[in] log_function Функция логирования
void SetSettings(LogLevel max_log_level, LogFunction log_function);
/// @brief Логирование сообщения
/// @param[in] level Уровень логирования
/// @param[in] message Сообщение
void Write(LogLevel level, const char* message);
/// @brief Логирование сообщения
/// @param[in] level Уровень логирования
/// @param[in] message Сообщение
void Write(LogLevel level, const std::string& message);
private:
/// @brief Конструктор
Logger() = default;
private:
LogLevel max_log_level_; ///< Максимальный уровень логирования
LogFunction log_function_; ///< Функция логирования
};
+25
View File
@@ -0,0 +1,25 @@
#pragma once
#include <string>
#include <userver/server/handlers/http_handler_base.hpp>
#include "details.h"
#include "traits.h"
namespace server::details {
template <typename Controller>
class ControllerWrapper final : public userver::server::handlers::HttpHandlerBase {
public:
static constexpr std::string_view kName = server::details::traits::ControllerTraits<Controller>::name;
using HttpHandlerBase::HttpHandlerBase;
std::string HandleRequestThrow(const userver::server::http::HttpRequest& request, userver::server::request::RequestContext&) const override {
return server::details::HandleRequest(controller_, request.RequestBody());
}
private:
Controller controller_;
};
}
+58
View File
@@ -0,0 +1,58 @@
#include "details.h"
#include <utils/utils.h>
#include "fields.h"
namespace {
json HandleRequestImpl(const controllers::ControllerBase& controller, const std::string& request) {
using namespace server::details;
// Проверяем корректность формата запроса
auto json = ParseJson(request);
// Проверяем наличие необходимых ключей
utils::CheckForRequiredFields(json, { fields::parameters });
// Формируем и возвращаем ответ
auto parameters = json[fields::parameters];
return controller(parameters);
}
}
namespace server::details {
json ParseJson(const std::string& data) {
json json;
try {
json = json::parse(data);
} catch (const std::exception& e) {
throw std::runtime_error("failed to parse request");
}
return json;
}
std::string HandleRequest(const controllers::ControllerBase& controller, const std::string& request) {
json result;
try {
result = HandleRequestImpl(controller, request);
}
catch (const std::exception& e) {
json json;
json[fields::status] = "error";
json[fields::error_message] = e.what();
result = json.dump();
return result;
}
json json;
json[fields::status] = "ok";
json[fields::result] = result;
result = json.dump();
return result;
}
}
+15
View File
@@ -0,0 +1,15 @@
#include <controllers/controller_base.h>
namespace server::details {
/// @brief Парсинг строки в json
/// @param[in] data Строка
/// @throws std::runtime_error В случае ошибки парсинга (например, некорректный формат)
/// @returns json
json ParseJson(const std::string& data);
/// @brief Обработка запроса
/// @param[in] controller Контроллер
/// @param[in] request Запрос
/// @returns Ответ
std::string HandleRequest(const controllers::ControllerBase& controller, const std::string& request);
}
+11
View File
@@ -0,0 +1,11 @@
#pragma once
#include <string_view>
/// @brief Поля запроса
namespace server::details::fields {
constexpr std::string_view parameters = "parameters"; ///< Параметры
constexpr std::string_view status = "status"; ///< Статус ответа (ok/error)
constexpr std::string_view result = "result"; ///< Результат (в случае статуса ok)
constexpr std::string_view error_message = "error_message"; ///< Сообщение об ошибке (в случае статуса error)
}
+62
View File
@@ -0,0 +1,62 @@
#pragma once
#include <string_view>
namespace controllers {
namespace anomaly_logs {
class Get;
}
namespace logs_clusters {
class Create;
class Get;
}
namespace statistics {
class Get;
}
}
namespace server::details::traits {
/// @brief Свойства контроллера
/// @tparam T Тип контроллера
template <typename T>
struct ControllerTraits {};
/// @defgroup Свойства контроллеров Anomaly Logs
/// @{
template <>
struct ControllerTraits<controllers::anomaly_logs::Get> {
static constexpr std::string_view name = "anomaly-logs-get";
};
/// @}
/// @defgroup Свойства контроллеров Logs Clusters
/// @{
template <>
struct ControllerTraits<controllers::logs_clusters::Create> {
static constexpr std::string_view name = "logs-clusters-create";
};
template <>
struct ControllerTraits<controllers::logs_clusters::Get> {
static constexpr std::string_view name = "logs-clusters-get";
};
/// @}
/// @defgroup Свойства контроллеров Statistics
/// @{
template <>
struct ControllerTraits<controllers::statistics::Get> {
static constexpr std::string_view name = "statistics-get";
};
/// @}
}
+21
View File
@@ -0,0 +1,21 @@
#include <server/logger.h>
Logger& Logger::Get() {
static Logger logger;
return logger;
}
void Logger::SetSettings(LogLevel max_log_level, LogFunction log_function) {
max_log_level_ = max_log_level;
log_function_ = log_function;
}
void Logger::Write(LogLevel level, const char* message) {
if (log_function_ && level <= max_log_level_) {
log_function_(level, message);
}
}
void Logger::Write(LogLevel level, const std::string& message) {
Write(level, message.c_str());
}
+82
View File
@@ -0,0 +1,82 @@
#include <iostream>
#include <userver/components/minimal_server_component_list.hpp>
#include <userver/server/handlers/http_handler_static.hpp>
#include <userver/components/fs_cache.hpp>
#include <userver/utils/daemon_run.hpp>
#include <controllers/anomaly_logs/get.h>
#include <controllers/logs_clusters/create.h>
#include <controllers/logs_clusters/get.h>
#include <controllers/statistics/get.h>
#include <configuration/configuration.h>
#include <json/json.h>
#include <server/logger.h>
#include <storage/postgresql/postgresql_storage.h>
#include "details/controller_wrapper.h"
#include "details/details.h"
void Log(LogLevel level, const char* message) {
std::cout << message << std::endl;
}
void ConnectToStorage(const json& configuration) {
Logger::Get().Write(LogLevel::Info, "connecting to postgresql...");
const auto& parameters = configuration["storage"];
ConnectionData connection_data;
connection_data.database = parameters["database"].get<std::string>();
connection_data.username = parameters["username"].get<std::string>();
connection_data.password = parameters["password"].get<std::string>();
connection_data.host = parameters["host"].get<std::string>();
connection_data.port = std::to_string(parameters["port"].get<int>());
PostgreSqlStorage::Connect(connection_data);
Logger::Get().Write(LogLevel::Info, "connected to postgresql");
}
json ParseConfiguration(const std::string& path_to_configuration) {
json required_keys;
required_keys["server"] = { "path", "port" };
required_keys["storage"] = { "database", "username", "password", "host", "port" };
return ParseConfiguration(path_to_configuration, required_keys);
}
int main(int argc, char** argv) {
if (argc < 2) {
std::cout << "usage: " << argv[0] << " <path-to-configuration>" << std::endl;
return -1;
}
try {
// Парсим конфигурационный файл
auto configuration = ParseConfiguration(argv[1]);
// Настраиваем логирование
Logger::Get().SetSettings(LogLevel::Info, Log);
// Подключаемся к базе данных
ConnectToStorage(configuration);
const auto component_list = userver::components::MinimalServerComponentList()
// static content
.Append<userver::components::FsCache>("fs-cache-main")
.Append<userver::server::handlers::HttpHandlerStatic>()
// anomaly logs
.Append<server::details::ControllerWrapper<controllers::anomaly_logs::Get>>()
// clusters
.Append<server::details::ControllerWrapper<controllers::logs_clusters::Create>>()
.Append<server::details::ControllerWrapper<controllers::logs_clusters::Get>>()
// statistics
.Append<server::details::ControllerWrapper<controllers::statistics::Get>>();
return userver::utils::DaemonMain(argc, argv, component_list);
} catch (const std::exception& e) {
std::cout << e.what() << std::endl;
return -1;
}
}
+11
View File
@@ -0,0 +1,11 @@
project(la_storage)
file(GLOB_RECURSE SOURCES src/*.cpp)
add_library(${PROJECT_NAME})
target_sources(${PROJECT_NAME} PRIVATE ${SOURCES})
target_include_directories(${PROJECT_NAME} PUBLIC include PRIVATE ${THIRD_PARTY_DIR}/include)
target_link_libraries(${PROJECT_NAME} PUBLIC pqxx)
@@ -0,0 +1,19 @@
#pragma once
#include <string>
#include <memory>
#include <pqxx/pqxx>
struct ConnectionData {
std::string database, username, password, host, port;
};
class PostgreSqlStorage {
public:
static PostgreSqlStorage& Get();
static void Connect(const ConnectionData& connection_data);
pqxx::result Do(std::string_view query) const;
private:
std::unique_ptr<pqxx::connection> connection_;
};
+32
View File
@@ -0,0 +1,32 @@
#include <sstream>
#include <storage/postgresql/postgresql_storage.h>
PostgreSqlStorage& PostgreSqlStorage::Get() {
static PostgreSqlStorage storage;
return storage;
}
void PostgreSqlStorage::Connect(const ConnectionData& connection_data) {
std::ostringstream options;
options << "dbname = " << connection_data.database
<< " user = " << connection_data.username
<< " password = " << connection_data.password
<< " host = " << connection_data.host
<< " port = " << connection_data.port;
Get().connection_ = std::make_unique<pqxx::connection>(options.str());
}
pqxx::result PostgreSqlStorage::Do(std::string_view query) const {
// Создаём транзакцию
pqxx::work work(*connection_);
// Выполняем запрос
pqxx::result result = work.exec(query);
// Завершаем транзакцию
work.commit();
return result;
}
+11
View File
@@ -0,0 +1,11 @@
project(la_utils)
file(GLOB_RECURSE SOURCES src/*.cpp)
add_library(${PROJECT_NAME})
target_sources(${PROJECT_NAME} PRIVATE ${SOURCES})
target_include_directories(${PROJECT_NAME} PUBLIC include PRIVATE ${THIRD_PARTY_DIR}/include)
target_link_libraries(${PROJECT_NAME} PUBLIC la_json)
+12
View File
@@ -0,0 +1,12 @@
#include <string_view>
#include <initializer_list>
#include <json/json.h>
namespace utils {
/// @brief Проверка наличия необходимых ключей
/// @param[in] json Объект, который надо проверить
/// @param[in] fields Необходимые ключи
/// @throws std::runtime_error В случае отсутствия хотя бы одного ключа
void CheckForRequiredFields(const json& json, std::initializer_list<std::string_view> fields);
}
+14
View File
@@ -0,0 +1,14 @@
#include <sstream>
#include <utils/utils.h>
namespace utils {
void CheckForRequiredFields(const json& json, std::initializer_list<std::string_view> fields) {
for (const auto& field : fields)
if (!json.contains(field)) {
std::ostringstream message;
message << "request doesn't contain required field '" << field << "'";
throw std::runtime_error(message.str());
}
}
}