mirror of
https://codeberg.org/anoncontributorxmr/monero.git
synced 2024-11-30 11:13:13 +00:00
5833d66f65
This replaces the epee and data_loggers logging systems with
a single one, and also adds filename:line and explicit severity
levels. Categories may be defined, and logging severity set
by category (or set of categories). epee style 0-4 log level
maps to a sensible severity configuration. Log files now also
rotate when reaching 100 MB.
To select which logs to output, use the MONERO_LOGS environment
variable, with a comma separated list of categories (globs are
supported), with their requested severity level after a colon.
If a log matches more than one such setting, the last one in
the configuration string applies. A few examples:
This one is (mostly) silent, only outputting fatal errors:
MONERO_LOGS=*:FATAL
This one is very verbose:
MONERO_LOGS=*:TRACE
This one is totally silent (logwise):
MONERO_LOGS=""
This one outputs all errors and warnings, except for the
"verify" category, which prints just fatal errors (the verify
category is used for logs about incoming transactions and
blocks, and it is expected that some/many will fail to verify,
hence we don't want the spam):
MONERO_LOGS=*:WARNING,verify:FATAL
Log levels are, in decreasing order of priority:
FATAL, ERROR, WARNING, INFO, DEBUG, TRACE
Subcategories may be added using prefixes and globs. This
example will output net.p2p logs at the TRACE level, but all
other net* logs only at INFO:
MONERO_LOGS=*:ERROR,net*:INFO,net.p2p:TRACE
Logs which are intended for the user (which Monero was using
a lot through epee, but really isn't a nice way to go things)
should use the "global" category. There are a few helper macros
for using this category, eg: MGINFO("this shows up by default")
or MGINFO_RED("this is red"), to try to keep a similar look
and feel for now.
Existing epee log macros still exist, and map to the new log
levels, but since they're used as a "user facing" UI element
as much as a logging system, they often don't map well to log
severities (ie, a log level 0 log may be an error, or may be
something we want the user to see, such as an important info).
In those cases, I tried to use the new macros. In other cases,
I left the existing macros in. When modifying logs, it is
probably best to switch to the new macros with explicit levels.
The --log-level options and set_log commands now also accept
category settings, in addition to the epee style log levels.
236 lines
11 KiB
C++
236 lines
11 KiB
C++
// Copyright (c) 2006-2013, Andrey N. Sabelnikov, www.sabelnikov.net
|
|
// All rights reserved.
|
|
//
|
|
// Redistribution and use in source and binary forms, with or without
|
|
// modification, are permitted provided that the following conditions are met:
|
|
// * Redistributions of source code must retain the above copyright
|
|
// notice, this list of conditions and the following disclaimer.
|
|
// * Redistributions in binary form must reproduce the above copyright
|
|
// notice, this list of conditions and the following disclaimer in the
|
|
// documentation and/or other materials provided with the distribution.
|
|
// * Neither the name of the Andrey N. Sabelnikov nor the
|
|
// names of its contributors may be used to endorse or promote products
|
|
// derived from this software without specific prior written permission.
|
|
//
|
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
|
// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
|
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER BE LIABLE FOR ANY
|
|
// DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
|
// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
|
// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
|
// ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
|
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
//
|
|
|
|
|
|
#pragma once
|
|
#include "http_base.h"
|
|
#include "jsonrpc_structs.h"
|
|
#include "storages/portable_storage.h"
|
|
#include "storages/portable_storage_template_helper.h"
|
|
|
|
#undef MONERO_DEFAULT_LOG_CATEGORY
|
|
#define MONERO_DEFAULT_LOG_CATEGORY "net.http"
|
|
|
|
|
|
#define CHAIN_HTTP_TO_MAP2(context_type) bool handle_http_request(const epee::net_utils::http::http_request_info& query_info, \
|
|
epee::net_utils::http::http_response_info& response, \
|
|
context_type& m_conn_context) \
|
|
{\
|
|
LOG_PRINT_L2("HTTP [" << epee::string_tools::get_ip_string_from_int32(m_conn_context.m_remote_ip ) << "] " << query_info.m_http_method_str << " " << query_info.m_URI); \
|
|
response.m_response_code = 200; \
|
|
response.m_response_comment = "Ok"; \
|
|
if(!handle_http_request_map(query_info, response, m_conn_context)) \
|
|
{response.m_response_code = 404;response.m_response_comment = "Not found";} \
|
|
return true; \
|
|
}
|
|
|
|
|
|
#define BEGIN_URI_MAP2() template<class t_context> bool handle_http_request_map(const epee::net_utils::http::http_request_info& query_info, \
|
|
epee::net_utils::http::http_response_info& response_info, \
|
|
t_context& m_conn_context) { \
|
|
bool handled = false; \
|
|
if(false) return true; //just a stub to have "else if"
|
|
|
|
#define MAP_URI2(pattern, callback) else if(std::string::npos != query_info.m_URI.find(pattern)) return callback(query_info, response_info, m_conn_context);
|
|
|
|
#define MAP_URI_AUTO_XML2(s_pattern, callback_f, command_type) //TODO: don't think i ever again will use xml - ambiguous and "overtagged" format
|
|
|
|
#define MAP_URI_AUTO_JON2_IF(s_pattern, callback_f, command_type, cond) \
|
|
else if((query_info.m_URI == s_pattern) && (cond)) \
|
|
{ \
|
|
handled = true; \
|
|
uint64_t ticks = misc_utils::get_tick_count(); \
|
|
boost::value_initialized<command_type::request> req; \
|
|
bool parse_res = epee::serialization::load_t_from_json(static_cast<command_type::request&>(req), query_info.m_body); \
|
|
CHECK_AND_ASSERT_MES(parse_res, false, "Failed to parse json: \r\n" << query_info.m_body); \
|
|
uint64_t ticks1 = epee::misc_utils::get_tick_count(); \
|
|
boost::value_initialized<command_type::response> resp;\
|
|
if(!callback_f(static_cast<command_type::request&>(req), static_cast<command_type::response&>(resp))) \
|
|
{ \
|
|
LOG_ERROR("Failed to " << #callback_f << "()"); \
|
|
response_info.m_response_code = 500; \
|
|
response_info.m_response_comment = "Internal Server Error"; \
|
|
return true; \
|
|
} \
|
|
uint64_t ticks2 = epee::misc_utils::get_tick_count(); \
|
|
epee::serialization::store_t_to_json(static_cast<command_type::response&>(resp), response_info.m_body); \
|
|
uint64_t ticks3 = epee::misc_utils::get_tick_count(); \
|
|
response_info.m_mime_tipe = "application/json"; \
|
|
response_info.m_header_info.m_content_type = " application/json"; \
|
|
MDEBUG( s_pattern << " processed with " << ticks1-ticks << "/"<< ticks2-ticks1 << "/" << ticks3-ticks2 << "ms"); \
|
|
}
|
|
|
|
#define MAP_URI_AUTO_JON2(s_pattern, callback_f, command_type) MAP_URI_AUTO_JON2_IF(s_pattern, callback_f, command_type, true)
|
|
|
|
#define MAP_URI_AUTO_BIN2(s_pattern, callback_f, command_type) \
|
|
else if(query_info.m_URI == s_pattern) \
|
|
{ \
|
|
handled = true; \
|
|
uint64_t ticks = misc_utils::get_tick_count(); \
|
|
boost::value_initialized<command_type::request> req; \
|
|
bool parse_res = epee::serialization::load_t_from_binary(static_cast<command_type::request&>(req), query_info.m_body); \
|
|
CHECK_AND_ASSERT_MES(parse_res, false, "Failed to parse bin body data, body size=" << query_info.m_body.size()); \
|
|
uint64_t ticks1 = misc_utils::get_tick_count(); \
|
|
boost::value_initialized<command_type::response> resp;\
|
|
if(!callback_f(static_cast<command_type::request&>(req), static_cast<command_type::response&>(resp))) \
|
|
{ \
|
|
LOG_ERROR("Failed to " << #callback_f << "()"); \
|
|
response_info.m_response_code = 500; \
|
|
response_info.m_response_comment = "Internal Server Error"; \
|
|
return true; \
|
|
} \
|
|
uint64_t ticks2 = misc_utils::get_tick_count(); \
|
|
epee::serialization::store_t_to_binary(static_cast<command_type::response&>(resp), response_info.m_body); \
|
|
uint64_t ticks3 = epee::misc_utils::get_tick_count(); \
|
|
response_info.m_mime_tipe = " application/octet-stream"; \
|
|
response_info.m_header_info.m_content_type = " application/octet-stream"; \
|
|
MDEBUG( s_pattern << "() processed with " << ticks1-ticks << "/"<< ticks2-ticks1 << "/" << ticks3-ticks2 << "ms"); \
|
|
}
|
|
|
|
#define CHAIN_URI_MAP2(callback) else {callback(query_info, response_info, m_conn_context);handled = true;}
|
|
|
|
#define END_URI_MAP2() return handled;}
|
|
|
|
|
|
#define BEGIN_JSON_RPC_MAP(uri) else if(query_info.m_URI == uri) \
|
|
{ \
|
|
uint64_t ticks = epee::misc_utils::get_tick_count(); \
|
|
epee::serialization::portable_storage ps; \
|
|
if(!ps.load_from_json(query_info.m_body)) \
|
|
{ \
|
|
boost::value_initialized<epee::json_rpc::error_response> rsp; \
|
|
static_cast<epee::json_rpc::error_response&>(rsp).error.code = -32700; \
|
|
static_cast<epee::json_rpc::error_response&>(rsp).error.message = "Parse error"; \
|
|
epee::serialization::store_t_to_json(static_cast<epee::json_rpc::error_response&>(rsp), response_info.m_body); \
|
|
return true; \
|
|
} \
|
|
epee::serialization::storage_entry id_; \
|
|
id_ = epee::serialization::storage_entry(std::string()); \
|
|
ps.get_value("id", id_, nullptr); \
|
|
std::string callback_name; \
|
|
if(!ps.get_value("method", callback_name, nullptr)) \
|
|
{ \
|
|
epee::json_rpc::error_response rsp; \
|
|
rsp.jsonrpc = "2.0"; \
|
|
rsp.error.code = -32600; \
|
|
rsp.error.message = "Invalid Request"; \
|
|
epee::serialization::store_t_to_json(static_cast<epee::json_rpc::error_response&>(rsp), response_info.m_body); \
|
|
return true; \
|
|
} \
|
|
if(false) return true; //just a stub to have "else if"
|
|
|
|
|
|
#define PREPARE_OBJECTS_FROM_JSON(command_type) \
|
|
handled = true; \
|
|
boost::value_initialized<epee::json_rpc::request<command_type::request> > req_; \
|
|
epee::json_rpc::request<command_type::request>& req = static_cast<epee::json_rpc::request<command_type::request>&>(req_);\
|
|
if(!req.load(ps)) \
|
|
{ \
|
|
epee::json_rpc::error_response fail_resp = AUTO_VAL_INIT(fail_resp); \
|
|
fail_resp.jsonrpc = "2.0"; \
|
|
fail_resp.id = req.id; \
|
|
fail_resp.error.code = -32602; \
|
|
fail_resp.error.message = "Invalid params"; \
|
|
epee::serialization::store_t_to_json(static_cast<epee::json_rpc::error_response&>(fail_resp), response_info.m_body); \
|
|
return true; \
|
|
} \
|
|
uint64_t ticks1 = epee::misc_utils::get_tick_count(); \
|
|
boost::value_initialized<epee::json_rpc::response<command_type::response, epee::json_rpc::dummy_error> > resp_; \
|
|
epee::json_rpc::response<command_type::response, epee::json_rpc::dummy_error>& resp = static_cast<epee::json_rpc::response<command_type::response, epee::json_rpc::dummy_error> &>(resp_); \
|
|
resp.jsonrpc = "2.0"; \
|
|
resp.id = req.id;
|
|
|
|
#define FINALIZE_OBJECTS_TO_JSON(method_name) \
|
|
uint64_t ticks2 = epee::misc_utils::get_tick_count(); \
|
|
epee::serialization::store_t_to_json(resp, response_info.m_body); \
|
|
uint64_t ticks3 = epee::misc_utils::get_tick_count(); \
|
|
response_info.m_mime_tipe = "application/json"; \
|
|
response_info.m_header_info.m_content_type = " application/json"; \
|
|
MDEBUG( query_info.m_URI << "[" << method_name << "] processed with " << ticks1-ticks << "/"<< ticks2-ticks1 << "/" << ticks3-ticks2 << "ms");
|
|
|
|
#define MAP_JON_RPC_WE_IF(method_name, callback_f, command_type, cond) \
|
|
else if((callback_name == method_name) && (cond)) \
|
|
{ \
|
|
PREPARE_OBJECTS_FROM_JSON(command_type) \
|
|
epee::json_rpc::error_response fail_resp = AUTO_VAL_INIT(fail_resp); \
|
|
fail_resp.jsonrpc = "2.0"; \
|
|
fail_resp.id = req.id; \
|
|
if(!callback_f(req.params, resp.result, fail_resp.error)) \
|
|
{ \
|
|
epee::serialization::store_t_to_json(static_cast<epee::json_rpc::error_response&>(fail_resp), response_info.m_body); \
|
|
return true; \
|
|
} \
|
|
FINALIZE_OBJECTS_TO_JSON(method_name) \
|
|
return true;\
|
|
}
|
|
|
|
#define MAP_JON_RPC_WE(method_name, callback_f, command_type) MAP_JON_RPC_WE_IF(method_name, callback_f, command_type, true)
|
|
|
|
#define MAP_JON_RPC_WERI(method_name, callback_f, command_type) \
|
|
else if(callback_name == method_name) \
|
|
{ \
|
|
PREPARE_OBJECTS_FROM_JSON(command_type) \
|
|
epee::json_rpc::error_response fail_resp = AUTO_VAL_INIT(fail_resp); \
|
|
fail_resp.jsonrpc = "2.0"; \
|
|
fail_resp.id = req.id; \
|
|
if(!callback_f(req.params, resp.result, fail_resp.error, m_conn_context, response_info)) \
|
|
{ \
|
|
epee::serialization::store_t_to_json(static_cast<epee::json_rpc::error_response&>(fail_resp), response_info.m_body); \
|
|
return true; \
|
|
} \
|
|
FINALIZE_OBJECTS_TO_JSON(method_name) \
|
|
return true;\
|
|
}
|
|
|
|
#define MAP_JON_RPC(method_name, callback_f, command_type) \
|
|
else if(callback_name == method_name) \
|
|
{ \
|
|
PREPARE_OBJECTS_FROM_JSON(command_type) \
|
|
if(!callback_f(req.params, resp.result)) \
|
|
{ \
|
|
epee::json_rpc::error_response fail_resp = AUTO_VAL_INIT(fail_resp); \
|
|
fail_resp.jsonrpc = "2.0"; \
|
|
fail_resp.id = req.id; \
|
|
fail_resp.error.code = -32603; \
|
|
fail_resp.error.message = "Internal error"; \
|
|
epee::serialization::store_t_to_json(static_cast<epee::json_rpc::error_response&>(fail_resp), response_info.m_body); \
|
|
return true; \
|
|
} \
|
|
FINALIZE_OBJECTS_TO_JSON(method_name) \
|
|
return true;\
|
|
}
|
|
|
|
#define END_JSON_RPC_MAP() \
|
|
epee::json_rpc::error_response rsp; \
|
|
rsp.id = id_; \
|
|
rsp.jsonrpc = "2.0"; \
|
|
rsp.error.code = -32601; \
|
|
rsp.error.message = "Method not found"; \
|
|
epee::serialization::store_t_to_json(static_cast<epee::json_rpc::error_response&>(rsp), response_info.m_body); \
|
|
return true; \
|
|
}
|
|
|
|
|