1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
|
/* Icinga 2 | (c) 2012 Icinga GmbH | GPLv2+ */
#ifndef UTILITY_H
#define UTILITY_H
#include "base/i2-base.hpp"
#include "base/string.hpp"
#include "base/array.hpp"
#include "base/threadpool.hpp"
#include "base/tlsutility.hpp"
#include <boost/thread/tss.hpp>
#include <openssl/sha.h>
#include <functional>
#include <typeinfo>
#include <vector>
namespace icinga
{
#ifdef _WIN32
#define MS_VC_EXCEPTION 0x406D1388
# pragma pack(push, 8)
struct THREADNAME_INFO
{
DWORD dwType;
LPCSTR szName;
DWORD dwThreadID;
DWORD dwFlags;
};
# pragma pack(pop)
#endif
enum GlobType
{
GlobFile = 1,
GlobDirectory = 2
};
/**
* Helper functions.
*
* @ingroup base
*/
class Utility
{
public:
static String DemangleSymbolName(const String& sym);
static String GetTypeName(const std::type_info& ti);
static String GetSymbolName(const void *addr);
static bool Match(const String& pattern, const String& text);
static bool CidrMatch(const String& pattern, const String& ip);
static String DirName(const String& path);
static String BaseName(const String& path);
static void NullDeleter(void *);
static double GetTime();
static pid_t GetPid();
static void Sleep(double timeout);
static String NewUniqueID();
static bool Glob(const String& pathSpec, const std::function<void (const String&)>& callback, int type = GlobFile | GlobDirectory);
static bool GlobRecursive(const String& path, const String& pattern, const std::function<void (const String&)>& callback, int type = GlobFile | GlobDirectory);
static void MkDir(const String& path, int mode);
static void MkDirP(const String& path, int mode);
static bool SetFileOwnership(const String& file, const String& user, const String& group);
static void QueueAsyncCallback(const std::function<void ()>& callback, SchedulerPolicy policy = DefaultScheduler);
static String NaturalJoin(const std::vector<String>& tokens);
static String Join(const Array::Ptr& tokens, char separator, bool escapeSeparator = true);
static String FormatDuration(double duration);
static String FormatDateTime(const char *format, double ts);
static String FormatErrorNumber(int code);
#ifndef _WIN32
static void SetNonBlocking(int fd, bool nb = true);
static void SetCloExec(int fd, bool cloexec = true);
static void CloseAllFDs(const std::vector<int>& except, std::function<void(int)> onClose = nullptr);
#endif /* _WIN32 */
static void SetNonBlockingSocket(SOCKET s, bool nb = true);
static String EscapeShellCmd(const String& s);
static String EscapeShellArg(const String& s);
#ifdef _WIN32
static String EscapeCreateProcessArg(const String& arg);
#endif /* _WIN32 */
static String EscapeString(const String& s, const String& chars, const bool illegal);
static String UnescapeString(const String& s);
static void SetThreadName(const String& name, bool os = true);
static String GetThreadName();
static unsigned long SDBM(const String& str, size_t len = String::NPos);
static String ParseVersion(const String& v);
static int CompareVersion(const String& v1, const String& v2);
static int Random();
static String GetHostName();
static String GetFQDN();
static tm LocalTime(time_t ts);
static bool PathExists(const String& path);
static time_t GetFileCreationTime(const String& path);
static void Remove(const String& path);
static void RemoveDirRecursive(const String& path);
static void CopyFile(const String& source, const String& target);
static void RenameFile(const String& source, const String& target);
static Value LoadJsonFile(const String& path);
static void SaveJsonFile(const String& path, int mode, const Value& value);
static String GetPlatformKernel();
static String GetPlatformKernelVersion();
static String GetPlatformName();
static String GetPlatformVersion();
static String GetPlatformArchitecture();
static String ValidateUTF8(const String& input);
#ifdef _WIN32
static int MksTemp(char *tmpl);
#endif /* _WIN32 */
#ifdef _WIN32
static String GetIcingaInstallPath();
static String GetIcingaDataPath();
#endif /* _WIN32 */
static String GetFromEnvironment(const String& env);
static bool ComparePasswords(const String& enteredPassword, const String& actualPassword);
#ifdef I2_DEBUG
static void SetTime(double);
static void IncrementTime(double);
#endif /* I2_DEBUG */
/**
* TruncateUsingHash truncates a given string to an allowed maximum length while avoiding collisions in the output
* using a hash function (SHA1).
*
* For inputs shorter than the maximum output length, the output will be the same as the input. If the input has at
* least the maximum output length, it is hashed used SHA1 and the output has the format "A...B" where A is a prefix
* of the input and B is the hex-encoded SHA1 hash of the input. The length of A is chosen so that the result has
* the maximum allowed output length.
*
* @tparam maxLength Maximum length of the output string (must be at least 44)
* @param in String to truncate
* @return A truncated string derived from in of at most length maxLength
*/
template<size_t maxLength>
static String TruncateUsingHash(const String &in) {
/*
* Note: be careful when changing this function as it is used to derive file names that should not change
* between versions or would need special handling if they do (/var/lib/icinga2/api/packages/_api).
*/
const size_t sha1HexLength = SHA_DIGEST_LENGTH*2;
static_assert(maxLength >= 1 + 3 + sha1HexLength,
"maxLength must be at least 44 to hold one character, '...', and a hex-encoded SHA1 hash");
/* If the input is shorter than the limit, no truncation is needed */
if (in.GetLength() < maxLength) {
return in;
}
const char *trunc = "...";
return in.SubStr(0, maxLength - sha1HexLength - strlen(trunc)) + trunc + SHA1(in);
}
private:
Utility();
#ifdef I2_DEBUG
static double m_DebugTime;
#endif /* I2_DEBUG */
static boost::thread_specific_ptr<String> m_ThreadName;
static boost::thread_specific_ptr<unsigned int> m_RandSeed;
};
}
#endif /* UTILITY_H */
|
