source: cpp/frams/util/sstringutils.cpp @ 1299

// This file is a part of Framsticks SDK.  http://www.framsticks.com/
// Copyright (C) 1999-2022  Maciej Komosinski and Szymon Ulatowski.
// See LICENSE.txt for details.

#include "sstringutils.h"
#include <common/virtfile/virtfile.h>
#include <common/log.h>
#include <common/nonstd.h>
#include <common/Convert.h>
#include <common/nonstd_span.h>

int loadSString(const char* filename, SString& s, const char* framsgmodule, const char* error, bool remove_cr)
{
        VirtFILE *f;
        int ret = 0;
        if (f = Vfopen(filename, FOPEN_READ_BINARY))
        {
                loadSString(f, s, remove_cr);
                ret = 1;
                delete f;
        }
        else if (framsgmodule)
                logPrintf(framsgmodule, "loadSString", LOG_WARN, error ? error : "Can't open file \"%s\"", filename);
        return ret;
}

void loadSString(VirtFILE *f, SString& s, bool remove_cr)
{
        char buf[1024];
        int len;
        while (!f->Veof())
        {
                len = (int)f->Vread(buf, 1, sizeof(buf));
                s.append(buf, len);
        }
        if (remove_cr)
                removeCR(s);
}

//load single line, discarding any \r or \n found at the end, return false if nothing could be loaded (error or eof)
bool loadSStringLine(VirtFILE* f, SString& s)
{
        char buf[100];
        bool eolfound = false;
        bool ret = false;
        s = SString::empty();
        while (!eolfound)
        {
                char *r = f->Vgets(buf, sizeof(buf));
                if (r == NULL) break;
                ret = true;
                int d = (int)strlen(r);
                if (d > 0)
                {
                        if (r[d - 1] == '\n') { d--; eolfound = true; }
                        if (d > 0) if (r[d - 1] == '\r') d--;
                        s += SString(r, d);
                }
        }
        return ret;
}

//////////////////////////

/** "x~xx~xxx" -> "x\~xx\~xxx"  */
int quoteTilde(SString &target)
{
        const char* x = target.c_str();
        SString tmp;
        char *f;
        while (1)
        {
                f = strchr((char*)x, '~');
                if (f)
                {
                        tmp.append(x, f - x);
                        tmp += "\\~";
                        x = f + 1;
                }
                else
                {
                        if (tmp.length() == 0) return 0; // nothing was changed!
                        tmp += x;
                        target = tmp;
                        return 1;
                }
        }
}

/** "x\~xx\~xxx" -> "x~xx~xxx"  */
int unquoteTilde(SString &target)
{
        const char* x = target.c_str();
        SString tmp;
        char *f;
        while (1)
        {
                f = strchr((char*)x, '\\');
                if (f)
                {
                        tmp.append(x, f - x);
                        if (f[1] == '~')
                        {
                                tmp += '~';
                                x = f + 2;
                        }
                        else
                        {
                                tmp += "\\";
                                x = f + 1;
                        }
                }
                else
                {
                        if (tmp.length() == 0) return 0; // nothing was changed!
                        tmp += x;
                        target = tmp;
                        return 1;
                }
        }
}

/////////////////

bool strContainsOneOf(const char* str, const char* chars)
{
        while (*str)
        {
                if (strchr(chars, *str)) return 1;
                str++;
        }
        return 0;
}

//////////////

bool sstringQuote(SString& target)
{
        const char* x = target.c_str();
        bool changed = 0;
        SString tmp;
        tmp.reserve(target.length());
        while (*x)
        {
                switch (*x)
                {
                case '\n': tmp += "\\n"; changed = 1; break;
                case '\r': tmp += "\\r"; changed = 1; break;
                case '\t': tmp += "\\t"; changed = 1; break;
                case '\"': tmp += "\\\""; changed = 1; break;
                case '\\': tmp += "\\\\"; changed = 1; break;
                default: tmp += *x;
                }
                x++;
        }
        if (changed) target = tmp;
        return changed;
}

SString sstringDelimitAndShorten(const SString &in, int maxlen, bool show_length, const SString& before, const SString& after)
{
        SString out;
        if (in.length() > maxlen)
                out = in.substr(0, maxlen / 2) + "..." + in.substr(in.length() - maxlen + maxlen / 2);
        else
        {
                out = in; show_length = false;
        }
        sstringQuote(out);
        out = before + out + after;
        if (show_length)
                out += SString::sprintf(" (length %d)", in.length());
        return out;
}

const char* skipQuoteString(const char* txt, const char* limit)
{
        while (*txt)
        {
                if (*txt == '\"') return txt;
                if (*txt == '\\') txt++;
                txt++;
                if (txt == limit) break;
        }
        return txt;
}

int sstringUnquote(SString &target)
{
        const char* x = target.c_str();
        SString tmp;
        char *f;
        while (1)
        {
                f = strchr((char*)x, '\\');
                if (f)
                {
                        tmp.append(x, f - x);
                        switch (f[1])
                        {
                        case 'n': tmp += '\n'; break;
                        case 'r': tmp += '\r'; break;
                        case 't': tmp += '\t'; break;
                        case '\"': tmp += '\"'; break;
                        default: tmp += f[1];
                        }
                        x = f + 2;
                }
                else
                {
                        if (tmp.length() == 0) return 0; // nothing was changed!
                        tmp += x;
                        target = tmp;
                        return 1;
                }
        }
}

int strFindField(const SString& txt, const SString& name, int &end)
{
        const char* t = txt.c_str(), *n;
        int pos = 0;
        while (1)
        {
                n = strchr(t + pos, ',');
                if ((!strncmp(t + pos, name.c_str(), name.length())) && (t[pos + name.length()] == '='))
                {
                        if (n) end = n - t; else end = txt.length();
                        return pos;
                }
                if (n) pos = n - t + 1; else break;
        }
        return -1;
}

SString strGetField(const SString& txt, const SString& name)
{
        int p, e;
        p = strFindField(txt, name, e);
        if (p < 0) return SString();
        p += name.length() + 1;
        return SString(txt.substr(p, e - p));
}

void strSetField(SString& txt, const SString& name, const SString& value)
{
        int p, e;
        p = strFindField(txt, name, e);
        if (p < 0)
        {
                if (!value.length()) return;
                char *t = txt.directAppend(1 + name.length() + value.length());
                char *b = t;
                if (txt.length()) *(t++) = ',';
                strcpy(t, name.c_str()); t += name.length();
                *(t++) = '=';
                strcpy(t, value.c_str()); t += value.length();
                txt.endAppend(t - b);
        }
        else
        {
                if (!value.length())
                {
                        if (p > 0) p--; else if (e < txt.length()) e++;
                        char *t = txt.directWrite(0);
                        memmove(t + p, t + e, txt.length() - e);
                        txt.endWrite(txt.length() + value.length() - (e - p));
                }
                else
                {
                        p += name.length() + 1;
                        char *t = txt.directWrite(txt.length() + value.length() - (e - p));
                        memmove(t + p + value.length(), t + e, txt.length() - e);
                        memmove(t + p, value.c_str(), value.length());
                        txt.endWrite(txt.length() + value.length() - (e - p));
                }
        }
}

SString trim(const SString& s)
{
        const unsigned char*b = (const unsigned char*)s.c_str();
        const unsigned char*e = b + s.length();
        while ((b < e) && (*b <= ' ')) b++;
        while ((b < e) && (e[-1] <= ' ')) e--;
        if ((e - b) == s.length()) return s;
        SString newstring;
        char* t = newstring.directWrite(e - b);
        memmove(t, b, e - b);
        newstring.endWrite(e - b);
        return newstring;
}

SString concatPath(const SString& in1, const SString& in2)
{
        SString out = in1;
        if (out.length() > 0 && out[out.length() - 1] != PATH_SEPARATOR_CHAR)
                out += PATH_SEPARATOR_CHAR;
        out += in2;
        return out;
}

bool removeCR(SString& s)
{
        const char* p = s.c_str();
        const char* cr = strchr(p, '\r');
        if (!cr) return false;
        char* begin = s.directWrite();
        char* src = begin + (cr - p), *dst = src;
        while (*src)
                if (*src == '\r')
                        src++;
                else
                        *(dst++) = *(src++);
        s.endWrite(dst - begin);
        return true;
}

bool matchWildcard(const SString& word, const SString& pattern)
{
        if (pattern.length() == 0)
                return word.length() == 0;
        int aster = pattern.indexOf('*');
        if (aster >= 0)
        {
                SString before = pattern.substr(0, aster);
                SString after = pattern.substr(aster + 1);
                if (!word.length()) return false;
                if (before.length()) if (!word.startsWith(before.c_str())) return false;
                if (after.length())
                        if ((word.length() < after.length())
                                || (strcmp(after.c_str(), word.c_str() + word.length() - after.length())))
                                return false;
                return true;
        }
        else
                return word == pattern;
}

bool matchWildcardList(const SString& word, const SString& patterns)
{
        if (patterns.length() == 0)
                return word.length() == 0;
        int pos = 0;
        SString pattern;
        while (patterns.getNextToken(pos, pattern, ','))
                if (matchWildcard(word, pattern))
                        return true;
        return false;
}

SString getUIDString(uint64_t uid, char prefix)
{
        return SString::sprintf("%c" UINT64_FORMAT, prefix, uid);
}

bool parseUIDString(const char* str, char prefix, uint64_t &uid, bool err)
{
        if ((str[0] == prefix) && (isdigit(str[1])))
        {
                char* end;
                uid = strtoull(str + 1, &end, 10);
                if (end == (str + 1 + strlen(str + 1)))
                        return true;
        }
        if (err)
                logPrintf("SString", "parseUIDString", LOG_ERROR, "Invalid uid: '%s'", str);
        return false;
}

bool sstringURLEncode(SString& target)
{
        const char* x = target.c_str();
        bool changed = 0;
        SString tmp;
        tmp.reserve(target.length());
        static constexpr const char* ALLOWED_CHARS = "-_.~";
        for (; *x; x++)
        {
                if (!(isalnum(*x) || strchr(ALLOWED_CHARS, *x)))
                {
                        tmp += "%";
                        tmp += SString::sprintf("%02x", *x);
                        changed = 1;
                }
                else
                        tmp += *x;
        }
        if (changed) target = tmp;
        return changed;
}

bool sstringURLDecode(SString &target)
{
        const char* x = target.c_str();
        SString tmp;
        char *f;
        while (1)
        {
                f = strchr((char*)x, '%');
                if (f)
                {
                        tmp.append(x, f - x);
                        char hex[3] = { f[1],f[2],0 };
                        char* after;
                        unsigned long intvalue = strtoul(hex, &after, 16);
                        tmp += (char)intvalue;
                        x = f + 3;
                }
                else
                {
                        if (tmp.length() == 0) return false; // nothing was changed!
                        tmp += x;
                        target = tmp;
                        return true;
                }
        }
}

static span<char> findEof(span<char> field, const char* pos) // 'eof' includes any number of leading '\'s and is only detected when there is nothing else in the line
{
        const char* eof = strstr(pos, "eof");
        if (!eof)
                return span<char>();

        if (!(((eof + 3) == field.end()) || (eof[3] == '\n')))
                return span<char>();

        const char* begin = eof - 1;
        for (; begin >= field.begin(); begin--)
        {
                if (*begin == '\n')
                        break;
                if (*begin != '\\')
                        return span<char>();
        }

        return span<char>((char*)(begin + 1), (eof + 3) - (begin + 1));
}

bool sstringQuoteEOF(SString& target)
{
        span<char> field((char*)target.c_str(), target.size());
        const char* pos = field.begin();

        bool changed = false;

        SString tmp;

        while (true)
        {
                auto eof = findEof(field, pos);
                if (eof.size())
                {
                        if (!changed)
                        {
                                tmp.reserve(target.length() + 10);
                                changed = true;
                        }
                        tmp.append(pos, eof.begin() - pos);
                        tmp += "\\";
                        tmp.append(eof.begin(), (int)eof.size());
                        pos = eof.end();
                }
                else
                {
                        if (!changed)
                                return false;
                        tmp.append(pos, field.end() - pos);
                        break;
                }
        }

        target = tmp;
        return true;
}

bool sstringUnquoteEOF(SString& target)
{
        span<char> field((char*)target.c_str(), target.size());
        const char* pos = field.begin();

        bool changed = false;

        SString tmp;

        while (true)
        {
                auto eof = findEof(field, pos);
                if (eof.size() > 3)
                {
                        if (!changed)
                        {
                                tmp.reserve(target.length());
                                changed = true;
                        }
                        tmp.append(pos, eof.begin() - pos);
                        tmp.append(eof.begin() + 1, (int)eof.size() - 1);
                        pos = eof.end();
                }
                else
                {
                        if (eof.size() == 3) //size()==3 means bare 'eof', which cannot be unquoted (and means something went wrong somewhere else)
                                logPrintf("String", "unquoteEof", LOG_WARN, "Unexpected bare \"eof\" line");
                        if (!changed)
                                return false;
                        tmp.append(pos, field.end() - pos);
                        break;
                }
        }

        target = tmp;
        return true;
}