diff options
| -rw-r--r-- | .gitignore | 16 | ||||
| -rw-r--r-- | CMakeLists.txt | 31 | ||||
| -rw-r--r-- | src/common/util.cpp | 10 | ||||
| -rw-r--r-- | src/common/util.h | 41 | ||||
| -rw-r--r-- | src/common/varint.h | 112 | ||||
| -rw-r--r-- | src/daemon/daemon.cpp | 73 | ||||
| -rw-r--r-- | src/daemon/daemon_commands_handler.h | 10 | ||||
| -rw-r--r-- | src/p2p/net_node.inl | 2 | ||||
| -rw-r--r-- | src/simplewallet/simplewallet.cpp | 6 | ||||
| -rw-r--r-- | src/version.cmake | 26 | ||||
| -rw-r--r-- | src/version.h.in | 7 |
11 files changed, 214 insertions, 120 deletions
diff --git a/.gitignore b/.gitignore index 527864624..4f8766a43 100644 --- a/.gitignore +++ b/.gitignore @@ -1,7 +1,23 @@ .DS_Store +/doc /build /tags # vim swap files *.swp *.swo +TAGS +!TAGS/ +tags +!tags/ +gtags.files +GTAGS +GRTAGS +GPATH +cscope.files +cscope.out +cscope.in.out +cscope.po.out + + + diff --git a/CMakeLists.txt b/CMakeLists.txt index e93c278da..b80712737 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -30,9 +30,6 @@ cmake_minimum_required(VERSION 2.8.6) -set(VERSION "0.1") -# $Format:Packaged from commit %H%nset(COMMIT %h)%nset(REFS "%d")$ - set_property(GLOBAL PROPERTY USE_FOLDERS ON) set(CMAKE_CONFIGURATION_TYPES "Debug;Release") enable_testing() @@ -160,30 +157,16 @@ elseif(NOT MSVC) set(Boost_LIBRARIES "${Boost_LIBRARIES};rt;pthread") endif() -set(COMMIT_ID_IN_VERSION ON CACHE BOOL "Include commit ID in version") file(MAKE_DIRECTORY "${CMAKE_BINARY_DIR}/version") -if (NOT COMMIT_ID_IN_VERSION) - set(VERSION "${VERSION}-unknown") - configure_file("src/version.h.in" "version/version.h") - add_custom_target(version ALL) -elseif(DEFINED COMMIT) - string(REPLACE "." "\\." VERSION_RE "${VERSION}") - if(NOT REFS MATCHES "(\\(|, )tag: v${VERSION_RE}(\\)|, )") - set(VERSION "${VERSION}-g${COMMIT}") - endif() +find_package(Git QUIET) +if(Git_FOUND OR GIT_FOUND) + message(STATUS "Found Git: ${GIT_EXECUTABLE}") + add_custom_target(version ALL "${CMAKE_COMMAND}" "-D" "GIT=${GIT_EXECUTABLE}" "-D" "TO=${CMAKE_BINARY_DIR}/version/version.h" "-P" "src/version.cmake" WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}") +else() + message(STATUS "WARNING: Git was not found!") + set(VERSIONTAG "unknown") configure_file("src/version.h.in" "version/version.h") add_custom_target(version ALL) -else() - find_package(Git QUIET) - if(Git_FOUND OR GIT_FOUND) - message(STATUS "Found Git: ${GIT_EXECUTABLE}") - add_custom_target(version ALL "${CMAKE_COMMAND}" "-D" "VERSION=${VERSION}" "-D" "GIT=${GIT_EXECUTABLE}" "-D" "TO=${CMAKE_BINARY_DIR}/version/version.h" "-P" "src/version.cmake" WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}") - else() - message(STATUS "WARNING: Git was not found!") - set(VERSION "${VERSION}-unknown") - configure_file("src/version.h.in" "version/version.h") - add_custom_target(version ALL) - endif() endif() add_subdirectory(external) diff --git a/src/common/util.cpp b/src/common/util.cpp index e5276d1e4..0ad1f0791 100644 --- a/src/common/util.cpp +++ b/src/common/util.cpp @@ -47,7 +47,7 @@ using namespace epee; namespace tools { - std::function<void(void)> signal_handler::m_handler; + std::function<void(void)> signal_handler::m_handler; #ifdef WIN32 std::string get_windows_version_display_string() @@ -313,17 +313,19 @@ std::string get_nix_version_display_string() return ""; } #endif - + std::string get_default_data_dir() { - //namespace fs = boost::filesystem; + /* Please for the love of god refactor the ifdefs out of this */ + + // namespace fs = boost::filesystem; // Windows < Vista: C:\Documents and Settings\Username\Application Data\CRYPTONOTE_NAME // Windows >= Vista: C:\Users\Username\AppData\Roaming\CRYPTONOTE_NAME // Mac: ~/Library/Application Support/CRYPTONOTE_NAME // Unix: ~/.CRYPTONOTE_NAME std::string config_folder; + #ifdef WIN32 - // Windows config_folder = get_special_folder_path(CSIDL_APPDATA, true) + "/" + CRYPTONOTE_NAME; #else std::string pathRet; diff --git a/src/common/util.h b/src/common/util.h index 92ce7177a..51f0dad90 100644 --- a/src/common/util.h +++ b/src/common/util.h @@ -39,11 +39,41 @@ #include "misc_language.h" #include "p2p/p2p_protocol_defs.h" +/*! \brief Various Tools + * + * + * + */ namespace tools { + /*! \brief Returns the default data directory. + * + * \details Windows < Vista: C:\\Documents and Settings\\Username\\Application Data\\CRYPTONOTE_NAME + * + * Windows >= Vista: C:\\Users\\Username\\AppData\\Roaming\\CRYPTONOTE_NAME + * + * Mac: ~/Library/Application Support/CRYPTONOTE_NAME + * + * Unix: ~/.CRYPTONOTE_NAME + */ std::string get_default_data_dir(); + + /*! \brief Returns the OS version string + * + * \details This is a wrapper around the primitives + * get_windows_version_display_string() and + * get_nix_version_display_string() + */ std::string get_os_version_string(); + + /*! \brief creates directories for a path + * + * wrapper around boost::filesyste::create_directories. + * (ensure-directory-exists): greenspun's tenth rule in action! + */ bool create_directories_if_necessary(const std::string& path); + /*! \brief std::rename wrapper for nix and something strange for windows. + */ std::error_code replace_file(const std::string& replacement_name, const std::string& replaced_name); inline crypto::hash get_proof_of_trust_hash(const nodetool::proof_of_trust& pot) @@ -54,10 +84,12 @@ namespace tools return crypto::cn_fast_hash(s.data(), s.size()); } - + /*! \brief Defines a signal handler for win32 and *nix + */ class signal_handler { public: + /*! \brief installs a signal handler */ template<typename T> static bool install(T t) { @@ -69,6 +101,7 @@ namespace tools } return r; #else + /* Only blocks SIGINT and SIGTERM */ signal(SIGINT, posix_handler); signal(SIGTERM, posix_handler); m_handler = t; @@ -78,12 +111,12 @@ namespace tools private: #if defined(WIN32) + /*! \brief Handler for win */ static BOOL WINAPI win_handler(DWORD type) { if (CTRL_C_EVENT == type || CTRL_BREAK_EVENT == type) { handle_signal(); - return TRUE; } else { @@ -93,12 +126,14 @@ namespace tools return TRUE; } #else + /*! \brief handler for NIX */ static void posix_handler(int /*type*/) { handle_signal(); } #endif + /*! \brief calles m_handler */ static void handle_signal() { static std::mutex m_mutex; @@ -106,7 +141,7 @@ namespace tools m_handler(); } - private: + /*! \brief where the installed handler is stored */ static std::function<void(void)> m_handler; }; } diff --git a/src/common/varint.h b/src/common/varint.h index dcb70d686..5a73c2746 100644 --- a/src/common/varint.h +++ b/src/common/varint.h @@ -35,54 +35,94 @@ #include <utility> #include <sstream> #include <string> +/*! \file varint.h + * \breif provides the implementation of varint's + * + * The representation of varints is rather odd. The first bit of each + * octet is significant, it represents wheter there is another part + * waiting to be read. For example 0x8002 would return 0x200, even + * though 0x02 does not have its msb set. The actual way they are read + * is as follows: Strip the msb of each byte, then from left to right, + * read in what remains, placing it in reverse, into the buffer. Thus, + * the following bit stream: 0xff02 would return 0x027f. 0xff turns + * into 0x7f, is placed on the beggining of the buffer, then 0x02 is + * unchanged, since its msb is not set, and placed at the end of the + * buffer. + */ namespace tools { - template<typename OutputIt, typename T> - typename std::enable_if<std::is_integral<T>::value && std::is_unsigned<T>::value, void>::type - write_varint(OutputIt &&dest, T i) { - while (i >= 0x80) { - *dest++ = (static_cast<char>(i) & 0x7f) | 0x80; - i >>= 7; - } - *dest++ = static_cast<char>(i); + /*! \brief Error codes for varint + */ + enum { + /* \brief Represents the overflow error */ + EVARINT_OVERFLOW = -1, + /* \brief Represents a non conical represnetation */ + EVARINT_REPRESENT = -2, + }; + + /*! \brief writes a varint to a stream. + */ + template<typename OutputIt, typename T> + /* Requires T to be both an integral type and unsigned, should be a compile error if it is not */ + typename std::enable_if<std::is_integral<T>::value && std::is_unsigned<T>::value, void>::type + write_varint(OutputIt &&dest, T i) { + /* Make sure that there is one after this */ + while (i >= 0x80) { + *dest = (static_cast<char>(i) & 0x7f) | 0x80; + ++dest; + i >>= 7; /* I should be in multiples of 7, this should just get the next part */ } + /* writes the last one to dest */ + *dest = static_cast<char>(i); + dest++; /* Seems kinda pointless... */ + } - template<typename t_type> - std::string get_varint_data(const t_type& v) + /*! \brief Returns the string that represents the varint + */ + template<typename T> + std::string get_varint_data(const T& v) { std::stringstream ss; write_varint(std::ostreambuf_iterator<char>(ss), v); return ss.str(); } - - template<int bits, typename InputIt, typename T> + /*! \brief reads in the varint that is pointed to by InputIt into write + */ + template<int bits, typename InputIt, typename T> typename std::enable_if<std::is_integral<T>::value && std::is_unsigned<T>::value && 0 <= bits && bits <= std::numeric_limits<T>::digits, int>::type - read_varint(InputIt &&first, InputIt &&last, T &i) { - int read = 0; - i = 0; - for (int shift = 0;; shift += 7) { - if (first == last) { - return read; // End of input. - } - unsigned char byte = *first++; - ++read; - if (shift + 7 >= bits && byte >= 1 << (bits - shift)) { - return -1; // Overflow. - } - if (byte == 0 && shift != 0) { - return -2; // Non-canonical representation. - } - i |= static_cast<T>(byte & 0x7f) << shift; - if ((byte & 0x80) == 0) { - break; - } - } - return read; + read_varint(InputIt &&first, InputIt &&last, T &write) { + int read = 0; + write = 0; + for (int shift = 0;; shift += 7) { + if (first == last) { + return read; + } + unsigned char byte = *first; + ++first; + ++read; + if (shift + 7 >= bits && byte >= 1 << (bits - shift)) { + return EVARINT_OVERFLOW; + } + if (byte == 0 && shift != 0) { + return EVARINT_REPRESENT; + } + + write |= static_cast<T>(byte & 0x7f) << shift; /* Does the actualy placing into write, stripping the first bit */ + + /* If there is no next */ + if ((byte & 0x80) == 0) { + break; + } } + return read; + } - template<typename InputIt, typename T> + /*! \brief Wrapper around the other read_varint, + * Sets template parameters for you. + */ + template<typename InputIt, typename T> int read_varint(InputIt &&first, InputIt &&last, T &i) { - return read_varint<std::numeric_limits<T>::digits, InputIt, T>(std::move(first), std::move(last), i); - } + return read_varint<std::numeric_limits<T>::digits, InputIt, T>(std::move(first), std::move(last), i); + } } diff --git a/src/daemon/daemon.cpp b/src/daemon/daemon.cpp index 461068837..187970359 100644 --- a/src/daemon/daemon.cpp +++ b/src/daemon/daemon.cpp @@ -29,7 +29,7 @@ // Parts of this file are originally copyright (c) 2012-2013 The Cryptonote developers // node.cpp : Defines the entry point for the console application. -// +// Does this file exist? #include "include_base_utils.h" @@ -64,11 +64,42 @@ namespace const command_line::arg_descriptor<bool> arg_console = {"no-console", "Disable daemon console commands"}; } -bool command_line_preprocessor(const boost::program_options::variables_map& vm); +bool command_line_preprocessor(const boost::program_options::variables_map& vm) +{ + bool exit = false; + if (command_line::get_arg(vm, command_line::arg_version)) + { + std::cout << CRYPTONOTE_NAME << " v" << MONERO_VERSION_FULL << ENDL; + exit = true; + } + if (command_line::get_arg(vm, arg_os_version)) + { + std::cout << "OS: " << tools::get_os_version_string() << ENDL; + exit = true; + } + + if (exit) + { + return true; + } + + int new_log_level = command_line::get_arg(vm, arg_log_level); + if(new_log_level < LOG_LEVEL_MIN || new_log_level > LOG_LEVEL_MAX) + { + LOG_PRINT_L0("Wrong log level value: "); + } + else if (log_space::get_set_log_detalisation_level(false) != new_log_level) + { + log_space::get_set_log_detalisation_level(true, new_log_level); + LOG_PRINT_L0("LOG_LEVEL set to " << new_log_level); + } + + return false; +} int main(int argc, char* argv[]) { - + string_tools::set_module_name_and_folder(argv[0]); #ifdef WIN32 _CrtSetDbgFlag ( _CRTDBG_ALLOC_MEM_DF | _CRTDBG_LEAK_CHECK_DF ); @@ -109,7 +140,7 @@ int main(int argc, char* argv[]) if (command_line::get_arg(vm, command_line::arg_help)) { - std::cout << CRYPTONOTE_NAME << " v" << PROJECT_VERSION_LONG << ENDL << ENDL; + std::cout << CRYPTONOTE_NAME << " v" << MONERO_VERSION_FULL << ENDL << ENDL; std::cout << desc_options << std::endl; return false; } @@ -144,7 +175,7 @@ int main(int argc, char* argv[]) log_dir = log_file_path.has_parent_path() ? log_file_path.parent_path().string() : log_space::log_singletone::get_default_log_folder(); log_space::log_singletone::add_logger(LOGGER_FILE, log_file_path.filename().string().c_str(), log_dir.c_str()); - LOG_PRINT_L0(CRYPTONOTE_NAME << " v" << PROJECT_VERSION_LONG); + LOG_PRINT_L0(CRYPTONOTE_NAME << " v" << MONERO_VERSION_FULL); if (command_line_preprocessor(vm)) { @@ -235,35 +266,3 @@ int main(int argc, char* argv[]) CATCH_ENTRY_L0("main", 1); } -bool command_line_preprocessor(const boost::program_options::variables_map& vm) -{ - bool exit = false; - if (command_line::get_arg(vm, command_line::arg_version)) - { - std::cout << CRYPTONOTE_NAME << " v" << PROJECT_VERSION_LONG << ENDL; - exit = true; - } - if (command_line::get_arg(vm, arg_os_version)) - { - std::cout << "OS: " << tools::get_os_version_string() << ENDL; - exit = true; - } - - if (exit) - { - return true; - } - - int new_log_level = command_line::get_arg(vm, arg_log_level); - if(new_log_level < LOG_LEVEL_MIN || new_log_level > LOG_LEVEL_MAX) - { - LOG_PRINT_L0("Wrong log level value: "); - } - else if (log_space::get_set_log_detalisation_level(false) != new_log_level) - { - log_space::get_set_log_detalisation_level(true, new_log_level); - LOG_PRINT_L0("LOG_LEVEL set to " << new_log_level); - } - - return false; -} diff --git a/src/daemon/daemon_commands_handler.h b/src/daemon/daemon_commands_handler.h index 165cded21..5dc0be7dd 100644 --- a/src/daemon/daemon_commands_handler.h +++ b/src/daemon/daemon_commands_handler.h @@ -28,6 +28,8 @@ // // Parts of this file are originally copyright (c) 2012-2013 The Cryptonote developers + +/* This isn't a header file, may want to refactor this... */ #pragma once #include <boost/lexical_cast.hpp> @@ -39,7 +41,11 @@ #include "crypto/hash.h" #include "version.h" - +/*! + * \brief I don't really know right now + * + * + */ class daemon_cmmands_handler { nodetool::node_server<cryptonote::t_cryptonote_protocol_handler<cryptonote::core> >& m_srv; @@ -83,7 +89,7 @@ private: std::string get_commands_str() { std::stringstream ss; - ss << CRYPTONOTE_NAME << " v" << PROJECT_VERSION_LONG << ENDL; + ss << CRYPTONOTE_NAME << " v" << MONERO_VERSION_FULL << ENDL; ss << "Commands: " << ENDL; std::string usage = m_cmd_binder.get_usage(); boost::replace_all(usage, "\n", "\n "); diff --git a/src/p2p/net_node.inl b/src/p2p/net_node.inl index 626e227bc..ee401ce42 100644 --- a/src/p2p/net_node.inl +++ b/src/p2p/net_node.inl @@ -866,7 +866,7 @@ namespace nodetool } rsp.connections_count = m_net_server.get_config_object().get_connections_count(); rsp.incoming_connections_count = rsp.connections_count - get_outgoing_connections_count(); - rsp.version = PROJECT_VERSION_LONG; + rsp.version = MONERO_VERSION_FULL; rsp.os_version = tools::get_os_version_string(); m_payload_handler.get_stat_info(rsp.payload_info); return 1; diff --git a/src/simplewallet/simplewallet.cpp b/src/simplewallet/simplewallet.cpp index 960b1be9d..e822e6636 100644 --- a/src/simplewallet/simplewallet.cpp +++ b/src/simplewallet/simplewallet.cpp @@ -1090,14 +1090,14 @@ int main(int argc, char* argv[]) if (command_line::get_arg(vm, command_line::arg_help)) { - success_msg_writer() << CRYPTONOTE_NAME << " wallet v" << PROJECT_VERSION_LONG; + success_msg_writer() << CRYPTONOTE_NAME << " wallet v" << MONERO_VERSION_FULL; success_msg_writer() << "Usage: simplewallet [--wallet-file=<file>|--generate-new-wallet=<file>] [--daemon-address=<host>:<port>] [<COMMAND>]"; success_msg_writer() << desc_all << '\n' << w.get_commands_str(); return false; } else if (command_line::get_arg(vm, command_line::arg_version)) { - success_msg_writer() << CRYPTONOTE_NAME << " wallet v" << PROJECT_VERSION_LONG; + success_msg_writer() << CRYPTONOTE_NAME << " wallet v" << MONERO_VERSION_FULL; return false; } @@ -1116,7 +1116,7 @@ int main(int argc, char* argv[]) log_space::log_singletone::get_default_log_file().c_str(), log_space::log_singletone::get_default_log_folder().c_str(), LOG_LEVEL_4); - message_writer(epee::log_space::console_color_white, true) << CRYPTONOTE_NAME << " wallet v" << PROJECT_VERSION_LONG; + message_writer(epee::log_space::console_color_white, true) << CRYPTONOTE_NAME << " wallet v" << MONERO_VERSION_FULL; if(command_line::has_arg(vm, arg_log_level)) { diff --git a/src/version.cmake b/src/version.cmake index 880224dc6..090ca690b 100644 --- a/src/version.cmake +++ b/src/version.cmake @@ -1,11 +1,25 @@ -execute_process(COMMAND "${GIT}" describe --dirty --match "v${VERSION}" RESULT_VARIABLE RET OUTPUT_VARIABLE DESCRIPTION OUTPUT_STRIP_TRAILING_WHITESPACE) +execute_process(COMMAND "${GIT}" rev-parse --short HEAD RESULT_VARIABLE RET OUTPUT_VARIABLE COMMIT OUTPUT_STRIP_TRAILING_WHITESPACE) + if(RET) - message(WARNING "Cannot determine current revision. Make sure that you are building either from a Git working tree or from a source archive.") - set(VERSION "${COMMIT}") + message(WARNING "Cannot determine current commit. Make sure that you are building either from a Git working tree or from a source archive.") + set(VERSIONTAG "unknown") configure_file("src/version.h.in" "${TO}") else() - string(REGEX MATCH "([0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f])?(-dirty)? $" COMMIT "${DESCRIPTION} ") - string(STRIP "${COMMIT}" COMMIT) - set(VERSION "${COMMIT}") + message(STATUS "You are currently on commit ${COMMIT}") + execute_process(COMMAND "${GIT}" show-ref --tags -d --abbrev COMMAND awk "END{print $1}" RESULT_VARIABLE RET OUTPUT_VARIABLE TAGGEDCOMMIT OUTPUT_STRIP_TRAILING_WHITESPACE) + if(RET) + message(WARNING "Cannot determine most recent tag. Make sure that you are building either from a Git working tree or from a source archive.") + set(VERSIONTAG "${COMMIT}") + else() + message(STATUS "The most recent tag was at ${TAGGEDCOMMIT}") + if(${COMMIT} MATCHES ${TAGGEDCOMMIT}) + message(STATUS "You are building a tagged release") + set(VERSIONTAG "release") + else() + message(STATUS "You are ahead or behind of a tagged release") + set(VERSIONTAG "${COMMIT}") + endif() + endif() + configure_file("src/version.h.in" "${TO}") endif()
\ No newline at end of file diff --git a/src/version.h.in b/src/version.h.in index 7ff77150e..9862431de 100644 --- a/src/version.h.in +++ b/src/version.h.in @@ -1,4 +1,3 @@ -#define BUILD_COMMIT_ID "@VERSION@" -#define PROJECT_VERSION "0.8.8" -#define PROJECT_VERSION_BUILD_NO "4" -#define PROJECT_VERSION_LONG PROJECT_VERSION "." PROJECT_VERSION_BUILD_NO "(" BUILD_COMMIT_ID ")" +#define MONERO_VERSION_TAG "@VERSIONTAG@" +#define MONERO_VERSION "0.8.8.4" +#define MONERO_VERSION_FULL MONERO_VERSION "-" MONERO_VERSION_TAG |