monero/src/common/util.h

162 lines
4.8 KiB
C
Raw Normal View History

2015-12-31 06:39:56 +00:00
// Copyright (c) 2014-2016, The Monero Project
2014-07-23 13:03:52 +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.
//
// Parts of this file are originally copyright (c) 2012-2013 The Cryptonote developers
2014-03-03 22:07:58 +00:00
#pragma once
2014-03-20 11:46:11 +00:00
#include <mutex>
2014-03-03 22:07:58 +00:00
#include <system_error>
#include <boost/filesystem.hpp>
#include "crypto/crypto.h"
#include "crypto/hash.h"
#include "misc_language.h"
#include "p2p/p2p_protocol_defs.h"
2014-09-10 00:18:23 +00:00
/*! \brief Various Tools
*
*
*
*/
2014-03-03 22:07:58 +00:00
namespace tools
{
2014-09-10 00:18:23 +00:00
/*! \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
*/
2014-03-03 22:07:58 +00:00
std::string get_default_data_dir();
2014-09-10 00:18:23 +00:00
2015-03-20 20:40:54 +00:00
#ifdef WIN32
/**
* @brief
*
* @param nfolder
* @param iscreate
*
* @return
*/
std::string get_special_folder_path(int nfolder, bool iscreate);
#endif
2014-09-11 14:36:39 +00:00
/*! \brief Returns the OS version string
2014-09-10 00:18:23 +00:00
*
* \details This is a wrapper around the primitives
* get_windows_version_display_string() and
* get_nix_version_display_string()
*/
2014-03-03 22:07:58 +00:00
std::string get_os_version_string();
2014-09-10 00:18:23 +00:00
2014-09-11 14:36:39 +00:00
/*! \brief creates directories for a path
2014-09-10 00:18:23 +00:00
*
* wrapper around boost::filesyste::create_directories.
* (ensure-directory-exists): greenspun's tenth rule in action!
*/
2014-03-03 22:07:58 +00:00
bool create_directories_if_necessary(const std::string& path);
2014-09-10 00:18:23 +00:00
/*! \brief std::rename wrapper for nix and something strange for windows.
*/
2014-03-03 22:07:58 +00:00
std::error_code replace_file(const std::string& replacement_name, const std::string& replaced_name);
bool sanitize_locale();
2014-03-03 22:07:58 +00:00
inline crypto::hash get_proof_of_trust_hash(const nodetool::proof_of_trust& pot)
{
std::string s;
s.append(reinterpret_cast<const char*>(&pot.peer_id), sizeof(pot.peer_id));
s.append(reinterpret_cast<const char*>(&pot.time), sizeof(pot.time));
return crypto::cn_fast_hash(s.data(), s.size());
}
2014-03-20 11:46:11 +00:00
2014-09-11 14:36:39 +00:00
/*! \brief Defines a signal handler for win32 and *nix
2014-09-10 00:18:23 +00:00
*/
2014-03-20 11:46:11 +00:00
class signal_handler
{
public:
2014-09-10 00:18:23 +00:00
/*! \brief installs a signal handler */
2014-03-20 11:46:11 +00:00
template<typename T>
static bool install(T t)
{
#if defined(WIN32)
bool r = TRUE == ::SetConsoleCtrlHandler(&win_handler, TRUE);
if (r)
{
m_handler = t;
}
return r;
#else
2014-09-10 00:18:23 +00:00
/* Only blocks SIGINT and SIGTERM */
2014-03-20 11:46:11 +00:00
signal(SIGINT, posix_handler);
signal(SIGTERM, posix_handler);
m_handler = t;
return true;
#endif
}
private:
#if defined(WIN32)
2014-09-11 14:36:39 +00:00
/*! \brief Handler for win */
2014-05-03 16:19:43 +00:00
static BOOL WINAPI win_handler(DWORD type)
2014-03-20 11:46:11 +00:00
{
if (CTRL_C_EVENT == type || CTRL_BREAK_EVENT == type)
{
handle_signal(type);
2014-03-20 11:46:11 +00:00
}
else
{
LOG_PRINT_RED_L0("Got control signal " << type << ". Exiting without saving...");
return FALSE;
}
return TRUE;
}
#else
2014-09-11 14:36:39 +00:00
/*! \brief handler for NIX */
static void posix_handler(int type)
2014-03-20 11:46:11 +00:00
{
handle_signal(type);
2014-03-20 11:46:11 +00:00
}
#endif
2014-09-11 14:36:39 +00:00
/*! \brief calles m_handler */
static void handle_signal(int type)
2014-03-20 11:46:11 +00:00
{
2014-09-11 14:14:05 +00:00
static std::mutex m_mutex;
std::unique_lock<std::mutex> lock(m_mutex);
m_handler(type);
2014-03-20 11:46:11 +00:00
}
2014-09-11 14:36:39 +00:00
/*! \brief where the installed handler is stored */
static std::function<void(int)> m_handler;
2014-03-20 11:46:11 +00:00
};
2014-03-03 22:07:58 +00:00
}