]> git.lizzy.rs Git - minetest.git/blobdiff - src/util/string.cpp
GUIScene: Clear depth buffer + replace deprecated clearZBuffer calls
[minetest.git] / src / util / string.cpp
index 481e74dad98fd6dd43c74dd08bb2dc1e95a42499..611ad35cbd32d428f3da773c32a0522a09fef5df 100644 (file)
@@ -1,6 +1,6 @@
 /*
-Minetest-c55
-Copyright (C) 2010-2012 celeron55, Perttu Ahola <celeron55@gmail.com>
+Minetest
+Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
 
 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU Lesser General Public License as published by
@@ -18,39 +18,273 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 */
 
 #include "string.h"
+#include "pointer.h"
+#include "numeric.h"
+#include "log.h"
 
-#include "../sha1.h"
-#include "../base64.h"
+#include "hex.h"
+#include "porting.h"
+#include "translation.h"
 
-// Get an sha-1 hash of the player's name combined with
-// the password entered. That's what the server uses as
-// their password. (Exception : if the password field is
-// blank, we send a blank password - this is for backwards
-// compatibility with password-less players).
-std::string translatePassword(std::string playername, std::wstring password)
+#include <algorithm>
+#include <array>
+#include <sstream>
+#include <iomanip>
+#include <map>
+
+#ifndef _WIN32
+       #include <iconv.h>
+#else
+       #define _WIN32_WINNT 0x0501
+       #include <windows.h>
+#endif
+
+#if defined(_ICONV_H_) && (defined(__FreeBSD__) || defined(__NetBSD__) || \
+       defined(__OpenBSD__) || defined(__DragonFly__))
+       #define BSD_ICONV_USED
+#endif
+
+static bool parseHexColorString(const std::string &value, video::SColor &color,
+               unsigned char default_alpha = 0xff);
+static bool parseNamedColorString(const std::string &value, video::SColor &color);
+
+#ifndef _WIN32
+
+static bool convert(const char *to, const char *from, char *outbuf,
+               size_t *outbuf_size, char *inbuf, size_t inbuf_size)
+{
+       iconv_t cd = iconv_open(to, from);
+
+#ifdef BSD_ICONV_USED
+       const char *inbuf_ptr = inbuf;
+#else
+       char *inbuf_ptr = inbuf;
+#endif
+       char *outbuf_ptr = outbuf;
+
+       size_t *inbuf_left_ptr = &inbuf_size;
+
+       const size_t old_outbuf_size = *outbuf_size;
+       size_t old_size = inbuf_size;
+       while (inbuf_size > 0) {
+               iconv(cd, &inbuf_ptr, inbuf_left_ptr, &outbuf_ptr, outbuf_size);
+               if (inbuf_size == old_size) {
+                       iconv_close(cd);
+                       return false;
+               }
+               old_size = inbuf_size;
+       }
+
+       iconv_close(cd);
+       *outbuf_size = old_outbuf_size - *outbuf_size;
+       return true;
+}
+
+#ifdef __ANDROID__
+// On Android iconv disagrees how big a wchar_t is for whatever reason
+const char *DEFAULT_ENCODING = "UTF-32LE";
+#else
+const char *DEFAULT_ENCODING = "WCHAR_T";
+#endif
+
+std::wstring utf8_to_wide(const std::string &input)
+{
+       const size_t inbuf_size = input.length();
+       // maximum possible size, every character is sizeof(wchar_t) bytes
+       size_t outbuf_size = input.length() * sizeof(wchar_t);
+
+       char *inbuf = new char[inbuf_size]; // intentionally NOT null-terminated
+       memcpy(inbuf, input.c_str(), inbuf_size);
+       std::wstring out;
+       out.resize(outbuf_size / sizeof(wchar_t));
+
+#ifdef __ANDROID__
+       SANITY_CHECK(sizeof(wchar_t) == 4);
+#endif
+
+       char *outbuf = reinterpret_cast<char*>(&out[0]);
+       if (!convert(DEFAULT_ENCODING, "UTF-8", outbuf, &outbuf_size, inbuf, inbuf_size)) {
+               infostream << "Couldn't convert UTF-8 string 0x" << hex_encode(input)
+                       << " into wstring" << std::endl;
+               delete[] inbuf;
+               return L"<invalid UTF-8 string>";
+       }
+       delete[] inbuf;
+
+       out.resize(outbuf_size / sizeof(wchar_t));
+       return out;
+}
+
+std::string wide_to_utf8(const std::wstring &input)
+{
+       const size_t inbuf_size = input.length() * sizeof(wchar_t);
+       // maximum possible size: utf-8 encodes codepoints using 1 up to 4 bytes
+       size_t outbuf_size = input.length() * 4;
+
+       char *inbuf = new char[inbuf_size]; // intentionally NOT null-terminated
+       memcpy(inbuf, input.c_str(), inbuf_size);
+       std::string out;
+       out.resize(outbuf_size);
+
+       if (!convert("UTF-8", DEFAULT_ENCODING, &out[0], &outbuf_size, inbuf, inbuf_size)) {
+               infostream << "Couldn't convert wstring 0x" << hex_encode(inbuf, inbuf_size)
+                       << " into UTF-8 string" << std::endl;
+               delete[] inbuf;
+               return "<invalid wide string>";
+       }
+       delete[] inbuf;
+
+       out.resize(outbuf_size);
+       return out;
+}
+
+#else // _WIN32
+
+std::wstring utf8_to_wide(const std::string &input)
+{
+       size_t outbuf_size = input.size() + 1;
+       wchar_t *outbuf = new wchar_t[outbuf_size];
+       memset(outbuf, 0, outbuf_size * sizeof(wchar_t));
+       MultiByteToWideChar(CP_UTF8, 0, input.c_str(), input.size(),
+               outbuf, outbuf_size);
+       std::wstring out(outbuf);
+       delete[] outbuf;
+       return out;
+}
+
+std::string wide_to_utf8(const std::wstring &input)
+{
+       size_t outbuf_size = (input.size() + 1) * 6;
+       char *outbuf = new char[outbuf_size];
+       memset(outbuf, 0, outbuf_size);
+       WideCharToMultiByte(CP_UTF8, 0, input.c_str(), input.size(),
+               outbuf, outbuf_size, NULL, NULL);
+       std::string out(outbuf);
+       delete[] outbuf;
+       return out;
+}
+
+#endif // _WIN32
+
+wchar_t *utf8_to_wide_c(const char *str)
+{
+       std::wstring ret = utf8_to_wide(std::string(str));
+       size_t len = ret.length();
+       wchar_t *ret_c = new wchar_t[len + 1];
+       memcpy(ret_c, ret.c_str(), (len + 1) * sizeof(wchar_t));
+       return ret_c;
+}
+
+
+std::string urlencode(const std::string &str)
+{
+       // Encodes non-unreserved URI characters by a percent sign
+       // followed by two hex digits. See RFC 3986, section 2.3.
+       static const char url_hex_chars[] = "0123456789ABCDEF";
+       std::ostringstream oss(std::ios::binary);
+       for (unsigned char c : str) {
+               if (isalnum(c) || c == '-' || c == '.' || c == '_' || c == '~') {
+                       oss << c;
+               } else {
+                       oss << "%"
+                               << url_hex_chars[(c & 0xf0) >> 4]
+                               << url_hex_chars[c & 0x0f];
+               }
+       }
+       return oss.str();
+}
+
+std::string urldecode(const std::string &str)
 {
-       if(password.length() == 0)
-               return "";
+       // Inverse of urlencode
+       std::ostringstream oss(std::ios::binary);
+       for (u32 i = 0; i < str.size(); i++) {
+               unsigned char highvalue, lowvalue;
+               if (str[i] == '%' &&
+                               hex_digit_decode(str[i+1], highvalue) &&
+                               hex_digit_decode(str[i+2], lowvalue)) {
+                       oss << (char) ((highvalue << 4) | lowvalue);
+                       i += 2;
+               } else {
+                       oss << str[i];
+               }
+       }
+       return oss.str();
+}
+
+u32 readFlagString(std::string str, const FlagDesc *flagdesc, u32 *flagmask)
+{
+       u32 result = 0;
+       u32 mask = 0;
+       char *s = &str[0];
+       char *flagstr;
+       char *strpos = nullptr;
+
+       while ((flagstr = strtok_r(s, ",", &strpos))) {
+               s = nullptr;
+
+               while (*flagstr == ' ' || *flagstr == '\t')
+                       flagstr++;
 
-       std::string slt = playername + wide_to_narrow(password);
-       SHA1 sha1;
-       sha1.addBytes(slt.c_str(), slt.length());
-       unsigned char *digest = sha1.getDigest();
-       std::string pwd = base64_encode(digest, 20);
-       free(digest);
-       return pwd;
+               bool flagset = true;
+               if (!strncasecmp(flagstr, "no", 2)) {
+                       flagset = false;
+                       flagstr += 2;
+               }
+
+               for (int i = 0; flagdesc[i].name; i++) {
+                       if (!strcasecmp(flagstr, flagdesc[i].name)) {
+                               mask |= flagdesc[i].flag;
+                               if (flagset)
+                                       result |= flagdesc[i].flag;
+                               break;
+                       }
+               }
+       }
+
+       if (flagmask)
+               *flagmask = mask;
+
+       return result;
 }
 
-size_t curl_write_data(char *ptr, size_t size, size_t nmemb, void *userdata) {
-    std::ostringstream *stream = (std::ostringstream*)userdata;
-    size_t count = size * nmemb;
-    stream->write(ptr, count);
-    return count;
+std::string writeFlagString(u32 flags, const FlagDesc *flagdesc, u32 flagmask)
+{
+       std::string result;
+
+       for (int i = 0; flagdesc[i].name; i++) {
+               if (flagmask & flagdesc[i].flag) {
+                       if (!(flags & flagdesc[i].flag))
+                               result += "no";
+
+                       result += flagdesc[i].name;
+                       result += ", ";
+               }
+       }
+
+       size_t len = result.length();
+       if (len >= 2)
+               result.erase(len - 2, 2);
+
+       return result;
 }
 
-char *mystrtok_r(char *s, const char *sep, char **lasts) {
+size_t mystrlcpy(char *dst, const char *src, size_t size)
+{
+       size_t srclen  = strlen(src) + 1;
+       size_t copylen = MYMIN(srclen, size);
+
+       if (copylen > 0) {
+               memcpy(dst, src, copylen);
+               dst[copylen - 1] = '\0';
+       }
+
+       return srclen;
+}
+
+char *mystrtok_r(char *s, const char *sep, char **lasts)
+{
        char *t;
-       int delim_reached;
 
        if (!s)
                s = *lasts;
@@ -59,21 +293,603 @@ char *mystrtok_r(char *s, const char *sep, char **lasts) {
                s++;
 
        if (!*s)
-               return NULL;
+               return nullptr;
 
-       delim_reached = 0;
        t = s;
        while (*t) {
                if (strchr(sep, *t)) {
-                       *t = '\0';
-                       delim_reached = 1;
-               } else if (delim_reached) {
-                       *lasts = t;
-                       return s;
+                       *t++ = '\0';
+                       break;
                }
                t++;
        }
-       
+
        *lasts = t;
        return s;
 }
+
+u64 read_seed(const char *str)
+{
+       char *endptr;
+       u64 num;
+
+       if (str[0] == '0' && str[1] == 'x')
+               num = strtoull(str, &endptr, 16);
+       else
+               num = strtoull(str, &endptr, 10);
+
+       if (*endptr)
+               num = murmur_hash_64_ua(str, (int)strlen(str), 0x1337);
+
+       return num;
+}
+
+bool parseColorString(const std::string &value, video::SColor &color, bool quiet,
+               unsigned char default_alpha)
+{
+       bool success;
+
+       if (value[0] == '#')
+               success = parseHexColorString(value, color, default_alpha);
+       else
+               success = parseNamedColorString(value, color);
+
+       if (!success && !quiet)
+               errorstream << "Invalid color: \"" << value << "\"" << std::endl;
+
+       return success;
+}
+
+static bool parseHexColorString(const std::string &value, video::SColor &color,
+               unsigned char default_alpha)
+{
+       unsigned char components[] = { 0x00, 0x00, 0x00, default_alpha }; // R,G,B,A
+
+       if (value[0] != '#')
+               return false;
+
+       size_t len = value.size();
+       bool short_form;
+
+       if (len == 9 || len == 7) // #RRGGBBAA or #RRGGBB
+               short_form = false;
+       else if (len == 5 || len == 4) // #RGBA or #RGB
+               short_form = true;
+       else
+               return false;
+
+       bool success = true;
+
+       for (size_t pos = 1, cc = 0; pos < len; pos++, cc++) {
+               assert(cc < sizeof components / sizeof components[0]);
+               if (short_form) {
+                       unsigned char d;
+                       if (!hex_digit_decode(value[pos], d)) {
+                               success = false;
+                               break;
+                       }
+                       components[cc] = (d & 0xf) << 4 | (d & 0xf);
+               } else {
+                       unsigned char d1, d2;
+                       if (!hex_digit_decode(value[pos], d1) ||
+                                       !hex_digit_decode(value[pos+1], d2)) {
+                               success = false;
+                               break;
+                       }
+                       components[cc] = (d1 & 0xf) << 4 | (d2 & 0xf);
+                       pos++;  // skip the second digit -- it's already used
+               }
+       }
+
+       if (success) {
+               color.setRed(components[0]);
+               color.setGreen(components[1]);
+               color.setBlue(components[2]);
+               color.setAlpha(components[3]);
+       }
+
+       return success;
+}
+
+struct ColorContainer {
+       ColorContainer();
+       std::map<const std::string, u32> colors;
+};
+
+ColorContainer::ColorContainer()
+{
+       colors["aliceblue"]              = 0xf0f8ff;
+       colors["antiquewhite"]           = 0xfaebd7;
+       colors["aqua"]                   = 0x00ffff;
+       colors["aquamarine"]             = 0x7fffd4;
+       colors["azure"]                  = 0xf0ffff;
+       colors["beige"]                  = 0xf5f5dc;
+       colors["bisque"]                 = 0xffe4c4;
+       colors["black"]                  = 00000000;
+       colors["blanchedalmond"]         = 0xffebcd;
+       colors["blue"]                   = 0x0000ff;
+       colors["blueviolet"]             = 0x8a2be2;
+       colors["brown"]                  = 0xa52a2a;
+       colors["burlywood"]              = 0xdeb887;
+       colors["cadetblue"]              = 0x5f9ea0;
+       colors["chartreuse"]             = 0x7fff00;
+       colors["chocolate"]              = 0xd2691e;
+       colors["coral"]                  = 0xff7f50;
+       colors["cornflowerblue"]         = 0x6495ed;
+       colors["cornsilk"]               = 0xfff8dc;
+       colors["crimson"]                = 0xdc143c;
+       colors["cyan"]                   = 0x00ffff;
+       colors["darkblue"]               = 0x00008b;
+       colors["darkcyan"]               = 0x008b8b;
+       colors["darkgoldenrod"]          = 0xb8860b;
+       colors["darkgray"]               = 0xa9a9a9;
+       colors["darkgreen"]              = 0x006400;
+       colors["darkgrey"]               = 0xa9a9a9;
+       colors["darkkhaki"]              = 0xbdb76b;
+       colors["darkmagenta"]            = 0x8b008b;
+       colors["darkolivegreen"]         = 0x556b2f;
+       colors["darkorange"]             = 0xff8c00;
+       colors["darkorchid"]             = 0x9932cc;
+       colors["darkred"]                = 0x8b0000;
+       colors["darksalmon"]             = 0xe9967a;
+       colors["darkseagreen"]           = 0x8fbc8f;
+       colors["darkslateblue"]          = 0x483d8b;
+       colors["darkslategray"]          = 0x2f4f4f;
+       colors["darkslategrey"]          = 0x2f4f4f;
+       colors["darkturquoise"]          = 0x00ced1;
+       colors["darkviolet"]             = 0x9400d3;
+       colors["deeppink"]               = 0xff1493;
+       colors["deepskyblue"]            = 0x00bfff;
+       colors["dimgray"]                = 0x696969;
+       colors["dimgrey"]                = 0x696969;
+       colors["dodgerblue"]             = 0x1e90ff;
+       colors["firebrick"]              = 0xb22222;
+       colors["floralwhite"]            = 0xfffaf0;
+       colors["forestgreen"]            = 0x228b22;
+       colors["fuchsia"]                = 0xff00ff;
+       colors["gainsboro"]              = 0xdcdcdc;
+       colors["ghostwhite"]             = 0xf8f8ff;
+       colors["gold"]                   = 0xffd700;
+       colors["goldenrod"]              = 0xdaa520;
+       colors["gray"]                   = 0x808080;
+       colors["green"]                  = 0x008000;
+       colors["greenyellow"]            = 0xadff2f;
+       colors["grey"]                   = 0x808080;
+       colors["honeydew"]               = 0xf0fff0;
+       colors["hotpink"]                = 0xff69b4;
+       colors["indianred"]              = 0xcd5c5c;
+       colors["indigo"]                 = 0x4b0082;
+       colors["ivory"]                  = 0xfffff0;
+       colors["khaki"]                  = 0xf0e68c;
+       colors["lavender"]               = 0xe6e6fa;
+       colors["lavenderblush"]          = 0xfff0f5;
+       colors["lawngreen"]              = 0x7cfc00;
+       colors["lemonchiffon"]           = 0xfffacd;
+       colors["lightblue"]              = 0xadd8e6;
+       colors["lightcoral"]             = 0xf08080;
+       colors["lightcyan"]              = 0xe0ffff;
+       colors["lightgoldenrodyellow"]   = 0xfafad2;
+       colors["lightgray"]              = 0xd3d3d3;
+       colors["lightgreen"]             = 0x90ee90;
+       colors["lightgrey"]              = 0xd3d3d3;
+       colors["lightpink"]              = 0xffb6c1;
+       colors["lightsalmon"]            = 0xffa07a;
+       colors["lightseagreen"]          = 0x20b2aa;
+       colors["lightskyblue"]           = 0x87cefa;
+       colors["lightslategray"]         = 0x778899;
+       colors["lightslategrey"]         = 0x778899;
+       colors["lightsteelblue"]         = 0xb0c4de;
+       colors["lightyellow"]            = 0xffffe0;
+       colors["lime"]                   = 0x00ff00;
+       colors["limegreen"]              = 0x32cd32;
+       colors["linen"]                  = 0xfaf0e6;
+       colors["magenta"]                = 0xff00ff;
+       colors["maroon"]                 = 0x800000;
+       colors["mediumaquamarine"]       = 0x66cdaa;
+       colors["mediumblue"]             = 0x0000cd;
+       colors["mediumorchid"]           = 0xba55d3;
+       colors["mediumpurple"]           = 0x9370db;
+       colors["mediumseagreen"]         = 0x3cb371;
+       colors["mediumslateblue"]        = 0x7b68ee;
+       colors["mediumspringgreen"]      = 0x00fa9a;
+       colors["mediumturquoise"]        = 0x48d1cc;
+       colors["mediumvioletred"]        = 0xc71585;
+       colors["midnightblue"]           = 0x191970;
+       colors["mintcream"]              = 0xf5fffa;
+       colors["mistyrose"]              = 0xffe4e1;
+       colors["moccasin"]               = 0xffe4b5;
+       colors["navajowhite"]            = 0xffdead;
+       colors["navy"]                   = 0x000080;
+       colors["oldlace"]                = 0xfdf5e6;
+       colors["olive"]                  = 0x808000;
+       colors["olivedrab"]              = 0x6b8e23;
+       colors["orange"]                 = 0xffa500;
+       colors["orangered"]              = 0xff4500;
+       colors["orchid"]                 = 0xda70d6;
+       colors["palegoldenrod"]          = 0xeee8aa;
+       colors["palegreen"]              = 0x98fb98;
+       colors["paleturquoise"]          = 0xafeeee;
+       colors["palevioletred"]          = 0xdb7093;
+       colors["papayawhip"]             = 0xffefd5;
+       colors["peachpuff"]              = 0xffdab9;
+       colors["peru"]                   = 0xcd853f;
+       colors["pink"]                   = 0xffc0cb;
+       colors["plum"]                   = 0xdda0dd;
+       colors["powderblue"]             = 0xb0e0e6;
+       colors["purple"]                 = 0x800080;
+       colors["red"]                    = 0xff0000;
+       colors["rosybrown"]              = 0xbc8f8f;
+       colors["royalblue"]              = 0x4169e1;
+       colors["saddlebrown"]            = 0x8b4513;
+       colors["salmon"]                 = 0xfa8072;
+       colors["sandybrown"]             = 0xf4a460;
+       colors["seagreen"]               = 0x2e8b57;
+       colors["seashell"]               = 0xfff5ee;
+       colors["sienna"]                 = 0xa0522d;
+       colors["silver"]                 = 0xc0c0c0;
+       colors["skyblue"]                = 0x87ceeb;
+       colors["slateblue"]              = 0x6a5acd;
+       colors["slategray"]              = 0x708090;
+       colors["slategrey"]              = 0x708090;
+       colors["snow"]                   = 0xfffafa;
+       colors["springgreen"]            = 0x00ff7f;
+       colors["steelblue"]              = 0x4682b4;
+       colors["tan"]                    = 0xd2b48c;
+       colors["teal"]                   = 0x008080;
+       colors["thistle"]                = 0xd8bfd8;
+       colors["tomato"]                 = 0xff6347;
+       colors["turquoise"]              = 0x40e0d0;
+       colors["violet"]                 = 0xee82ee;
+       colors["wheat"]                  = 0xf5deb3;
+       colors["white"]                  = 0xffffff;
+       colors["whitesmoke"]             = 0xf5f5f5;
+       colors["yellow"]                 = 0xffff00;
+       colors["yellowgreen"]            = 0x9acd32;
+
+}
+
+static const ColorContainer named_colors;
+
+static bool parseNamedColorString(const std::string &value, video::SColor &color)
+{
+       std::string color_name;
+       std::string alpha_string;
+
+       /* If the string has a # in it, assume this is the start of a specified
+        * alpha value (if it isn't the string is invalid and the error will be
+        * caught later on, either because the color name won't be found or the
+        * alpha value will fail conversion)
+        */
+       size_t alpha_pos = value.find('#');
+       if (alpha_pos != std::string::npos) {
+               color_name = value.substr(0, alpha_pos);
+               alpha_string = value.substr(alpha_pos + 1);
+       } else {
+               color_name = value;
+       }
+
+       color_name = lowercase(color_name);
+
+       std::map<const std::string, unsigned>::const_iterator it;
+       it = named_colors.colors.find(color_name);
+       if (it == named_colors.colors.end())
+               return false;
+
+       u32 color_temp = it->second;
+
+       /* An empty string for alpha is ok (none of the color table entries
+        * have an alpha value either). Color strings without an alpha specified
+        * are interpreted as fully opaque
+        *
+        * For named colors the supplied alpha string (representing a hex value)
+        * must be exactly two digits. For example:  colorname#08
+        */
+       if (!alpha_string.empty()) {
+               if (alpha_string.length() != 2)
+                       return false;
+
+               unsigned char d1, d2;
+               if (!hex_digit_decode(alpha_string.at(0), d1)
+                               || !hex_digit_decode(alpha_string.at(1), d2))
+                       return false;
+               color_temp |= ((d1 & 0xf) << 4 | (d2 & 0xf)) << 24;
+       } else {
+               color_temp |= 0xff << 24;  // Fully opaque
+       }
+
+       color = video::SColor(color_temp);
+
+       return true;
+}
+
+void str_replace(std::string &str, char from, char to)
+{
+       std::replace(str.begin(), str.end(), from, to);
+}
+
+/* Translated strings have the following format:
+ * \x1bT marks the beginning of a translated string
+ * \x1bE marks its end
+ *
+ * \x1bF marks the beginning of an argument, and \x1bE its end.
+ *
+ * Arguments are *not* translated, as they may contain escape codes.
+ * Thus, if you want a translated argument, it should be inside \x1bT/\x1bE tags as well.
+ *
+ * This representation is chosen so that clients ignoring escape codes will
+ * see untranslated strings.
+ *
+ * For instance, suppose we have a string such as "@1 Wool" with the argument "White"
+ * The string will be sent as "\x1bT\x1bF\x1bTWhite\x1bE\x1bE Wool\x1bE"
+ * To translate this string, we extract what is inside \x1bT/\x1bE tags.
+ * When we notice the \x1bF tag, we recursively extract what is there up to the \x1bE end tag,
+ * translating it as well.
+ * We get the argument "White", translated, and create a template string with "@1" instead of it.
+ * We finally get the template "@1 Wool" that was used in the beginning, which we translate
+ * before filling it again.
+ */
+
+void translate_all(const std::wstring &s, size_t &i,
+               Translations *translations, std::wstring &res);
+
+void translate_string(const std::wstring &s, Translations *translations,
+               const std::wstring &textdomain, size_t &i, std::wstring &res)
+{
+       std::wostringstream output;
+       std::vector<std::wstring> args;
+       int arg_number = 1;
+       while (i < s.length()) {
+               // Not an escape sequence: just add the character.
+               if (s[i] != '\x1b') {
+                       output.put(s[i]);
+                       // The character is a literal '@'; add it twice
+                       // so that it is not mistaken for an argument.
+                       if (s[i] == L'@')
+                               output.put(L'@');
+                       ++i;
+                       continue;
+               }
+
+               // We have an escape sequence: locate it and its data
+               // It is either a single character, or it begins with '('
+               // and extends up to the following ')', with '\' as an escape character.
+               ++i;
+               size_t start_index = i;
+               size_t length;
+               if (i == s.length()) {
+                       length = 0;
+               } else if (s[i] == L'(') {
+                       ++i;
+                       ++start_index;
+                       while (i < s.length() && s[i] != L')') {
+                               if (s[i] == L'\\')
+                                       ++i;
+                               ++i;
+                       }
+                       length = i - start_index;
+                       ++i;
+                       if (i > s.length())
+                               i = s.length();
+               } else {
+                       ++i;
+                       length = 1;
+               }
+               std::wstring escape_sequence(s, start_index, length);
+
+               // The escape sequence is now reconstructed.
+               std::vector<std::wstring> parts = split(escape_sequence, L'@');
+               if (parts[0] == L"E") {
+                       // "End of translation" escape sequence. We are done locating the string to translate.
+                       break;
+               } else if (parts[0] == L"F") {
+                       // "Start of argument" escape sequence.
+                       // Recursively translate the argument, and add it to the argument list.
+                       // Add an "@n" instead of the argument to the template to translate.
+                       if (arg_number >= 10) {
+                               errorstream << "Ignoring too many arguments to translation" << std::endl;
+                               std::wstring arg;
+                               translate_all(s, i, translations, arg);
+                               args.push_back(arg);
+                               continue;
+                       }
+                       output.put(L'@');
+                       output << arg_number;
+                       ++arg_number;
+                       std::wstring arg;
+                       translate_all(s, i, translations, arg);
+                       args.push_back(arg);
+               } else {
+                       // This is an escape sequence *inside* the template string to translate itself.
+                       // This should not happen, show an error message.
+                       errorstream << "Ignoring escape sequence '"
+                               << wide_to_utf8(escape_sequence) << "' in translation" << std::endl;
+               }
+       }
+
+       std::wstring toutput;
+       // Translate the template.
+       if (translations != nullptr)
+               toutput = translations->getTranslation(
+                               textdomain, output.str());
+       else
+               toutput = output.str();
+
+       // Put back the arguments in the translated template.
+       std::wostringstream result;
+       size_t j = 0;
+       while (j < toutput.length()) {
+               // Normal character, add it to output and continue.
+               if (toutput[j] != L'@' || j == toutput.length() - 1) {
+                       result.put(toutput[j]);
+                       ++j;
+                       continue;
+               }
+
+               ++j;
+               // Literal escape for '@'.
+               if (toutput[j] == L'@') {
+                       result.put(L'@');
+                       ++j;
+                       continue;
+               }
+
+               // Here we have an argument; get its index and add the translated argument to the output.
+               int arg_index = toutput[j] - L'1';
+               ++j;
+               if (0 <= arg_index && (size_t)arg_index < args.size()) {
+                       result << args[arg_index];
+               } else {
+                       // This is not allowed: show an error message
+                       errorstream << "Ignoring out-of-bounds argument escape sequence in translation" << std::endl;
+               }
+       }
+       res = result.str();
+}
+
+void translate_all(const std::wstring &s, size_t &i,
+               Translations *translations, std::wstring &res)
+{
+       std::wostringstream output;
+       while (i < s.length()) {
+               // Not an escape sequence: just add the character.
+               if (s[i] != '\x1b') {
+                       output.put(s[i]);
+                       ++i;
+                       continue;
+               }
+
+               // We have an escape sequence: locate it and its data
+               // It is either a single character, or it begins with '('
+               // and extends up to the following ')', with '\' as an escape character.
+               size_t escape_start = i;
+               ++i;
+               size_t start_index = i;
+               size_t length;
+               if (i == s.length()) {
+                       length = 0;
+               } else if (s[i] == L'(') {
+                       ++i;
+                       ++start_index;
+                       while (i < s.length() && s[i] != L')') {
+                               if (s[i] == L'\\') {
+                                       ++i;
+                               }
+                               ++i;
+                       }
+                       length = i - start_index;
+                       ++i;
+                       if (i > s.length())
+                               i = s.length();
+               } else {
+                       ++i;
+                       length = 1;
+               }
+               std::wstring escape_sequence(s, start_index, length);
+
+               // The escape sequence is now reconstructed.
+               std::vector<std::wstring> parts = split(escape_sequence, L'@');
+               if (parts[0] == L"E") {
+                       // "End of argument" escape sequence. Exit.
+                       break;
+               } else if (parts[0] == L"T") {
+                       // Beginning of translated string.
+                       std::wstring textdomain;
+                       if (parts.size() > 1)
+                               textdomain = parts[1];
+                       std::wstring translated;
+                       translate_string(s, translations, textdomain, i, translated);
+                       output << translated;
+               } else {
+                       // Another escape sequence, such as colors. Preserve it.
+                       output << std::wstring(s, escape_start, i - escape_start);
+               }
+       }
+
+       res = output.str();
+}
+
+// Translate string server side
+std::wstring translate_string(const std::wstring &s, Translations *translations)
+{
+       size_t i = 0;
+       std::wstring res;
+       translate_all(s, i, translations, res);
+       return res;
+}
+
+// Translate string client side
+std::wstring translate_string(const std::wstring &s)
+{
+#ifdef SERVER
+       return translate_string(s, nullptr);
+#else
+       return translate_string(s, g_client_translations);
+#endif
+}
+
+static const std::array<std::wstring, 22> disallowed_dir_names = {
+       // Problematic filenames from here:
+       // https://docs.microsoft.com/en-us/windows/win32/fileio/naming-a-file#file-and-directory-names
+       L"CON",
+       L"PRN",
+       L"AUX",
+       L"NUL",
+       L"COM1",
+       L"COM2",
+       L"COM3",
+       L"COM4",
+       L"COM5",
+       L"COM6",
+       L"COM7",
+       L"COM8",
+       L"COM9",
+       L"LPT1",
+       L"LPT2",
+       L"LPT3",
+       L"LPT4",
+       L"LPT5",
+       L"LPT6",
+       L"LPT7",
+       L"LPT8",
+       L"LPT9",
+};
+
+/**
+ * List of characters that are blacklisted from created directories
+ */
+static const std::wstring disallowed_path_chars = L"<>:\"/\\|?*.";
+
+/**
+ * Sanitize the name of a new directory. This consists of two stages:
+ * 1. Check for 'reserved filenames' that can't be used on some filesystems
+ *     and add a prefix to them
+ * 2. Remove 'unsafe' characters from the name by replacing them with '_'
+ */
+std::string sanitizeDirName(const std::string &str, const std::string &optional_prefix)
+{
+       std::wstring safe_name = utf8_to_wide(str);
+
+       for (std::wstring disallowed_name : disallowed_dir_names) {
+               if (str_equal(safe_name, disallowed_name, true)) {
+                       safe_name = utf8_to_wide(optional_prefix) + safe_name;
+                       break;
+               }
+       }
+
+       for (unsigned long i = 0; i < safe_name.length(); i++) {
+               bool is_valid = true;
+
+               // Unlikely, but control characters should always be blacklisted
+               if (safe_name[i] < 32) {
+                       is_valid = false;
+               } else if (safe_name[i] < 128) {
+                       is_valid = disallowed_path_chars.find_first_of(safe_name[i])
+                                       == std::wstring::npos;
+               }
+
+               if (!is_valid)
+                       safe_name[i] = '_';
+       }
+
+       return wide_to_utf8(safe_name);
+}