ls-standard-library/source/ls-std/encoding/Base64.cpp

/*
 * Author:          Patrick-Christopher Mattulat
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2022-01-03
 * Changed:         2024-05-31
 *
 * */

#include <bitset>
#include <ls-std/encoding/Base64.hpp>

using ls::std::encoding::Base64;
using std::string;
using std::string_view;
using std::unordered_map;
using std::vector;

Base64::Base64() = default;

Base64::~Base64() noexcept = default;

string Base64::encode(const string &_sequence)
{
  string encodedString{};

  for (size_t index = 0; index < _sequence.size(); index += 3)
  {
    const string_view byteTriple = _getNextByteTriple(_sequence, index);
    encodedString += _encodeByteTriple(byteTriple);
  }

  return _applyEndingRule(encodedString, _sequence.size());
}

string Base64::decode(const string &_sequence)
{
  string decodedString{};

  for (int index{}; index < _sequence.size(); index += 4)
  {
    const string_view quadruple = _getNextByteQuadruple(string_view{_sequence}, index);
    decodedString += _decodeByteQuadruple(quadruple);
  }

  return decodedString;
}

string Base64::_applyEndingRule(string _encodedString, const size_t _sequenceSize)
{
  const size_t size = _encodedString.size();

  if (_sequenceSize % 3 == 1)
  {
    _encodedString[size - 2] = '=';
    _encodedString[size - 1] = '=';
  }

  if (_sequenceSize % 3 == 2)
  {
    _encodedString[size - 1] = '=';
  }

  return _encodedString;
}

string Base64::_decodeByteQuadruple(const string_view _quadruple)
{
  string decodedText{};
  uint8_t shiftValue = 16;
  const uint32_t bitStorage = _toDecodingBitStorage(_quadruple);

  for (uint8_t index = 0; index < static_cast<uint8_t>(_quadruple.size()) - 1; index++)
  {
    const uint32_t bitMask = _generateBitMask(255, shiftValue);
    uint32_t bitSequence = _extractBitSequence(bitMask, bitStorage);
    bitSequence = bitSequence >> shiftValue;

    decodedText += static_cast<char>(bitSequence);
    shiftValue -= 8;
  }

  return decodedText;
}

string Base64::_encodeByteTriple(const string_view _byteTriple)
{
  string encodedText{};
  const uint32_t bitStorage = _toEncodingBitStorage(_byteTriple);
  static vector<uint32_t> bitMaskStorage = {16515072, 258048, 4032, 63};
  static unordered_map<uint8_t, char> encodingMap = _getEncodingMap();
  uint8_t shiftValue = 18;

  for (uint8_t bitMaskIndex = 0; bitMaskIndex < 4; bitMaskIndex++)
  {
    uint32_t extractedBitSequence = _extractBitSequence(bitMaskStorage[bitMaskIndex], bitStorage);
    extractedBitSequence = extractedBitSequence >> shiftValue;
    encodedText += encodingMap[static_cast<uint8_t>(extractedBitSequence)];
    shiftValue -= 6;
  }

  return encodedText;
}

uint32_t Base64::_extractBitSequence(const uint32_t _bitMask, const uint32_t _bitStorage)
{
  return _bitStorage & _bitMask;
}

uint32_t Base64::_generateBitMask(const uint32_t _maskValue, const uint8_t _shiftValue)
{
  uint32_t bitmask = _maskValue << _shiftValue;

  if (_shiftValue == 0)
  {
    bitmask = _maskValue;
  }

  return bitmask;
}

unordered_map<char, uint8_t> Base64::_getDecodingMap()
{
  static unordered_map<char, uint8_t> decodingMap = {{'A', 0},  {'B', 1},  {'C', 2},  {'D', 3},  {'E', 4},  {'F', 5},  {'G', 6},  {'H', 7},  {'I', 8},  {'J', 9},  {'K', 10}, {'L', 11}, {'M', 12}, {'N', 13}, {'O', 14}, {'P', 15}, {'Q', 16}, {'R', 17}, {'S', 18}, {'T', 19}, {'U', 20}, {'V', 21}, {'W', 22}, {'X', 23}, {'Y', 24}, {'Z', 25}, {'a', 26}, {'b', 27}, {'c', 28}, {'d', 29}, {'e', 30}, {'f', 31},
                                                     {'g', 32}, {'h', 33}, {'i', 34}, {'j', 35}, {'k', 36}, {'l', 37}, {'m', 38}, {'n', 39}, {'o', 40}, {'p', 41}, {'q', 42}, {'r', 43}, {'s', 44}, {'t', 45}, {'u', 46}, {'v', 47}, {'w', 48}, {'x', 49}, {'y', 50}, {'z', 51}, {'0', 52}, {'1', 53}, {'2', 54}, {'3', 55}, {'4', 56}, {'5', 57}, {'6', 58}, {'7', 59}, {'8', 60}, {'9', 61}, {'+', 62}, {'/', 63}};

  return decodingMap;
}

unordered_map<uint8_t, char> Base64::_getEncodingMap()
{
  static unordered_map<uint8_t, char> encodingMap = {
      {0, 'A'}, {1, 'B'}, {2, 'C'}, {3, 'D'}, {4, 'E'}, {5, 'F'}, {6, 'G'}, {7, 'H'}, {8, 'I'}, {9, 'J'}, {10, 'K'}, {11, 'L'}, {12, 'M'}, {13, 'N'}, {14, 'O'}, {15, 'P'}, {16, 'Q'}, {17, 'R'}, {18, 'S'}, {19, 'T'}, {20, 'U'}, {21, 'V'}, {22, 'W'}, {23, 'X'}, {24, 'Y'}, {25, 'Z'}, {26, 'a'}, {27, 'b'}, {28, 'c'}, {29, 'd'}, {30, 'e'}, {31, 'f'}, {32, 'g'}, {33, 'h'}, {34, 'i'}, {35, 'j'}, {36, 'k'}, {37, 'l'}, {38, 'm'}, {39, 'n'}, {40, 'o'}, {41, 'p'}, {42, 'q'}, {43, 'r'}, {44, 's'}, {45, 't'}, {46, 'u'}, {47, 'v'}, {48, 'w'}, {49, 'x'}, {50, 'y'}, {51, 'z'}, {52, '0'}, {53, '1'}, {54, '2'}, {55, '3'}, {56, '4'}, {57, '5'}, {58, '6'}, {59, '7'}, {60, '8'}, {61, '9'}, {62, '+'}, {63, '/'},
  };

  return encodingMap;
}

string_view Base64::_getNextByteQuadruple(const string_view _sequence, const size_t _index)
{
  return _sequence.substr(_index, 4);
}

string_view Base64::_getNextByteTriple(const string_view _sequence, const size_t _index)
{
  return _sequence.substr(_index, 3);
}

void Base64::_mergeBitSequence(uint32_t &_bitStorage, const uint32_t &_bitMask)
{
  _bitStorage = _bitStorage | _bitMask;
}

uint32_t Base64::_toDecodingBitStorage(const string_view _quadruple)
{
  uint32_t bitStorage{};
  uint8_t letterCounter = 1;
  unordered_map<char, uint8_t> decodingMap = _getDecodingMap();

  for (char letter : _quadruple)
  {
    uint32_t bitMask = _generateBitMask(decodingMap[letter], (4 - letterCounter) * 6); // must be hardcoded - even in case of less than 4 characters, so that conversion is correct
    _mergeBitSequence(bitStorage, bitMask);
    ++letterCounter;
  }

  return bitStorage;
}

uint32_t Base64::_toEncodingBitStorage(const string_view _triple)
{
  uint32_t bitStorage{};
  uint8_t shiftValue = 16;

  for (const char letter : _triple)
  {
    uint32_t bitMask = _generateBitMask(static_cast<uint8_t>(letter), shiftValue);
    _mergeBitSequence(bitStorage, bitMask);
    shiftValue -= 8;
  }

  return bitStorage;
}