2017-02-21 17:38:18 +00:00
// Copyright (c) 2014-2017, The Monero Project
2016-11-09 03:55:41 +00:00
//
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without modification, are
// permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice, this list of
// conditions and the following disclaimer.
//
// 2. 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.
//
// 3. Neither the name of the copyright holder 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 HOLDER OR CONTRIBUTORS 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.
# include "wallet/wallet_args.h"
# include <boost/filesystem/path.hpp>
# include <boost/format.hpp>
# include "common/i18n.h"
# include "common/scoped_message_writer.h"
# include "common/util.h"
# include "misc_log_ex.h"
# include "string_tools.h"
# include "version.h"
# if defined(WIN32)
# include <crtdbg.h>
# endif
Change logging to easylogging++
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.
2017-01-01 16:34:23 +00:00
# undef MONERO_DEFAULT_LOG_CATEGORY
# define MONERO_DEFAULT_LOG_CATEGORY "wallet.wallet2"
2016-11-09 03:55:41 +00:00
// workaround for a suspected bug in pthread/kernel on MacOS X
# ifdef __APPLE__
# define DEFAULT_MAX_CONCURRENCY 1
# else
# define DEFAULT_MAX_CONCURRENCY 0
# endif
namespace wallet_args
{
// Create on-demand to prevent static initialization order fiasco issues.
command_line : : arg_descriptor < std : : string > arg_generate_from_json ( )
{
return { " generate-from-json " , wallet_args : : tr ( " Generate wallet from JSON format file " ) , " " } ;
}
command_line : : arg_descriptor < std : : string > arg_wallet_file ( )
{
return { " wallet-file " , wallet_args : : tr ( " Use wallet <arg> " ) , " " } ;
}
const char * tr ( const char * str )
{
return i18n_translate ( str , " wallet_args " ) ;
}
boost : : optional < boost : : program_options : : variables_map > main (
int argc , char * * argv ,
const char * const usage ,
boost : : program_options : : options_description desc_params ,
2017-01-28 11:37:21 +00:00
const boost : : program_options : : positional_options_description & positional_options ,
2017-02-26 22:59:46 +00:00
const char * default_log_name ,
2017-01-28 11:37:21 +00:00
bool log_to_console )
2016-11-09 03:55:41 +00:00
{
namespace bf = boost : : filesystem ;
namespace po = boost : : program_options ;
# ifdef WIN32
_CrtSetDbgFlag ( _CRTDBG_ALLOC_MEM_DF | _CRTDBG_LEAK_CHECK_DF ) ;
# endif
Change logging to easylogging++
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.
2017-01-01 16:34:23 +00:00
const command_line : : arg_descriptor < std : : string > arg_log_level = { " log-level " , " 0-4 or categories " , " " } ;
2016-11-09 03:55:41 +00:00
const command_line : : arg_descriptor < uint32_t > arg_max_concurrency = { " max-concurrency " , wallet_args : : tr ( " Max number of threads to use for a parallel job " ) , DEFAULT_MAX_CONCURRENCY } ;
const command_line : : arg_descriptor < std : : string > arg_log_file = { " log-file " , wallet_args : : tr ( " Specify log file " ) , " " } ;
2017-03-12 20:45:59 +00:00
const command_line : : arg_descriptor < std : : string > arg_config_file = { " config-file " , wallet_args : : tr ( " Config file " ) , " " , true } ;
2016-11-09 03:55:41 +00:00
std : : string lang = i18n_get_language ( ) ;
tools : : sanitize_locale ( ) ;
tools : : set_strict_default_file_permissions ( true ) ;
epee : : string_tools : : set_module_name_and_folder ( argv [ 0 ] ) ;
po : : options_description desc_general ( wallet_args : : tr ( " General options " ) ) ;
command_line : : add_arg ( desc_general , command_line : : arg_help ) ;
command_line : : add_arg ( desc_general , command_line : : arg_version ) ;
Change logging to easylogging++
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.
2017-01-01 16:34:23 +00:00
command_line : : add_arg ( desc_params , arg_log_file , " " ) ;
2016-11-09 03:55:41 +00:00
command_line : : add_arg ( desc_params , arg_log_level ) ;
command_line : : add_arg ( desc_params , arg_max_concurrency ) ;
2017-03-12 20:45:59 +00:00
command_line : : add_arg ( desc_params , arg_config_file ) ;
2016-11-09 03:55:41 +00:00
i18n_set_language ( " translations " , " monero " , lang ) ;
po : : options_description desc_all ;
desc_all . add ( desc_general ) . add ( desc_params ) ;
po : : variables_map vm ;
bool r = command_line : : handle_error_helper ( desc_all , [ & ] ( )
{
2017-02-26 22:59:46 +00:00
auto parser = po : : command_line_parser ( argc , argv ) . options ( desc_all ) . positional ( positional_options ) ;
2016-11-09 03:55:41 +00:00
po : : store ( parser . run ( ) , vm ) ;
2017-03-12 20:45:59 +00:00
2017-09-10 13:12:32 +00:00
if ( command_line : : get_arg ( vm , command_line : : arg_help ) )
{
tools : : msg_writer ( ) < < " Monero ' " < < MONERO_RELEASE_NAME < < " ' (v " < < MONERO_VERSION_FULL < < " ) " < < ENDL ;
tools : : msg_writer ( ) < < wallet_args : : tr ( " This is the command line monero wallet. It needs to connect to a monero \n "
" daemon to work correctly. " ) < < ENDL ;
tools : : msg_writer ( ) < < wallet_args : : tr ( " Usage: " ) < < ENDL < < " " < < usage ;
tools : : msg_writer ( ) < < desc_all ;
return false ;
}
else if ( command_line : : get_arg ( vm , command_line : : arg_version ) )
{
tools : : msg_writer ( ) < < " Monero ' " < < MONERO_RELEASE_NAME < < " ' (v " < < MONERO_VERSION_FULL < < " ) " ;
return false ;
}
2017-03-12 20:45:59 +00:00
if ( command_line : : has_arg ( vm , arg_config_file ) )
{
std : : string config = command_line : : get_arg ( vm , arg_config_file ) ;
bf : : path config_path ( config ) ;
boost : : system : : error_code ec ;
if ( bf : : exists ( config_path , ec ) )
{
po : : store ( po : : parse_config_file < char > ( config_path . string < std : : string > ( ) . c_str ( ) , desc_params ) , vm ) ;
}
else
{
tools : : fail_msg_writer ( ) < < wallet_args : : tr ( " Can't find config file " ) < < config ;
return false ;
}
}
2016-11-09 03:55:41 +00:00
po : : notify ( vm ) ;
return true ;
} ) ;
if ( ! r )
return boost : : none ;
2017-02-26 22:59:46 +00:00
std : : string log_path ;
if ( ! vm [ " log-file " ] . defaulted ( ) )
log_path = command_line : : get_arg ( vm , arg_log_file ) ;
else
log_path = mlog_get_default_log_path ( default_log_name ) ;
mlog_configure ( log_path , log_to_console ) ;
if ( ! vm [ " log-level " ] . defaulted ( ) )
{
mlog_set_log ( command_line : : get_arg ( vm , arg_log_level ) . c_str ( ) ) ;
}
2016-11-09 03:55:41 +00:00
if ( command_line : : has_arg ( vm , arg_max_concurrency ) )
tools : : set_max_concurrency ( command_line : : get_arg ( vm , arg_max_concurrency ) ) ;
Change logging to easylogging++
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.
2017-01-01 16:34:23 +00:00
tools : : scoped_message_writer ( epee : : console_color_white , true ) < < " Monero ' " < < MONERO_RELEASE_NAME < < " ' (v " < < MONERO_VERSION_FULL < < " ) " ;
2016-11-09 03:55:41 +00:00
Change logging to easylogging++
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.
2017-01-01 16:34:23 +00:00
if ( ! vm [ " log-level " ] . defaulted ( ) )
MINFO ( " Setting log level = " < < command_line : : get_arg ( vm , arg_log_level ) ) ;
else
MINFO ( " Setting log levels = " < < getenv ( " MONERO_LOGS " ) ) ;
MINFO ( wallet_args : : tr ( " Logging to: " ) < < log_path ) ;
tools : : scoped_message_writer ( epee : : console_color_white , true ) < < boost : : format ( wallet_args : : tr ( " Logging to %s " ) ) % log_path ;
2016-11-09 03:55:41 +00:00
return { std : : move ( vm ) } ;
}
}
