utils_8h_source.html

#ifndef MANTIS_UTILS_H

#define MANTIS_UTILS_H


#include <string>

#include <filesystem>

#include <random>

#include <chrono>

#include <string_view>

#include <algorithm>

#include <soci/row.h>


#include "../core/logging.h"


namespace mantis

{

    namespace fs = std::filesystem;


    // ----------------------------------------------------------------- //

    // PATH UTILS

    // ----------------------------------------------------------------- //


    fs::path joinPaths(const std::string& path1, const std::string& path2);


    fs::path resolvePath(const std::string& input_path);


    bool createDirs(const fs::path& path);


    std::string dirFromPath(const std::string& path);


    // ----------------------------------------------------------------- //

    // STRING UTILS

    // ----------------------------------------------------------------- //

    void toLowerCase(std::string& str);


    void toUpperCase(std::string& str);


    std::string trim(const std::string& s);


    std::optional<json> tryParseJsonStr(const std::string& json_str);


    bool strToBool(const std::string& value);


    std::string generateTimeBasedId();


    std::string generateReadableTimeId();


    std::string generateShortId(size_t length = 16);


    std::vector<std::string> splitString(const std::string& input, const std::string& delimiter);


    std::string getEnvOrDefault(const std::string& key, const std::string& defaultValue);


    static bool invalidChar(unsigned char c);


    static void sanitizeInPlace(std::string& s);


    std::string sanitizeFilename(std::string_view original,

                                 std::size_t maxLen = 50,

                                 std::size_t idLen = 12,

                                 std::string_view idSep = "_");


    // ----------------------------------------------------------------- //

    // AUTH UTILS

    // ----------------------------------------------------------------- //

    std::string bcryptBase64Encode(const unsigned char* data, size_t len);


    std::string generateSalt(int cost = 12);


    json hashPassword(const std::string& password);


    json verifyPassword(const std::string& password, const std::string& stored_hash);


    // ----------------------------------------------------------------- //

    // AUTH UTILS

    // ----------------------------------------------------------------- //


    std::string tmToStr(const std::tm& t);

    std::tm strToTM(const std::string& value);

    std::string dbDateToString(const std::string& dbType, const soci::row& row, int index);


}


#endif // MANTIS_UTILS_H

json
nlohmann::json json
Definition mantis.h:35

mantis
router.h
Definition app.h:31

mantis::hashPassword
json hashPassword(const std::string &password)
Digests user password + a generated salt to yield a hashed password.
Definition auth_utils.cpp:49

mantis::generateTimeBasedId
std::string generateTimeBasedId()
Generate a time base UUID.
Definition string_utils.cpp:51

mantis::generateReadableTimeId
std::string generateReadableTimeId()
Generates a readable time-based UUID.
Definition string_utils.cpp:68

mantis::joinPaths
fs::path joinPaths(const std::string &path1, const std::string &path2)
< Use shorthand fs to refer to the std::filesystem
Definition path_utils.cpp:8

mantis::getEnvOrDefault
std::string getEnvOrDefault(const std::string &key, const std::string &defaultValue)
Retrieves a value from an environment variable or a default value if the env variable was not set.
Definition string_utils.cpp:122

mantis::dbDateToString
std::string dbDateToString(const std::string &dbType, const soci::row &row, int index)
Definition type_utils.cpp:29

mantis::strToTM
std::tm strToTM(const std::string &value)
Definition type_utils.cpp:17

mantis::createDirs
bool createDirs(const fs::path &path)
Create directory, given a path.
Definition path_utils.cpp:27

mantis::sanitizeFilename
std::string sanitizeFilename(std::string_view original, std::size_t maxLen=50, std::size_t idLen=12, std::string_view idSep="_")
Sanitize a filename and ensure uniqueness.
Definition string_utils.cpp:177

mantis::generateSalt
std::string generateSalt(int cost=12)
Generates a salt to be used in hashing user passwords.
Definition auth_utils.cpp:35

mantis::trim
std::string trim(const std::string &s)
Trims leading and trailing whitespaces from a string.
Definition string_utils.cpp:44

mantis::tmToStr
std::string tmToStr(const std::tm &t)
Convert c++ std::tm date/time value to ISO formatted string.
Definition type_utils.cpp:9

mantis::tryParseJsonStr
std::optional< json > tryParseJsonStr(const std::string &json_str)
Attempt to parse a JSON string.
Definition string_utils.cpp:11

mantis::generateShortId
std::string generateShortId(size_t length=16)
Generates a short UUID.
Definition string_utils.cpp:90

mantis::bcryptBase64Encode
std::string bcryptBase64Encode(const unsigned char *data, size_t len)
Encode a Salt string to bcrypt base64 format.
Definition auth_utils.cpp:14

mantis::toUpperCase
void toUpperCase(std::string &str)
Converts a string to its uppercase variant.
Definition string_utils.cpp:38

mantis::dirFromPath
std::string dirFromPath(const std::string &path)
Returns a created/existing directory from a path.
Definition path_utils.cpp:46

mantis::resolvePath
fs::path resolvePath(const std::string &input_path)
Definition path_utils.cpp:14

mantis::verifyPassword
json verifyPassword(const std::string &password, const std::string &stored_hash)
Verifies user password if it matches the given hashed password.
Definition auth_utils.cpp:85

mantis::strToBool
bool strToBool(const std::string &value)
Convert given string value to boolean type.
Definition string_utils.cpp:25

mantis::toLowerCase
void toLowerCase(std::string &str)
Converts a string to its lowercase variant.
Definition string_utils.cpp:32

mantis::splitString
std::vector< std::string > splitString(const std::string &input, const std::string &delimiter)
Split given string based on given delimiter.
Definition string_utils.cpp:106