mirror of
https://github.com/akuker/RASCSI.git
synced 2024-12-01 13:51:43 +00:00
8bd06ea5cd
* Improve how commands are internally executed * Use const CommandContext for execution * Update error handling * Fix SonarQube issues * Remove duplicate code * Use mutex instead of atomic_bool * Add hasher * Add param_map * Do not log unknown operations as an error for backward/foward compatibility
106 lines
2.7 KiB
C++
106 lines
2.7 KiB
C++
//---------------------------------------------------------------------------
|
|
//
|
|
// SCSI Target Emulator PiSCSI
|
|
// for Raspberry Pi
|
|
//
|
|
// Copyright (C) 2021-2023 Uwe Seimet
|
|
//
|
|
//---------------------------------------------------------------------------
|
|
|
|
#include "shared/piscsi_exceptions.h"
|
|
#include "shared/protobuf_util.h"
|
|
#include "command_context.h"
|
|
#include <spdlog/spdlog.h>
|
|
#include <iostream>
|
|
|
|
using namespace std;
|
|
using namespace piscsi_interface;
|
|
using namespace protobuf_util;
|
|
|
|
bool CommandContext::ReadCommand()
|
|
{
|
|
// Read magic string
|
|
array<byte, 6> magic;
|
|
if (const size_t bytes_read = ReadBytes(fd, magic); bytes_read) {
|
|
if (bytes_read != magic.size() || memcmp(magic.data(), "RASCSI", magic.size())) {
|
|
throw io_exception("Invalid magic");
|
|
}
|
|
|
|
// Fetch the command
|
|
DeserializeMessage(fd, command);
|
|
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
void CommandContext::WriteResult(const PbResult& result) const
|
|
{
|
|
// The descriptor is -1 when devices are not attached via the remote interface but by the piscsi tool
|
|
if (fd != -1) {
|
|
SerializeMessage(fd, result);
|
|
}
|
|
}
|
|
|
|
bool CommandContext::WriteSuccessResult(PbResult& result) const
|
|
{
|
|
result.set_status(true);
|
|
WriteResult(result);
|
|
return true;
|
|
}
|
|
|
|
bool CommandContext::ReturnLocalizedError(LocalizationKey key, const string& arg1, const string& arg2,
|
|
const string& arg3) const
|
|
{
|
|
return ReturnLocalizedError(key, NO_ERROR_CODE, arg1, arg2, arg3);
|
|
}
|
|
|
|
bool CommandContext::ReturnLocalizedError(LocalizationKey key, PbErrorCode error_code, const string& arg1,
|
|
const string& arg2, const string& arg3) const
|
|
{
|
|
// For the logfile always use English
|
|
// Do not log unknown operations as an error for backward/foward compatibility with old/new clients
|
|
if (error_code == PbErrorCode::UNKNOWN_OPERATION) {
|
|
spdlog::trace(localizer.Localize(key, "en", arg1, arg2, arg3));
|
|
}
|
|
else {
|
|
spdlog::error(localizer.Localize(key, "en", arg1, arg2, arg3));
|
|
}
|
|
|
|
return ReturnStatus(false, localizer.Localize(key, locale, arg1, arg2, arg3), error_code, false);
|
|
}
|
|
|
|
bool CommandContext::ReturnStatus(bool status, const string& msg, PbErrorCode error_code, bool log) const
|
|
{
|
|
// Do not log twice if logging has already been done in the localized error handling above
|
|
if (log && !status && !msg.empty()) {
|
|
spdlog::error(msg);
|
|
}
|
|
|
|
if (fd == -1) {
|
|
if (!msg.empty()) {
|
|
cerr << "Error: " << msg << endl;
|
|
}
|
|
}
|
|
else {
|
|
PbResult result;
|
|
result.set_status(status);
|
|
result.set_error_code(error_code);
|
|
result.set_msg(msg);
|
|
WriteResult(result);
|
|
}
|
|
|
|
return status;
|
|
}
|
|
|
|
bool CommandContext::ReturnSuccessStatus() const
|
|
{
|
|
return ReturnStatus(true, "", PbErrorCode::NO_ERROR_CODE, true);
|
|
}
|
|
|
|
bool CommandContext::ReturnErrorStatus(const string& msg) const
|
|
{
|
|
return ReturnStatus(false, msg, PbErrorCode::NO_ERROR_CODE, true);
|
|
}
|