ZNC trunk
Loading...
Searching...
No Matches
Utils.h
Go to the documentation of this file.
1/*
2 * Copyright (C) 2004-2025 ZNC, see the NOTICE file for details.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#ifndef ZNC_UTILS_H
18#define ZNC_UTILS_H
19
20#include <znc/zncconfig.h>
21#include <znc/ZNCString.h>
22#include <assert.h>
23#include <cstdio>
24#include <fcntl.h>
25#include <map>
26#include <sys/file.h>
27#include <sys/time.h>
28#include <unistd.h>
29#include <vector>
30
31static inline void SetFdCloseOnExec(int fd) {
32 int flags = fcntl(fd, F_GETFD, 0);
33 if (flags < 0) return; // Ignore errors
34 // When we execve() a new process this fd is now automatically closed.
35 fcntl(fd, F_SETFD, flags | FD_CLOEXEC);
36}
37
38static const char g_HexDigits[] = "0123456789abcdef";
39
40class CUtils {
41 public:
44
45 static CString GetIP(unsigned long addr);
46 static unsigned long GetLongIP(const CString& sIP);
48
49 static void PrintError(const CString& sMessage);
50 static void PrintMessage(const CString& sMessage, bool bStrong = false);
51 static void PrintPrompt(const CString& sMessage);
52 static void PrintAction(const CString& sMessage);
53 static void PrintStatus(bool bSuccess, const CString& sMessage = "");
54
60
61 static CString GetSalt();
62 static CString SaltedMD5Hash(const CString& sPass, const CString& sSalt);
63 static CString SaltedSHA256Hash(const CString& sPass, const CString& sSalt);
64 static CString SaltedHash(const CString& sPass, const CString& sSalt);
65 static CString GetPass(const CString& sPrompt);
66 static bool GetInput(const CString& sPrompt, CString& sRet,
67 const CString& sDefault = "",
68 const CString& sHint = "");
69 static bool GetBoolInput(const CString& sPrompt, bool bDefault);
70 static bool GetBoolInput(const CString& sPrompt, bool* pbDefault = nullptr);
71 static bool GetNumInput(const CString& sPrompt, unsigned int& uRet,
72 unsigned int uMin = 0, unsigned int uMax = ~0,
73 unsigned int uDefault = ~0);
74
75 static timeval GetTime();
76 static unsigned long long GetMillTime();
77#ifdef HAVE_LIBSSL
78 static void GenerateCert(FILE* pOut);
79#endif /* HAVE_LIBSSL */
80
81 static CString CTime(time_t t, const CString& sTZ);
82 static CString FormatTime(time_t t, const CString& sFormat,
83 const CString& sTZ);
97 static CString FormatTime(const timeval& tv, const CString& sFormat,
98 const CString& sTZ);
99 static CString FormatServerTime(const timeval& tv);
100 static timeval ParseServerTime(const CString& sTime);
107 static bool CheckCIDR(const CString& sIP, const CString& sRange);
108
110 static MCString GetMessageTags(const CString& sLine);
112 static void SetMessageTags(CString& sLine, const MCString& mssTags);
113
114 private:
115 protected:
116};
117
119 public:
120 typedef enum { EX_Shutdown, EX_Restart } EType;
121
123 virtual ~CException() {}
124
125 EType GetType() const { return m_eType; }
126
127 private:
128 protected:
130};
131
132
173class CTable : protected std::vector<std::vector<CString>> {
174 public:
177 virtual ~CTable() {}
178
186 bool AddColumn(const CString& sName);
187
193 bool SetStyle(EStyle eNewStyle);
194
199 size_type AddRow();
200
208 bool SetCell(const CString& sColumn, const CString& sValue,
209 size_type uRowIdx = ~0);
210
216 bool GetLine(unsigned int uIdx, CString& sLine) const;
217
224 CString::size_type GetColumnWidth(unsigned int uIdx) const;
225
227 void Clear();
228
230 using std::vector<std::vector<CString>>::size;
231
233 using std::vector<std::vector<CString>>::empty;
234
235 private:
236 unsigned int GetColumnIndex(const CString& sName) const;
237
238 protected:
239 std::vector<CString> m_vsHeaders;
240 // Used to cache the width of a column
241 std::map<CString, CString::size_type> m_msuWidths;
243};
244
245#ifdef HAVE_LIBSSL
246#include <openssl/aes.h>
247#include <openssl/blowfish.h>
248#include <openssl/md5.h>
251 public:
257 CBlowfish(const CString& sPassword, int iEncrypt,
258 const CString& sIvec = "");
260
261 CBlowfish(const CBlowfish&) = default;
262 CBlowfish& operator=(const CBlowfish&) = default;
263
265 static unsigned char* MD5(const unsigned char* input, unsigned int ilen);
266
268 static CString MD5(const CString& sInput, bool bHexEncode = false);
269
271 void Crypt(unsigned char* input, unsigned char* output,
272 unsigned int ibytes);
273
275 unsigned char* Crypt(unsigned char* input, unsigned int ibytes);
276 CString Crypt(const CString& sData);
277
278 private:
279 unsigned char* m_ivec;
280 BF_KEY m_bkey;
281 int m_iEncrypt, m_num;
282};
283
284#endif /* HAVE_LIBSSL */
285
291template <typename K, typename V = bool>
293 public:
294 TCacheMap(unsigned int uTTL = 5000) : m_mItems(), m_uTTL(uTTL) {}
295
296 virtual ~TCacheMap() {}
297
302 void AddItem(const K& Item) { AddItem(Item, m_uTTL); }
303
309 void AddItem(const K& Item, unsigned int uTTL) { AddItem(Item, V(), uTTL); }
310
316 void AddItem(const K& Item, const V& Val) { AddItem(Item, Val, m_uTTL); }
317
324 void AddItem(const K& Item, const V& Val, unsigned int uTTL) {
325 if (!uTTL) {
326 // If time-to-live is zero we don't want to waste our time adding
327 // it
328 RemItem(Item); // Remove the item incase it already exists
329 return;
330 }
331
332 m_mItems[Item] = value(CUtils::GetMillTime() + uTTL, Val);
333 }
334
340 bool HasItem(const K& Item) {
341 Cleanup();
342 return (m_mItems.find(Item) != m_mItems.end());
343 }
344
350 V* GetItem(const K& Item) {
351 Cleanup();
352 iterator it = m_mItems.find(Item);
353 if (it == m_mItems.end()) return nullptr;
354 return &it->second.second;
355 }
356
362 bool RemItem(const K& Item) { return (m_mItems.erase(Item) != 0); }
363
367 void Cleanup() {
368 iterator it = m_mItems.begin();
369
370 while (it != m_mItems.end()) {
371 if (CUtils::GetMillTime() > (it->second.first)) {
372 m_mItems.erase(it++);
373 } else {
374 ++it;
375 }
376 }
377 }
378
382 void Clear() { m_mItems.clear(); }
383
387 std::map<K, V> GetItems() {
388 Cleanup();
389 std::map<K, V> mItems;
390 for (const auto& it : m_mItems) {
391 mItems[it.first] = it.second.second;
392 }
393 return mItems;
394 }
395
396 // Setters
397 void SetTTL(unsigned int u) { m_uTTL = u; }
398 // !Setters
399 // Getters
400 unsigned int GetTTL() const { return m_uTTL; }
401 // !Getters
402 protected:
403 typedef std::pair<unsigned long long, V> value;
404 typedef typename std::map<K, value>::iterator iterator;
405 std::map<K, value>
407 unsigned int m_uTTL;
408};
409
410#endif // !ZNC_UTILS_H
std::set< CString > SCString
Definition ZNCString.h:37
does Blowfish w/64 bit feedback, no padding
Definition Utils.h:250
CBlowfish(const CBlowfish &)=default
void Crypt(unsigned char *input, unsigned char *output, unsigned int ibytes)
output must be the same size as input
static unsigned char * MD5(const unsigned char *input, unsigned int ilen)
output must be freed
CBlowfish(const CString &sPassword, int iEncrypt, const CString &sIvec="")
unsigned char * Crypt(unsigned char *input, unsigned int ibytes)
must free result
CBlowfish & operator=(const CBlowfish &)=default
static CString MD5(const CString &sInput, bool bHexEncode=false)
returns an md5 of the CString (not hex encoded)
CString Crypt(const CString &sData)
Definition Utils.h:118
EType GetType() const
Definition Utils.h:125
virtual ~CException()
Definition Utils.h:123
EType
Definition Utils.h:120
@ EX_Shutdown
Definition Utils.h:120
@ EX_Restart
Definition Utils.h:120
EType m_eType
Definition Utils.h:129
CException(EType e)
Definition Utils.h:122
String class that is used inside ZNC.
Definition ZNCString.h:68
Generate a grid-like or list-like output from a given input.
Definition Utils.h:173
bool AddColumn(const CString &sName)
Adds a new column to the table.
std::map< CString, CString::size_type > m_msuWidths
Definition Utils.h:241
EStyle eStyle
Definition Utils.h:242
std::vector< CString > m_vsHeaders
Definition Utils.h:239
virtual ~CTable()
Definition Utils.h:177
bool SetStyle(EStyle eNewStyle)
Selects the output style of the table.
bool SetCell(const CString &sColumn, const CString &sValue, size_type uRowIdx=~0)
Sets a given cell in the table to a value.
bool GetLine(unsigned int uIdx, CString &sLine) const
Get a line of the table's output.
CString::size_type GetColumnWidth(unsigned int uIdx) const
Return the width of the given column.
EStyle
Definition Utils.h:175
@ GridStyle
Definition Utils.h:175
@ ListStyle
Definition Utils.h:175
size_type AddRow()
Adds a new row to the table.
CTable()
Definition Utils.h:176
void Clear()
Completely clear the table.
Definition Utils.h:40
static SCString GetEncodings()
static bool CheckCIDR(const CString &sIP, const CString &sRange)
CIDR notation checker, e.g.
static CString FormatTime(time_t t, const CString &sFormat, const CString &sTZ)
static CString GetHostName()
static CString GetIP(unsigned long addr)
static CString GetPass(const CString &sPrompt)
static CString SaltedMD5Hash(const CString &sPass, const CString &sSalt)
static unsigned long GetLongIP(const CString &sIP)
static CString FormatServerTime(const timeval &tv)
static void PrintError(const CString &sMessage)
static CString SaltedSHA256Hash(const CString &sPass, const CString &sSalt)
static CString CTime(time_t t, const CString &sTZ)
static CString AskSaltedHashPassForConfig()
Asks password from stdin, with confirmation.
static void PrintPrompt(const CString &sMessage)
static CString SaltedHash(const CString &sPass, const CString &sSalt)
static bool GetNumInput(const CString &sPrompt, unsigned int &uRet, unsigned int uMin=0, unsigned int uMax=~0, unsigned int uDefault=~0)
static SCString GetTimezones()
static void SetMessageTags(CString &sLine, const MCString &mssTags)
static CString GetSalt()
static timeval GetTime()
static CString FormatTime(const timeval &tv, const CString &sFormat, const CString &sTZ)
Supports an additional format specifier for formatting sub-second values:
static void PrintStatus(bool bSuccess, const CString &sMessage="")
static MCString GetMessageTags(const CString &sLine)
static bool GetBoolInput(const CString &sPrompt, bool *pbDefault=nullptr)
static bool GetInput(const CString &sPrompt, CString &sRet, const CString &sDefault="", const CString &sHint="")
static void GenerateCert(FILE *pOut)
static void PrintAction(const CString &sMessage)
static unsigned long long GetMillTime()
static bool GetBoolInput(const CString &sPrompt, bool bDefault)
static void PrintMessage(const CString &sMessage, bool bStrong=false)
static timeval ParseServerTime(const CString &sTime)
A dictionary for strings.
Definition ZNCString.h:595
Insert an object with a time-to-live and check later if it still exists.
Definition Utils.h:292
void AddItem(const K &Item, unsigned int uTTL)
This function adds an item to the cache using a custom time-to-live value.
Definition Utils.h:309
bool HasItem(const K &Item)
Performs a Cleanup() and then checks to see if your item exists.
Definition Utils.h:340
unsigned int m_uTTL
Default time-to-live duration.
Definition Utils.h:407
void Cleanup()
Cycles through the queue removing all of the stale entries.
Definition Utils.h:367
std::map< K, value >::iterator iterator
Definition Utils.h:404
bool RemItem(const K &Item)
Removes a specific item from the cache.
Definition Utils.h:362
void AddItem(const K &Item)
This function adds an item to the cache using the default time-to-live value.
Definition Utils.h:302
unsigned int GetTTL() const
Definition Utils.h:400
std::map< K, V > GetItems()
Returns all entries.
Definition Utils.h:387
std::map< K, value > m_mItems
Map of cached items.
Definition Utils.h:406
void AddItem(const K &Item, const V &Val, unsigned int uTTL)
This function adds an item to the cache using a custom time-to-live value.
Definition Utils.h:324
void Clear()
Clear all entries.
Definition Utils.h:382
virtual ~TCacheMap()
Definition Utils.h:296
void AddItem(const K &Item, const V &Val)
This function adds an item to the cache using the default time-to-live value.
Definition Utils.h:316
void SetTTL(unsigned int u)
Definition Utils.h:397
std::pair< unsigned long long, V > value
Definition Utils.h:403
TCacheMap(unsigned int uTTL=5000)
Definition Utils.h:294
V * GetItem(const K &Item)
Performs a Cleanup() and returns a pointer to the object, or nullptr.
Definition Utils.h:350