haraldwolff
/
collabora-online
mirror of https://github.com/CollaboraOnline/online.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
collabora-online/common/Util.hpp

1528 lines
47 KiB
C++
Raw Blame History

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */
/*
* Copyright the Collabora Online contributors.
*
* SPDX-License-Identifier: MPL-2.0
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
#pragma once
#include <cassert>
#include <cerrno>
#include <chrono>
#include <cinttypes>
#include <cstddef>
#include <cstdint>
#include <cstring>
#include <algorithm>
#include <atomic>
#include <mutex>
#include <set>
#include <sstream>
#include <string>
#include <map>
#include <utility>
#include <inttypes.h>
#include <cctype>
#include <memory.h>
#include <thread>
#include <Poco/File.h>
#include <Poco/Path.h>
#include <Poco/RegularExpression.h>
#define LOK_USE_UNSTABLE_API
#include <LibreOfficeKit/LibreOfficeKitEnums.h>
#include <StringVector.hpp>
#define STRINGIFY(X) #X
#if CODE_COVERAGE
extern "C"
{
void __gcov_reset(void);
void __gcov_flush(void);
void __gcov_dump(void);
}
#endif
/// Format seconds with the units suffix until we migrate to C++20.
inline std::ostream& operator<<(std::ostream& os, const std::chrono::seconds& s)
{
os << s.count() << 's';
return os;
}
/// Format milliseconds with the units suffix until we migrate to C++20.
inline std::ostream& operator<<(std::ostream& os, const std::chrono::milliseconds& ms)
{
os << ms.count() << "ms";
return os;
}
/// Format microseconds with the units suffix until we migrate to C++20.
inline std::ostream& operator<<(std::ostream& os, const std::chrono::microseconds& ms)
{
os << ms.count() << "us";
return os;
}
template <typename S, typename U, typename V>
inline S& operator<<(S& stream, const std::pair<U, V>& pair)
{
stream << pair.first << ": " << pair.second;
return stream;
}
namespace Util
{
namespace rng
{
uint_fast64_t getSeed();
void reseed();
unsigned getNext();
/// Generate an array of random characters.
std::vector<char> getBytes(const size_t length);
/// Generate a string of random characters.
std::string getHexString(const size_t length);
/// Generates a random string suitable for
/// file/directory names.
std::string getFilename(const size_t length);
}
/// A utility class to track relative time from some arbitrary
/// origin, and to check if a certain amount has elapsed or not.
class Stopwatch
{
public:
Stopwatch()
: _startTime(std::chrono::steady_clock::now())
{
}
void restart() { _startTime = std::chrono::steady_clock::now(); }
/// Returns the time that has elapsed since starting, in the units required.
/// Units defaults to milliseconds.
template <typename T = std::chrono::milliseconds>
T
elapsed(std::chrono::steady_clock::time_point now = std::chrono::steady_clock::now()) const
{
return std::chrono::duration_cast<T>(now - _startTime);
}
/// Returns true iff at least the given amount of time has elapsed.
template <typename T> bool elapsed(T duration) const
{
return elapsed<std::chrono::nanoseconds>() >= duration;
}
private:
std::chrono::steady_clock::time_point _startTime;
};
class DirectoryCounter
{
void *_tasks;
public:
DirectoryCounter(const char *procPath);
~DirectoryCounter();
/// Get number of items in this directory or -1 on error
int count();
};
/// Needs to open dirent before forking in Kit process
class ThreadCounter : public DirectoryCounter
{
public:
ThreadCounter() : DirectoryCounter("/proc/self/task") {}
};
/// Needs to open dirent before forking in Kit process
class FDCounter : public DirectoryCounter
{
public:
FDCounter() : DirectoryCounter("/proc/self/fd") {}
};
/// Spawn a process.
int spawnProcess(const std::string &cmd, const StringVector &args);
/// Convert unsigned char data to hex.
/// @buffer can be either std::vector<char> or std::string.
/// @offset the offset within the buffer to start from.
/// @length is the number of bytes to convert.
template <typename T>
inline std::string dataToHexString(const T& buffer, const std::size_t offset,
const std::size_t length)
{
char scratch[64];
std::stringstream os;
for (unsigned int i = 0; i < length; i++)
{
if ((offset + i) >= buffer.size())
break;
snprintf(scratch, sizeof(scratch), "%.2x", static_cast<unsigned char>(buffer[offset + i]));
os << scratch;
}
return os.str();
}
/// Hex to unsigned char
template <typename T>
bool dataFromHexString(const std::string& hexString, T& data)
{
if (hexString.length() % 2 != 0)
{
return false;
}
data.clear();
std::stringstream stream;
unsigned value;
for (unsigned long offset = 0; offset < hexString.size(); offset += 2)
{
stream.clear();
stream << std::hex << hexString.substr(offset, 2);
stream >> value;
data.push_back(static_cast<typename T::value_type>(value));
}
return true;
}
/// Encode an integral ID into a string, with padding support.
std::string encodeId(const std::uint64_t number, const int padding = 5);
/// Decode an integral ID from a string.
std::uint64_t decodeId(const std::string& str);
bool windowingAvailable();
/// Send a message to all clients.
void alertAllUsers(const std::string& msg);
/// Send a 'error:' message with the specified cmd and kind parameters to all connected
/// clients. This function can be called either in coolwsd or coolkit processes, even if only
/// coolwsd obviously has contact with the actual clients; in coolkit it will be forwarded to
/// coolwsd for redistribution. (This function must be implemented separately in each program
/// that uses it, it is not in Util.cpp.)
void alertAllUsers(const std::string& cmd, const std::string& kind);
/// Assert that a lock is already taken.
template <typename T> void assertIsLocked([[maybe_unused]] const T& lock)
{
#ifndef NDEBUG
assert(lock.owns_lock());
#endif
}
inline void assertIsLocked([[maybe_unused]] std::mutex& mtx)
{
#ifndef NDEBUG
assert(!mtx.try_lock());
#endif
}
/// Print given number of bytes in human-understandable form (KB,MB, etc.)
std::string getHumanizedBytes(unsigned long nBytes);
/// Returns the total physical memory (in kB) available in the system
size_t getTotalSystemMemoryKb();
/// Returns the numerical content of a file at @path
std::size_t getFromFile(const char *path);
/// Returns the cgroup's memory limit, or 0 if not available in bytes
std::size_t getCGroupMemLimit();
/// Returns the cgroup's soft memory limit, or 0 if not available in bytes
std::size_t getCGroupMemSoftLimit();
/// Returns the process PSS in KB (works only when we have perms for /proc/pid/smaps).
size_t getMemoryUsagePSS(const pid_t pid);
/// Returns the process RSS in KB.
size_t getMemoryUsageRSS(const pid_t pid);
/// Returns the number of current threads, or zero on error
size_t getCurrentThreadCount();
/// Returns the RSS and PSS of the current process in KB.
/// Example: "procmemstats: pid=123 rss=12400 pss=566"
std::string getMemoryStats(FILE* file);
/// Reads from SMaps file Pss and Private_Dirty values and
/// returns them as a pair in the same order
std::pair<size_t, size_t> getPssAndDirtyFromSMaps(FILE* file);
size_t getCpuUsage(const pid_t pid);
size_t getStatFromPid(const pid_t pid, int ind);
/// Sets priorities for a given pid & the current thread
void setProcessAndThreadPriorities(const pid_t pid, int prio);
/// Replace substring @a in string @s with string @b.
std::string replace(std::string s, const std::string& a, const std::string& b);
/// Replace any characters in @a matching characters in @b with replacement chars in @c and return
std::string replaceAllOf(const std::string &str, const std::string& match, const std::string& repl);
std::string formatLinesForLog(const std::string& s);
void setThreadName(const std::string& s);
const char *getThreadName();
#if defined __linux__
pid_t getThreadId();
#else
long getThreadId();
#endif
/// Get version information
void getVersionInfo(std::string& version, std::string& hash);
///< A random hex string that identifies the current process.
const std::string& getProcessIdentifier();
std::string getVersionJSON(bool enableExperimental);
/// Return a string that is unique across processes and calls.
std::string UniqueId();
// Extract all json entries into a map.
std::map<std::string, std::string> JsonToMap(const std::string& jsonString);
inline unsigned short hexFromByte(unsigned char byte)
{
constexpr auto hex = "0123456789ABCDEF";
return (hex[byte >> 4] << 8) | hex[byte & 0xf];
}
inline std::string bytesToHexString(const uint8_t* data, size_t size)
{
std::string s;
s.resize(size * 2); // Each byte is two hex digits.
for (size_t i = 0; i < size; ++i)
{
const unsigned short hex = hexFromByte(data[i]);
const size_t off = i * 2;
s[off] = hex >> 8;
s[off + 1] = hex & 0xff;
}
return s;
}
inline std::string bytesToHexString(const char* data, size_t size)
{
return bytesToHexString(reinterpret_cast<const uint8_t*>(data), size);
}
inline std::string bytesToHexString(const std::string& s)
{
return bytesToHexString(s.c_str(), s.size());
}
inline int hexDigitFromChar(char c)
{
if (c >= '0' && c <= '9')
return c - '0';
else if (c >= 'a' && c <= 'f')
return c - 'a' + 10;
else if (c >= 'A' && c <= 'F')
return c - 'A' + 10;
else
return -1;
}
#if ENABLE_DEBUG
// for debugging validation only.
inline size_t isValidUtf8(const unsigned char *data, size_t len)
{
for (size_t i = 0; i < len; ++i)
{
if (data[i] < 0x80)
continue;
if (data[i] >> 6 != 0x3)
return i;
int chunkLen = 1;
for (; data[i] & (1 << (7-chunkLen)); chunkLen++)
if (chunkLen > 4)
return i;
// Allow equality as the lower limit of the loop below is not zero.
if (i + chunkLen > len)
return i;
for (; chunkLen > 1; --chunkLen)
if (data[++i] >> 6 != 0x2)
return i;
}
return len + 1;
}
// for debugging validation only.
inline bool isValidUtf8(const std::string& s)
{
return Util::isValidUtf8((unsigned char *)s.c_str(), s.size()) > s.size();
}
#endif
inline std::string hexStringToBytes(const uint8_t* data, size_t size)
{
assert(data && (size % 2 == 0) && "Invalid hex digits to convert.");
std::string s;
s.resize(size / 2); // Each pair of hex digits is a single byte.
for (size_t i = 0; i < size; i += 2)
{
const int high = hexDigitFromChar(data[i]);
assert(high >= 0 && high <= 16);
const int low = hexDigitFromChar(data[i + 1]);
assert(low >= 0 && low <= 16);
const size_t off = i / 2;
s[off] = ((high << 4) | low) & 0xff;
}
return s;
}
inline std::string hexStringToBytes(const char* data, size_t size)
{
return hexStringToBytes(reinterpret_cast<const uint8_t*>(data), size);
}
inline std::string hexStringToBytes(const std::string& s)
{
return hexStringToBytes(s.c_str(), s.size());
}
/// Dump a line of data as hex.
/// @buffer can be either std::vector<char> or std::string.
/// @offset, the offset within the buffer to start from.
/// @width is the number of bytes to dump.
template <typename T>
inline std::string stringifyHexLine(const T& buffer, std::size_t offset,
const std::size_t width = 32)
{
std::string str;
str.reserve(width * 4 + width / 8 + 3 + 1);
for (unsigned int i = 0; i < width; i++)
{
if (i && (i % 8) == 0)
str.push_back(' ');
if ((offset + i) < buffer.size())
{
const unsigned short hex = hexFromByte(buffer[offset+i]);
str.push_back(hex >> 8);
str.push_back(hex & 0xff);
str.push_back(' ');
}
else
str.append(3, ' ');
}
str.append(" | ");
for (unsigned int i = 0; i < width; i++)
{
if ((offset + i) < buffer.size())
str.push_back(::isprint(buffer[offset + i]) ? buffer[offset + i] : '.');
else
str.push_back(' '); // Leave blank if we are out of data.
}
return str;
}
/// Dump data as hex and chars to stream.
/// @buffer can be either std::vector<char> or std::string.
/// @legend is streamed into @os before the hex data once.
/// @prefix is streamed into @os for each line.
/// @skipDup, when true, will avoid writing identical lines.
/// @width is the number of bytes to dump per line.
template <typename T>
inline void dumpHex(std::ostream& os, const T& buffer, const char* legend = "",
const char* prefix = "", bool skipDup = true, const unsigned int width = 32)
{
unsigned int j;
char scratch[64];
int skip = 0;
std::string lastLine;
os << legend;
for (j = 0; j < buffer.size() + width - 1; j += width)
{
snprintf (scratch, sizeof(scratch), "%s0x%.4x ", prefix, j);
os << scratch;
std::string line = stringifyHexLine(buffer, j, width);
if (skipDup && lastLine == line)
skip++;
else {
if (skip > 0)
{
os << "... dup " << skip - 1 << "...";
skip = 0;
}
else
os << line;
}
lastLine.swap(line);
os << '\n';
}
os.flush();
}
/// Dump data as hex and chars into a string.
/// Primarily used for logging.
template <typename T>
inline std::string dumpHex(const T& buffer, const char* legend = "", const char* prefix = "",
bool skipDup = true, const unsigned int width = 32)
{
std::ostringstream oss;
dumpHex(oss, buffer, legend, prefix, skipDup, width);
return oss.str();
}
inline std::string dumpHex (const char *legend, const char *prefix,
const std::vector<char>::iterator &startIt,
const std::vector<char>::iterator &endIt,
bool skipDup = true, const unsigned int width = 32)
{
std::ostringstream oss;
std::vector<char> data(startIt, endIt);
dumpHex(oss, data, legend, prefix, skipDup, width);
return oss.str();
}
size_t findInVector(const std::vector<char>& tokens, const char *cstring, std::size_t offset = 0);
/// Trim spaces from the left. Just spaces.
inline std::string& ltrim(std::string& s)
{
const size_t pos = s.find_first_not_of(' ');
if (pos != std::string::npos)
{
s = s.substr(pos);
}
return s;
}
/// Trim spaces from the left and copy. Just spaces.
inline std::string ltrimmed(const std::string& s)
{
const size_t pos = s.find_first_not_of(' ');
if (pos != std::string::npos)
{
return s.substr(pos);
}
return s;
}
inline std::string& trim(std::string& s, const char ch)
{
const size_t last = s.find_last_not_of(ch);
if (last != std::string::npos)
{
s = s.substr(0, last + 1);
}
else
{
s.clear();
}
return s;
}
/// Trim spaces from both left and right. Just spaces.
inline std::string& trim(std::string& s)
{
const size_t first = s.find_first_not_of(' ');
const size_t last = s.find_last_not_of(' ');
if (first != std::string::npos)
{
if (last != std::string::npos)
{
s = s.substr(first, last + 1 - first);
}
else
{
s = s.substr(first);
}
}
else
{
if (last != std::string::npos)
{
s = s.substr(0, last + 1);
}
else
{
s.clear();
}
}
return s;
}
/// Trim spaces from both left and right and copy. Just spaces.
inline std::string trimmed(const std::string& s)
{
const size_t first = s.find_first_not_of(' ');
const size_t last = s.find_last_not_of(' ');
if (first != std::string::npos)
{
if (last != std::string::npos)
{
return s.substr(first, last + 1 - first);
}
return s.substr(first);
}
if (last != std::string::npos)
{
return s.substr(0, last + 1);
}
return std::string();
}
/// Trim spaces from left and right. Just spaces.
inline std::string trimmed(const char* s)
{
return trimmed(std::string(s));
}
#ifdef IOS
inline void *memrchr(const void *s, int c, size_t n)
{
char *p = (char*)s + n - 1;
while (p >= (char*)s)
{
if (*p == c)
return p;
p--;
}
return nullptr;
}
#if 0
// Unit test for the above memrchr()
int main(int argc, char**argv)
{
int success = 1;
char *s;
char *p;
#define TEST(s_,c,n,e) \
s = s_; \
printf("memrchr(\"%s\",'%c',%d)=",s,c,n); \
p = memrchr(s, c, n); \
if (p) \
printf("\"%s\"", p); \
else \
printf("NULL"); \
if (p == e) \
printf(" OK\n"); \
else \
{ \
printf(" FAIL\n"); \
success = 0; \
}
TEST("abc", 'x', 0, NULL);
TEST("abc", 'x', 1, NULL);
TEST("abc", 'x', 3, NULL);
TEST("abc", 'a', 0, NULL);
TEST("abc", 'a', 1, s);
TEST("abc", 'a', 3, s);
TEST("abc", 'b', 0, NULL);
TEST("abc", 'b', 1, NULL);
TEST("abc", 'b', 2, s+1);
TEST("abc", 'b', 3, s+1);
TEST("abc", 'c', 0, NULL);
TEST("abc", 'c', 1, NULL);
TEST("abc", 'c', 2, NULL);
TEST("abc", 'c', 3, s+2);
if (success)
return 0;
else
return 1;
}
#endif
#endif
inline size_t getLastDelimiterPosition(const char* message, const int length, const char delim)
{
if (message && length > 0)
{
const char *founddelim = static_cast<const char *>(memrchr(message, delim, length));
const auto size = (founddelim == nullptr ? length : founddelim - message);
return size;
}
return 0;
}
/// Return the symbolic name for an errno value, or in decimal if not handled here.
inline std::string symbolicErrno(int e)
{
// LCOV_EXCL_START Coverage for these is not very useful.
// Errnos from <asm-generic/errno-base.h> and <asm-generic/errno.h> on Linux.
switch (e)
{
case EPERM: return "EPERM";
case ENOENT: return "ENOENT";
case ESRCH: return "ESRCH";
case EINTR: return "EINTR";
case EIO: return "EIO";
case ENXIO: return "ENXIO";
case E2BIG: return "E2BIG";
case ENOEXEC: return "ENOEXEC";
case EBADF: return "EBADF";
case ECHILD: return "ECHILD";
case EAGAIN: return "EAGAIN";
case ENOMEM: return "ENOMEM";
case EACCES: return "EACCES";
case EFAULT: return "EFAULT";
case ENOTBLK: return "ENOTBLK";
case EBUSY: return "EBUSY";
case EEXIST: return "EEXIST";
case EXDEV: return "EXDEV";
case ENODEV: return "ENODEV";
case ENOTDIR: return "ENOTDIR";
case EISDIR: return "EISDIR";
case EINVAL: return "EINVAL";
case ENFILE: return "ENFILE";
case EMFILE: return "EMFILE";
case ENOTTY: return "ENOTTY";
case ETXTBSY: return "ETXTBSY";
case EFBIG: return "EFBIG";
case ENOSPC: return "ENOSPC";
case ESPIPE: return "ESPIPE";
case EROFS: return "EROFS";
case EMLINK: return "EMLINK";
case EPIPE: return "EPIPE";
case EDOM: return "EDOM";
case ERANGE: return "ERANGE";
case EDEADLK: return "EDEADLK";
case ENAMETOOLONG: return "ENAMETOOLONG";
case ENOLCK: return "ENOLCK";
case ENOSYS: return "ENOSYS";
case ENOTEMPTY: return "ENOTEMPTY";
case ELOOP: return "ELOOP";
case ENOMSG: return "ENOMSG";
case EIDRM: return "EIDRM";
#ifdef ECHRNG
case ECHRNG: return "ECHRNG";
#endif
#ifdef EL2NSYNC
case EL2NSYNC: return "EL2NSYNC";
#endif
#ifdef EL3HLT
case EL3HLT: return "EL3HLT";
#endif
#ifdef EL3RST
case EL3RST: return "EL3RST";
#endif
#ifdef ELNRNG
case ELNRNG: return "ELNRNG";
#endif
#ifdef EUNATCH
case EUNATCH: return "EUNATCH";
#endif
#ifdef ENOCSI
case ENOCSI: return "ENOCSI";
#endif
#ifdef EL2HLT
case EL2HLT: return "EL2HLT";
#endif
#ifdef EBADE
case EBADE: return "EBADE";
#endif
#ifdef EBADR
case EBADR: return "EBADR";
#endif
#ifdef EXFULL
case EXFULL: return "EXFULL";
#endif
#ifdef ENOANO
case ENOANO: return "ENOANO";
#endif
#ifdef EBADRQC
case EBADRQC: return "EBADRQC";
#endif
#ifdef EBADSLT
case EBADSLT: return "EBADSLT";
#endif
#ifdef EBFONT
case EBFONT: return "EBFONT";
#endif
case ENOSTR: return "ENOSTR";
case ENODATA: return "ENODATA";
case ETIME: return "ETIME";
case ENOSR: return "ENOSR";
#ifdef ENONET
case ENONET: return "ENONET";
#endif
#ifdef ENOPKG
case ENOPKG: return "ENOPKG";
#endif
case EREMOTE: return "EREMOTE";
case ENOLINK: return "ENOLINK";
#ifdef EADV
case EADV: return "EADV";
#endif
#ifdef ESRMNT
case ESRMNT: return "ESRMNT";
#endif
#ifdef ECOMM
case ECOMM: return "ECOMM";
#endif
case EPROTO: return "EPROTO";
case EMULTIHOP: return "EMULTIHOP";
#ifdef EDOTDOT
case EDOTDOT: return "EDOTDOT";
#endif
case EBADMSG: return "EBADMSG";
case EOVERFLOW: return "EOVERFLOW";
#ifdef ENOTUNIQ
case ENOTUNIQ: return "ENOTUNIQ";
#endif
#ifdef EBADFD
case EBADFD: return "EBADFD";
#endif
#ifdef EREMCHG
case EREMCHG: return "EREMCHG";
#endif
#ifdef ELIBACC
case ELIBACC: return "ELIBACC";
#endif
#ifdef ELIBBAD
case ELIBBAD: return "ELIBBAD";
#endif
#ifdef ELIBSCN
case ELIBSCN: return "ELIBSCN";
#endif
#ifdef ELIBMAX
case ELIBMAX: return "ELIBMAX";
#endif
#ifdef ELIBEXEC
case ELIBEXEC: return "ELIBEXEC";
#endif
case EILSEQ: return "EILSEQ";
#ifdef ERESTART
case ERESTART: return "ERESTART";
#endif
#ifdef ESTRPIPE
case ESTRPIPE: return "ESTRPIPE";
#endif
case EUSERS: return "EUSERS";
case ENOTSOCK: return "ENOTSOCK";
case EDESTADDRREQ: return "EDESTADDRREQ";
case EMSGSIZE: return "EMSGSIZE";
case EPROTOTYPE: return "EPROTOTYPE";
case ENOPROTOOPT: return "ENOPROTOOPT";
case EPROTONOSUPPORT: return "EPROTONOSUPPORT";
case ESOCKTNOSUPPORT: return "ESOCKTNOSUPPORT";
case EOPNOTSUPP: return "EOPNOTSUPP";
case EPFNOSUPPORT: return "EPFNOSUPPORT";
case EAFNOSUPPORT: return "EAFNOSUPPORT";
case EADDRINUSE: return "EADDRINUSE";
case EADDRNOTAVAIL: return "EADDRNOTAVAIL";
case ENETDOWN: return "ENETDOWN";
case ENETUNREACH: return "ENETUNREACH";
case ENETRESET: return "ENETRESET";
case ECONNABORTED: return "ECONNABORTED";
case ECONNRESET: return "ECONNRESET";
case ENOBUFS: return "ENOBUFS";
case EISCONN: return "EISCONN";
case ENOTCONN: return "ENOTCONN";
case ESHUTDOWN: return "ESHUTDOWN";
case ETOOMANYREFS: return "ETOOMANYREFS";
case ETIMEDOUT: return "ETIMEDOUT";
case ECONNREFUSED: return "ECONNREFUSED";
case EHOSTDOWN: return "EHOSTDOWN";
case EHOSTUNREACH: return "EHOSTUNREACH";
case EALREADY: return "EALREADY";
case EINPROGRESS: return "EINPROGRESS";
case ESTALE: return "ESTALE";
#ifdef EUCLEAN
case EUCLEAN: return "EUCLEAN";
#endif
#ifdef ENOTNAM
case ENOTNAM: return "ENOTNAM";
#endif
#ifdef ENAVAIL
case ENAVAIL: return "ENAVAIL";
#endif
#ifdef EISNAM
case EISNAM: return "EISNAM";
#endif
#ifdef EREMOTEIO
case EREMOTEIO: return "EREMOTEIO";
#endif
case EDQUOT: return "EDQUOT";
#ifdef ENOMEDIUM
case ENOMEDIUM: return "ENOMEDIUM";
#endif
#ifdef EMEDIUMTYPE
case EMEDIUMTYPE: return "EMEDIUMTYPE";
#endif
case ECANCELED: return "ECANCELED";
#ifdef ENOKEY
case ENOKEY: return "ENOKEY";
#endif
#ifdef EKEYEXPIRED
case EKEYEXPIRED: return "EKEYEXPIRED";
#endif
#ifdef EKEYREVOKED
case EKEYREVOKED: return "EKEYREVOKED";
#endif
#ifdef EKEYREJECTED
case EKEYREJECTED: return "EKEYREJECTED";
#endif
case EOWNERDEAD: return "EOWNERDEAD";
case ENOTRECOVERABLE: return "ENOTRECOVERABLE";
#ifdef ERFKILL
case ERFKILL: return "ERFKILL";
#endif
#ifdef EHWPOISON
case EHWPOISON: return "EHWPOISON";
#endif
default: return std::to_string(e);
}
// LCOV_EXCL_STOP Coverage for these is not very useful.
}
inline size_t getDelimiterPosition(const char* message, const int length, const char delim)
{
if (message && length > 0)
{
const char *founddelim = static_cast<const char *>(std::memchr(message, delim, length));
const size_t size = (founddelim == nullptr ? length : founddelim - message);
return size;
}
return 0;
}
/// Return the position of sub-array @sub in array @data, if found, -1 otherwise.
inline int findSubArray(const char* data, const std::size_t dataLen, const char* sub,
const std::size_t subLen)
{
assert(subLen < std::numeric_limits<unsigned int>::max() &&
"Invalid sub-array length to find");
if (sub && subLen && dataLen >= subLen)
{
for (std::size_t i = 0; i < dataLen; ++i)
{
std::size_t j;
for (j = 0; j < subLen && i + j < dataLen && data[i + j] == sub[j]; ++j)
{
}
if (j >= subLen)
return i;
}
}
return -1;
}
inline
std::string getDelimitedInitialSubstring(const char *message, const int length, const char delim)
{
const size_t size = getDelimiterPosition(message, length, delim);
return std::string(message, size);
}
/// Eliminates the prefix from str(if present) and returns a copy of the modified string
inline
std::string eliminatePrefix(const std::string& str, const std::string& prefix)
{
std::string::const_iterator prefix_pos;
std::string::const_iterator str_pos;
std::tie(prefix_pos,str_pos) = std::mismatch(prefix.begin(), prefix.end(), str.begin());
if (prefix_pos == prefix.end())
{
// Non-Prefix part
return std::string(str_pos, str.end());
}
else
{
// Return the original string as it is
return str;
}
}
/// Split a string in two at the delimiter, removing it.
inline
std::pair<std::string, std::string> split(const char* s, const int length, const char delimiter = ' ', bool removeDelim = true)
{
const size_t size = getDelimiterPosition(s, length, delimiter);
std::string after;
int after_pos = size + (removeDelim? 1: 0);
if (after_pos < length)
after = std::string(s + after_pos, length - after_pos);
return std::make_pair(std::string(s, size), after);
}
/// Split a string in two at the delimiter, removing it.
inline
std::pair<std::string, std::string> split(const std::string& s, const char delimiter = ' ', bool removeDelim = true)
{
return split(s.c_str(), s.size(), delimiter, removeDelim);
}
/// Split a string in two at the delimiter.
inline
std::pair<std::string, std::string> splitLast(const char* s, const int length, const char delimiter = ' ', bool removeDelim = true)
{
const size_t size = getLastDelimiterPosition(s, length, delimiter);
std::string after;
int after_pos = size + (removeDelim? 1: 0);
if (after_pos < length)
after = std::string(s + after_pos, length - after_pos);
return std::make_pair(std::string(s, size), after);
}
/// Split a string in two at the delimiter, removing it.
inline
std::pair<std::string, std::string> splitLast(const std::string& s, const char delimiter = ' ', bool removeDelim = true)
{
return splitLast(s.c_str(), s.size(), delimiter, removeDelim);
}
/// Append a length bytes to a vector, or strlen of data as a C string if not provided
/// returns count of bytes appended.
inline void vectorAppend(std::vector<char> &vector, const char *data, ssize_t length = -1)
{
size_t vlen = vector.size();
if (!data)
{
return;
}
size_t dataLen = length;
if (length < 0)
dataLen = strlen(data);
vector.resize(vlen+dataLen);
std::memcpy(vector.data() + vlen, data, dataLen);
}
/// Append a number as hexadecimal to a vector
inline void vectorAppendHex(std::vector<char> &vector, uint64_t number)
{
char output[32];
snprintf(output, sizeof(output), "%" PRIx64, number);
vectorAppend(vector, output);
}
/// Splits a URL into path (with protocol), filename, extension, parameters.
/// All components are optional, depending on what the URL represents (can be a unix path).
std::tuple<std::string, std::string, std::string, std::string> splitUrl(const std::string& url);
/// Check for the URI scheme validity.
/// For now just a basic sanity check, can be extended if necessary.
bool isValidURIScheme(const std::string& scheme);
/// Check for the URI host validity.
/// For now just a basic sanity check, can be extended if necessary.
bool isValidURIHost(const std::string& host);
/// Encode a URI with the JS-compatible reserved characters.
std::string encodeURIComponent(const std::string& uri,
const std::string& reserved = ",/?:@&=+$#");
/// Decode a URI encoded with encodeURIComponent.
std::string decodeURIComponent(const std::string& uri);
/// Checks whether or not the given string is encoded.
/// That is, a string that is identical when encoded
/// will return false. Similarly, a string that is
/// already encoded will return false.
/// Optionally takes a string of reserved characters
/// to escape while encoding.
bool needsURIEncoding(const std::string& uri, const std::string& reserved = ",/?:@&=+$#");
/// Cleanup a filename replacing anything potentially problematic
/// either for a URL or for a file path
std::string cleanupFilename(const std::string &filename);
/// Anonymize a sensitive string to avoid leaking it.
/// Called on strings to be logged or exposed.
std::string anonymize(const std::string& text, const std::uint64_t nAnonymizationSalt);
/// Sets the anonymized version of a given plain-text string.
/// After this, 'anonymize(plain)' will return 'anonymized'.
void mapAnonymized(const std::string& plain, const std::string& anonymized);
/// Clears the shared state of mapAnonymized() / anonymize().
void clearAnonymized();
/// Anonymize the basename of filenames only, preserving the path and extension.
std::string anonymizeUrl(const std::string& url, const std::uint64_t nAnonymizationSalt);
/// Extract and return the filename given a url or path.
std::string getFilenameFromURL(const std::string& url);
/// Return true if the subject matches in given set. It uses regex
/// Mainly used to match WOPI hosts patterns
bool matchRegex(const std::set<std::string>& set, const std::string& subject);
/// Return value from key:value pair if the subject matches in given map. It uses regex
/// Mainly used to match WOPI hosts patterns
std::string getValue(const std::map<std::string, std::string>& map, const std::string& subject);
std::string getValue(const std::set<std::string>& set, const std::string& subject);
/// Given one or more patterns to allow, and one or more to deny,
/// the match member will return true if, and only if, the subject
/// matches the allowed list, but not the deny.
/// By default, everything is denied.
class RegexListMatcher
{
public:
RegexListMatcher() :
_allowByDefault(false)
{
}
RegexListMatcher(const bool allowByDefault) :
_allowByDefault(allowByDefault)
{
}
RegexListMatcher(std::initializer_list<std::string> allowed) :
_allowByDefault(false),
_allowed(allowed)
{
}
RegexListMatcher(std::initializer_list<std::string> allowed,
std::initializer_list<std::string> denied) :
_allowByDefault(false),
_allowed(allowed),
_denied(denied)
{
}
RegexListMatcher(const bool allowByDefault,
std::initializer_list<std::string> denied) :
_allowByDefault(allowByDefault),
_denied(denied)
{
}
void allow(const std::string& pattern) { _allowed.insert(pattern); }
void deny(const std::string& pattern)
{
_allowed.erase(pattern);
_denied.insert(pattern);
}
void clear()
{
_allowed.clear();
_denied.clear();
}
bool match(const std::string& subject) const
{
return (_allowByDefault ||
Util::matchRegex(_allowed, subject)) &&
!Util::matchRegex(_denied, subject);
}
// whether a match exist within both _allowed and _denied
bool matchExist(const std::string& subject) const
{
return (Util::matchRegex(_allowed, subject) ||
Util::matchRegex(_denied, subject));
}
bool empty() const
{
return _allowed.empty() && _denied.empty();
}
private:
const bool _allowByDefault;
std::set<std::string> _allowed;
std::set<std::string> _denied;
};
/// A logical constant that is allowed to initialize
/// exactly once and checks usage before initialization.
template <typename T>
class RuntimeConstant
{
T _value;
std::atomic<bool> _initialized;
public:
RuntimeConstant()
: _value()
, _initialized(false)
{
}
/// Use a compile-time const instead.
RuntimeConstant(const T& value) = delete;
const T& get()
{
if (_initialized)
{
return _value;
}
throw std::runtime_error("RuntimeConstant instance read before being initialized.");
}
void set(const T& value)
{
assert(!_initialized);
_initialized = true;
_value = value;
}
};
//// Return current time in HTTP format.
std::string getHttpTimeNow();
std::string getTimeNow(const char* format);
//// Return time in HTTP format.
std::string getHttpTime(std::chrono::system_clock::time_point time);
//// Return time in ISO8061 fraction format
std::string getIso8601FracformatTime(std::chrono::system_clock::time_point time);
/// Convert a time_point to iso8601 formatted string.
std::string time_point_to_iso8601(std::chrono::system_clock::time_point tp);
/// Convert time from ISO8061 fraction format
std::chrono::system_clock::time_point iso8601ToTimestamp(const std::string& iso8601Time, const std::string& logName);
/// A null-converter between two identical clocks.
template <typename Dst, typename Src, typename std::is_same<Src, Dst>::type>
Dst convertChronoClock(const Src time)
{
return std::chrono::time_point_cast<Dst>(time);
}
/// Converter between two different clocks,
/// such as system_clock and stead_clock.
/// Note: by nature this has limited accuracy.
template <typename Dst, typename Src, typename Enable = void>
Dst convertChronoClock(const Src time)
{
const auto before = Src::clock::now();
const auto now = Dst::clock::now();
const auto after = Src::clock::now();
const auto diff = after - before;
const auto correction = before + (diff / 2);
return std::chrono::time_point_cast<typename Dst::duration>(now + (time - correction));
}
/// Converts from system_clock to string for debugging / tracing.
/// Format (local time): Thu Jan 27 03:45:27.123 2022
std::string getSystemClockAsString(const std::chrono::system_clock::time_point &time);
/// conversion from steady_clock for debugging / tracing
/// Format (local time): Thu Jan 27 03:45:27.123 2022
inline std::string getSteadyClockAsString(const std::chrono::steady_clock::time_point& time)
{
return getSystemClockAsString(
convertChronoClock<std::chrono::system_clock::time_point>(time));
}
/// See getSystemClockAsString.
inline std::string getClockAsString(const std::chrono::system_clock::time_point& time)
{
return getSystemClockAsString(time);
}
/// See getSteadyClockAsString.
inline std::string getClockAsString(const std::chrono::steady_clock::time_point& time)
{
return getSteadyClockAsString(time);
}
template <typename U, typename T> std::string getTimeForLog(const U& now, const T& time)
{
const auto elapsed = now - convertChronoClock<U>(time);
const auto elapsedS = std::chrono::duration_cast<std::chrono::seconds>(elapsed);
const auto elapsedMS =
std::chrono::duration_cast<std::chrono::milliseconds>(elapsed) - elapsedS;
std::stringstream ss;
ss << getClockAsString(time) << " (" << elapsedS << ' ' << elapsedMS << " ago)";
return ss.str();
}
/**
* Avoid using the configuration layer and rely on defaults which is only useful for special
* test tool targets (typically fuzzing) where start-up speed is critical.
*/
bool isFuzzing();
bool isMobileApp();
void setKitInProcess(bool value);
bool isKitInProcess();
/**
* Splits string into vector<string>. Does not accept referenced variables for easy
* usage like (splitString("test", ..)) or (splitString(getStringOnTheFly(), ..))
*/
//FIXME: merge with StringVector.
inline std::vector<std::string> splitStringToVector(const std::string& str, const char delim)
{
size_t start;
size_t end = 0;
std::vector<std::string> result;
while ((start = str.find_first_not_of(delim, end)) != std::string::npos)
{
end = str.find(delim, start);
result.emplace_back(str.substr(start, end - start));
}
return result;
}
void setApplicationPath(const std::string& path);
std::string getApplicationPath();
/**
* Converts vector of strings to map. Strings should have formed like this: key + delimiter + value.
* In case of a misformed string or zero length vector, passes that item and warns the developer.
*/
std::map<std::string, std::string> stringVectorToMap(const std::vector<std::string>& strvector, const char delimiter);
// If OS is not mobile, it must be Linux.
std::string getLinuxVersion();
/// Convert a string to 32-bit signed int.
/// Returns the parsed value and a boolean indicating success or failure.
inline std::pair<std::int32_t, bool> i32FromString(const std::string& input)
{
const char* str = input.data();
char* endptr = nullptr;
errno = 0;
const auto value = std::strtol(str, &endptr, 10);
return std::make_pair(value, endptr > str && errno != ERANGE);
}
/// Convert a string to 32-bit signed int. On failure, returns the default
/// value, and sets the bool to false (to signify that parsing had failed).
inline std::pair<std::int32_t, bool> i32FromString(const std::string& input,
const std::int32_t def)
{
const auto pair = i32FromString(input);
return pair.second ? pair : std::make_pair(def, false);
}
/// Convert a string to 64-bit unsigned int.
/// Returns the parsed value and a boolean indicating success or failure.
inline std::pair<std::uint64_t, bool> u64FromString(const std::string& input)
{
const char* str = input.data();
char* endptr = nullptr;
errno = 0;
const auto value = std::strtoul(str, &endptr, 10);
return std::make_pair(value, endptr > str && errno != ERANGE);
}
/// Convert a string to 64-bit unsigned int. On failure, returns the default
/// value, and sets the bool to false (to signify that parsing had failed).
inline std::pair<std::uint64_t, bool> u64FromString(const std::string& input,
const std::uint64_t def)
{
const auto pair = u64FromString(input);
return pair.second ? pair : std::make_pair(def, false);
}
/// Converts and returns the argument to lower-case.
inline std::string toLower(std::string s)
{
std::transform(s.begin(), s.end(), s.begin(), ::tolower);
return s;
}
/// Case insensitive comparison of two strings.
/// Returns true iff the two strings are equal, regardless of case.
inline bool iequal(const char* lhs, std::size_t lhs_len, const char* rhs, std::size_t rhs_len)
{
return ((lhs_len == rhs_len)
&& std::equal(lhs, lhs + lhs_len, rhs, [](const char lch, const char rch) {
return std::tolower(lch) == std::tolower(rch);
}));
}
/// Case insensitive comparison of two strings.
template <std::size_t N> inline bool iequal(const std::string& lhs, const char (&rhs)[N])
{
return iequal(lhs.c_str(), lhs.size(), rhs, N - 1); // Minus null termination.
}
/// Case insensitive comparison of two strings.
inline bool iequal(const std::string& lhs, const std::string& rhs)
{
return iequal(lhs.c_str(), lhs.size(), rhs.c_str(), rhs.size());
}
/// Get system_clock now in milliseconds.
inline int64_t getNowInMS()
{
return std::chrono::time_point_cast<std::chrono::milliseconds>(std::chrono::system_clock::now()).time_since_epoch().count();
}
/// Convert a vector to a string. Useful for conversion in templates.
template <typename T> inline std::string toString(const T& x)
{
std::ostringstream oss;
oss << x;
return oss.str();
}
/// Convert a vector to a string. Useful for conversion in templates.
inline std::string toString(const std::vector<char>& x)
{
return std::string(x.data(), x.size());
}
/// No-op string conversion. Useful for conversion in templates.
inline std::string toString(const std::string& s) { return s; }
/// Create a string from a literal. Useful for conversion in templates.
template <std::size_t N> inline std::string toString(const char (&s)[N])
{
return std::string(s);
}
/// Concatenate the given elements in a container to each other using
/// the delimiter of choice.
template <typename T, typename U = const char*>
inline std::string join(const T& elements, const U& delimiter = ", ")
{
std::ostringstream oss;
bool first = true;
for (const auto& elem : elements)
{
if (!first)
{
oss << delimiter;
}
oss << elem;
first = false;
}
return oss.str();
}
/// Dump an object that supports .dumpState into a string.
/// Helpful for logging.
template <typename T> std::string dump(const T& object, const std::string& indent = ", ")
{
std::ostringstream oss;
object.dumpState(oss, indent);
return oss.str().substr(indent.size());
}
/// Stringify elements from a container of pairs with a delimiter to a stream.
template <typename S, typename T>
void joinPair(S& stream, const T& container, const char* delimiter = " / ")
{
unsigned i = 0;
for (const auto& pair : container)
{
stream << (i++ ? delimiter : "") << pair;
}
}
/// Stringify elements from a container of pairs with a delimiter to string.
template <typename T> std::string joinPair(const T& container, const char* delimiter = " / ")
{
std::ostringstream oss;
joinPair(oss, container, delimiter);
return oss.str();
}
/// Asserts in the debug builds, otherwise just logs.
void assertCorrectThread(std::thread::id owner, const char* fileName, int lineNo);
#ifndef ASSERT_CORRECT_THREAD
#define ASSERT_CORRECT_THREAD() assertCorrectThread(__FILE__, __LINE__)
#endif
#ifndef ASSERT_CORRECT_THREAD_OWNER
#define ASSERT_CORRECT_THREAD_OWNER(OWNER) Util::assertCorrectThread(OWNER, __FILE__, __LINE__)
#endif
/**
* Similar to std::atoi() but does not require p to be null-terminated.
*
* Returns std::numeric_limits<int>::min/max() if the result would overflow.
*/
int safe_atoi(const char* p, int len);
/// Close logs and forcefully exit with the given exit code.
/// This calls std::_Exit, which terminates the program without cleaning up
/// static instances (i.e. anything registered with `atexit' or `on_exit').
// coverity[+kill]
void forcedExit(int code) __attribute__ ((__noreturn__));
// std::size isn't available on our android baseline so use this
// solution as a workaround
template <typename T, size_t S> char (&n_array_size( T(&)[S] ))[S];
#define N_ELEMENTS(arr) (sizeof(Util::n_array_size(arr)))
} // end namespace Util
inline std::ostream& operator<<(std::ostream& os, const std::chrono::system_clock::time_point& ts)
{
os << Util::getIso8601FracformatTime(ts);
return os;
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
Reference in New Issue View Git Blame Copy Permalink