icinga2/lib/base/utility.cpp

500 lines
11 KiB
C++
Raw Normal View History

/******************************************************************************
* Icinga 2 *
* Copyright (C) 2012 Icinga Development Team (http://www.icinga.org/) *
* *
* This program is free software; you can redistribute it and/or *
* modify it under the terms of the GNU General Public License *
* as published by the Free Software Foundation; either version 2 *
* of the License, or (at your option) any later version. *
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program; if not, write to the Free Software Foundation *
2012-05-11 13:33:57 +02:00
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. *
******************************************************************************/
2013-03-16 21:18:53 +01:00
#include "base/utility.h"
#include "base/application.h"
#include "base/logger_fwd.h"
#include "base/exception.h"
#include <mmatch.h>
2013-03-15 18:21:29 +01:00
#include <boost/uuid/uuid.hpp>
#include <boost/uuid/uuid_generators.hpp>
#include <boost/uuid/uuid_io.hpp>
#include <boost/lexical_cast.hpp>
#include <boost/function.hpp>
2013-03-16 21:18:53 +01:00
#include <boost/foreach.hpp>
#if HAVE_GCC_ABI_DEMANGLE
# include <cxxabi.h>
#endif /* HAVE_GCC_ABI_DEMANGLE */
2012-04-22 16:45:31 +02:00
using namespace icinga;
2013-03-25 18:36:15 +01:00
boost::thread_specific_ptr<String> Utility::m_ThreadName;
2012-07-11 20:55:46 +02:00
/**
2012-09-27 09:38:28 +02:00
* Demangles a symbol name.
2012-07-11 20:55:46 +02:00
*
2012-09-27 09:38:28 +02:00
* @param sym The symbol name.
* @returns A human-readable version of the symbol name.
2012-07-11 20:55:46 +02:00
*/
2012-09-27 09:38:28 +02:00
String Utility::DemangleSymbolName(const String& sym)
2012-07-11 20:55:46 +02:00
{
2012-09-27 09:38:28 +02:00
String result = sym;
2012-07-11 20:55:46 +02:00
#if HAVE_GCC_ABI_DEMANGLE
2012-07-11 20:55:46 +02:00
int status;
2012-09-27 09:38:28 +02:00
char *realname = abi::__cxa_demangle(sym.CStr(), 0, 0, &status);
2012-07-11 20:55:46 +02:00
if (realname != NULL) {
2012-09-27 09:38:28 +02:00
result = String(realname);
2012-07-11 20:55:46 +02:00
free(realname);
}
#endif /* HAVE_GCC_ABI_DEMANGLE */
2012-09-27 09:38:28 +02:00
return result;
2012-07-11 20:55:46 +02:00
}
2012-09-27 09:38:28 +02:00
/**
* Returns a human-readable type name of a type_info object.
*
* @param ti A type_info object.
* @returns The type name of the object.
*/
2013-03-16 21:18:53 +01:00
String Utility::GetTypeName(const std::type_info& ti)
2012-09-27 09:38:28 +02:00
{
return DemangleSymbolName(ti.name());
}
2012-07-11 20:55:46 +02:00
/**
* Performs wildcard pattern matching.
*
* @param pattern The wildcard pattern.
* @param text The String that should be checked.
* @returns true if the wildcard pattern matches, false otherwise.
*/
2013-02-02 09:19:49 +01:00
bool Utility::Match(const String& pattern, const String& text)
{
return (match(pattern.CStr(), text.CStr()) == 0);
}
/**
* Returns the directory component of a path. See dirname(3) for details.
*
* @param path The full path.
* @returns The directory.
*/
String Utility::DirName(const String& path)
{
char *dir;
#ifdef _WIN32
String dupPath = path;
/* PathRemoveFileSpec doesn't properly handle forward slashes. */
BOOST_FOREACH(char& ch, dupPath) {
if (ch == '/')
ch = '\\';
}
dir = strdup(dupPath.CStr());
#else /* _WIN32 */
dir = strdup(path.CStr());
#endif /* _WIN32 */
if (dir == NULL)
2013-03-16 21:18:53 +01:00
BOOST_THROW_EXCEPTION(std::bad_alloc());
String result;
#ifndef _WIN32
result = dirname(dir);
#else /* _WIN32 */
if (!PathRemoveFileSpec(dir)) {
free(dir);
2013-03-11 14:03:01 +01:00
BOOST_THROW_EXCEPTION(win32_error()
2013-03-18 17:04:22 +01:00
<< boost::errinfo_api_function("PathRemoveFileSpec")
<< errinfo_win32_error(GetLastError()));
}
result = dir;
if (result.IsEmpty())
result = ".";
#endif /* _WIN32 */
free(dir);
return result;
}
/**
* Returns the file component of a path. See basename(3) for details.
*
* @param path The full path.
* @returns The filename.
*/
String Utility::BaseName(const String& path)
{
char *dir = strdup(path.CStr());
String result;
if (dir == NULL)
2013-03-16 21:18:53 +01:00
BOOST_THROW_EXCEPTION(std::bad_alloc());
#ifndef _WIN32
result = basename(dir);
#else /* _WIN32 */
result = PathFindFileName(dir);
#endif /* _WIN32 */
free(dir);
return result;
}
/**
* Null deleter. Used as a parameter for the shared_ptr constructor.
*
2012-09-17 13:35:55 +02:00
* @param - The object that should be deleted.
*/
2012-08-07 21:02:12 +02:00
void Utility::NullDeleter(void *)
{
/* Nothing to do here. */
}
/**
* Returns the current UNIX timestamp including fractions of seconds.
*
* @returns The current time.
*/
double Utility::GetTime(void)
{
#ifdef _WIN32
FILETIME cft;
GetSystemTimeAsFileTime(&cft);
ULARGE_INTEGER ucft;
ucft.HighPart = cft.dwHighDateTime;
ucft.LowPart = cft.dwLowDateTime;
SYSTEMTIME est = { 1970, 1, 4, 1, 0, 0, 0, 0};
FILETIME eft;
SystemTimeToFileTime(&est, &eft);
ULARGE_INTEGER ueft;
ueft.HighPart = eft.dwHighDateTime;
ueft.LowPart = eft.dwLowDateTime;
return ((ucft.QuadPart - ueft.QuadPart) / 10000) / 1000.0;
#else /* _WIN32 */
struct timeval tv;
2013-03-11 13:45:08 +01:00
if (gettimeofday(&tv, NULL) < 0) {
BOOST_THROW_EXCEPTION(posix_error()
2013-03-18 17:04:22 +01:00
<< boost::errinfo_api_function("gettimeofday")
<< boost::errinfo_errno(errno));
2013-03-11 13:45:08 +01:00
}
return tv.tv_sec + tv.tv_usec / 1000000.0;
#endif /* _WIN32 */
}
/**
* Returns the ID of the current process.
*
* @returns The PID.
*/
pid_t Utility::GetPid(void)
{
#ifndef _WIN32
return getpid();
#else /* _WIN32 */
return GetCurrentProcessId();
#endif /* _WIN32 */
}
/**
* Sleeps for the specified amount of time.
*
* @param timeout The timeout in seconds.
*/
void Utility::Sleep(double timeout)
{
#ifndef _WIN32
usleep(timeout * 1000 * 1000);
#else /* _WIN32 */
2012-09-27 10:05:54 +02:00
::Sleep(timeout * 1000);
#endif /* _WIN32 */
}
/**
* Loads the specified library.
*
* @param library The name of the library.
*/
#ifdef _WIN32
HMODULE
#else /* _WIN32 */
lt_dlhandle
#endif /* _WIN32 */
Utility::LoadExtensionLibrary(const String& library)
{
String path;
#ifdef _WIN32
path = library + ".dll";
#else /* _WIN32 */
path = "lib" + library + ".la";
#endif /* _WIN32 */
2013-03-16 21:18:53 +01:00
Log(LogInformation, "base", "Loading library '" + path + "'");
#ifdef _WIN32
HMODULE hModule = LoadLibrary(path.CStr());
2013-03-11 14:03:01 +01:00
if (hModule == NULL) {
BOOST_THROW_EXCEPTION(win32_error()
2013-03-18 17:04:22 +01:00
<< boost::errinfo_api_function("LoadLibrary")
<< errinfo_win32_error(GetLastError())
<< boost::errinfo_file_name(path));
2013-03-11 14:03:01 +01:00
}
#else /* _WIN32 */
lt_dlhandle hModule = lt_dlopen(path.CStr());
if (hModule == NULL) {
2013-03-16 21:18:53 +01:00
BOOST_THROW_EXCEPTION(std::runtime_error("Could not load library '" + path + "': " + lt_dlerror()));
}
#endif /* _WIN32 */
return hModule;
}
/**
* Generates a new UUID.
*
* @returns The new UUID in text form.
*/
String Utility::NewUUID(void)
{
boost::uuids::uuid uuid = boost::uuids::random_generator()();
return boost::lexical_cast<String>(uuid);
}
/**
* Calls the specified callback for each file matching the path specification.
*
* @param pathSpec The path specification.
*/
2013-03-15 18:21:29 +01:00
bool Utility::Glob(const String& pathSpec, const boost::function<void (const String&)>& callback)
{
#ifdef _WIN32
HANDLE handle;
WIN32_FIND_DATA wfd;
handle = FindFirstFile(pathSpec.CStr(), &wfd);
if (handle == INVALID_HANDLE_VALUE) {
DWORD errorCode = GetLastError();
if (errorCode == ERROR_FILE_NOT_FOUND)
return false;
2013-03-11 14:03:01 +01:00
BOOST_THROW_EXCEPTION(win32_error()
2013-03-18 17:04:22 +01:00
<< boost::errinfo_api_function("FindFirstFile")
2013-03-18 22:40:40 +01:00
<< errinfo_win32_error(errorCode)
2013-03-18 17:04:22 +01:00
<< boost::errinfo_file_name(pathSpec));
}
do {
callback(DirName(pathSpec) + "/" + wfd.cFileName);
} while (FindNextFile(handle, &wfd));
2013-03-11 14:03:01 +01:00
if (!FindClose(handle)) {
BOOST_THROW_EXCEPTION(win32_error()
2013-03-18 17:04:22 +01:00
<< boost::errinfo_api_function("FindClose")
2013-03-11 14:03:01 +01:00
<< errinfo_win32_error(GetLastError()));
}
return true;
#else /* _WIN32 */
glob_t gr;
int rc = glob(pathSpec.CStr(), GLOB_ERR | GLOB_NOSORT, NULL, &gr);
if (rc < 0) {
if (rc == GLOB_NOMATCH)
return false;
2013-03-11 13:45:08 +01:00
BOOST_THROW_EXCEPTION(posix_error()
2013-03-18 17:04:22 +01:00
<< boost::errinfo_api_function("glob")
<< boost::errinfo_errno(errno)
<< boost::errinfo_file_name(pathSpec));
}
if (gr.gl_pathc == 0) {
globfree(&gr);
return false;
}
size_t left;
char **gp;
for (gp = gr.gl_pathv, left = gr.gl_pathc; left > 0; gp++, left--) {
callback(*gp);
}
globfree(&gr);
return true;
#endif /* _WIN32 */
}
2013-02-14 10:59:01 +01:00
#ifndef _WIN32
void Utility::SetNonBlocking(int fd)
{
2013-03-11 13:45:08 +01:00
int flags = fcntl(fd, F_GETFL, 0);
2013-03-11 13:45:08 +01:00
if (flags < 0) {
BOOST_THROW_EXCEPTION(posix_error()
2013-03-18 17:04:22 +01:00
<< boost::errinfo_api_function("fcntl")
<< boost::errinfo_errno(errno));
2013-03-11 13:45:08 +01:00
}
if (fcntl(fd, F_SETFL, flags | O_NONBLOCK) < 0) {
BOOST_THROW_EXCEPTION(posix_error()
2013-03-18 17:04:22 +01:00
<< boost::errinfo_api_function("fcntl")
<< boost::errinfo_errno(errno));
2013-03-11 13:45:08 +01:00
}
}
void Utility::SetCloExec(int fd)
{
2013-03-11 13:45:08 +01:00
int flags = fcntl(fd, F_GETFD, 0);
2013-03-11 13:45:08 +01:00
if (flags < 0) {
BOOST_THROW_EXCEPTION(posix_error()
2013-03-18 17:04:22 +01:00
<< boost::errinfo_api_function("fcntl")
<< boost::errinfo_errno(errno));
2013-03-11 13:45:08 +01:00
}
if (fcntl(fd, F_SETFD, flags | FD_CLOEXEC) < 0) {
BOOST_THROW_EXCEPTION(posix_error()
2013-03-18 17:04:22 +01:00
<< boost::errinfo_api_function("fcntl")
<< boost::errinfo_errno(errno));
2013-03-11 13:45:08 +01:00
}
}
2013-02-14 10:59:01 +01:00
#endif /* _WIN32 */
void Utility::SetNonBlockingSocket(SOCKET s)
{
#ifndef _WIN32
SetNonBlocking(s);
#else /* _WIN32 */
unsigned long lTrue = 1;
ioctlsocket(s, FIONBIO, &lTrue);
#endif /* _WIN32 */
}
2013-02-18 14:40:24 +01:00
void Utility::QueueAsyncCallback(const boost::function<void (void)>& callback)
{
2013-03-25 18:36:15 +01:00
Application::GetTP().Post(callback);
2013-02-18 14:40:24 +01:00
}
String Utility::FormatDateTime(const char *format, double ts)
{
char timestamp[128];
time_t tempts = (time_t)ts; /* We don't handle sub-second timestamp here just yet. */
tm tmthen;
#ifdef _MSC_VER
tm *temp = localtime(&tempts);
2013-03-11 13:45:08 +01:00
if (temp == NULL) {
BOOST_THROW_EXCEPTION(posix_error()
2013-03-18 17:04:22 +01:00
<< boost::errinfo_api_function("localtime")
<< boost::errinfo_errno(errno));
2013-03-11 13:45:08 +01:00
}
tmthen = *temp;
#else /* _MSC_VER */
2013-03-11 13:45:08 +01:00
if (localtime_r(&tempts, &tmthen) == NULL) {
BOOST_THROW_EXCEPTION(posix_error()
2013-03-18 17:04:22 +01:00
<< boost::errinfo_api_function("localtime_r")
<< boost::errinfo_errno(errno));
2013-03-11 13:45:08 +01:00
}
#endif /* _MSC_VER */
strftime(timestamp, sizeof(timestamp), format, &tmthen);
return timestamp;
}
2013-03-22 10:58:47 +01:00
String Utility::EscapeShellCmd(const String& s)
{
String result;
int prev_quote = String::NPos;
2013-03-22 16:05:48 +01:00
int index = -1;
2013-03-22 10:58:47 +01:00
BOOST_FOREACH(char ch, s) {
bool escape = false;
index++;
#ifdef _WIN32
if (ch == '%' || ch == '"' || ch == '\'')
escape = true;
#else /* _WIN32 */
if (ch == '"' || ch == '\'') {
/* Find a matching closing quotation character. */
if (prev_quote == String::NPos && (prev_quote = s.FindFirstOf(ch, index + 1)) != String::NPos)
; /* Empty statement. */
else if (prev_quote != String::NPos && s[prev_quote] == ch)
prev_quote = String::NPos;
else
escape = true;
}
#endif /* _WIN32 */
if (ch == '#' || ch == '&' || ch == ';' || ch == '`' || ch == '|' ||
ch == '*' || ch == '?' || ch == '~' || ch == '<' || ch == '>' ||
ch == '^' || ch == '(' || ch == ')' || ch == '[' || ch == ']' ||
ch == '{' || ch == '}' || ch == '$' || ch == '\\' || ch == '\x0A' ||
ch == '\xFF')
escape = true;
if (escape)
#ifdef _WIN32
result += '%';
#else /* _WIN32 */
result += '\\';
#endif /* _WIN32 */
result += ch;
}
return result;
}
2013-03-25 18:36:15 +01:00
void Utility::SetThreadName(const String& name)
{
m_ThreadName.reset(new String(name));
}
String Utility::GetThreadName(void)
{
String *name = m_ThreadName.get();
if (!name) {
std::ostringstream idbuf;
idbuf << boost::this_thread::get_id();
return idbuf.str();
}
return *name;
}