Archive.cpp

/*
 *  Copyright (C) 2005-2018 Team Kodi
 *  This file is part of Kodi - https://kodi.tv
 *
 *  SPDX-License-Identifier: GPL-2.0-or-later
 *  See LICENSES/README.md for more information.
 */

#include "Archive.h"

#include "IArchivable.h"
#include "filesystem/File.h"
#include "utils/Variant.h"
#include "utils/XTimeUtils.h"
#include "utils/log.h"

#include <algorithm>
#include <cstdint>
#include <cstring>
#include <stdexcept>

#ifdef __GNUC__
#pragma GCC diagnostic ignored "-Wlong-long"
#endif

using namespace XFILE;

//arbitrarily chosen, should be plenty big enough for our strings
//without causing random bad things happening
//not very bad, just tiny bad
#define MAX_STRING_SIZE 100*1024*1024

CArchive::CArchive(CFile* pFile, int mode)
  : m_pBuffer(std::unique_ptr<uint8_t[]>(new uint8_t[CARCHIVE_BUFFER_MAX]))
{
  m_pFile = pFile;
  m_iMode = mode;

  memset(m_pBuffer.get(), 0, CARCHIVE_BUFFER_MAX);
  if (mode == load)
  {
    m_BufferPos = m_pBuffer.get() + CARCHIVE_BUFFER_MAX;
    m_BufferRemain = 0;
  }
  else
  {
    m_BufferPos = m_pBuffer.get();
    m_BufferRemain = CARCHIVE_BUFFER_MAX;
  }
}

CArchive::~CArchive()
{
  FlushBuffer();
}

void CArchive::Close()
{
  FlushBuffer();
}

bool CArchive::IsLoading() const
{
  return (m_iMode == load);
}

bool CArchive::IsStoring() const
{
  return (m_iMode == store);
}

CArchive& CArchive::operator<<(float f)
{
  return streamout(&f, sizeof(f));
}

CArchive& CArchive::operator<<(double d)
{
  return streamout(&d, sizeof(d));
}

CArchive& CArchive::operator<<(short int s)
{
  return streamout(&s, sizeof(s));
}

CArchive& CArchive::operator<<(unsigned short int us)
{
  return streamout(&us, sizeof(us));
}

CArchive& CArchive::operator<<(int i)
{
  return streamout(&i, sizeof(i));
}

CArchive& CArchive::operator<<(unsigned int ui)
{
  return streamout(&ui, sizeof(ui));
}

CArchive& CArchive::operator<<(long int l)
{
  return streamout(&l, sizeof(l));
}

CArchive& CArchive::operator<<(unsigned long int ul)
{
  return streamout(&ul, sizeof(ul));
}

CArchive& CArchive::operator<<(long long int ll)
{
  return streamout(&ll, sizeof(ll));
}

CArchive& CArchive::operator<<(unsigned long long int ull)
{
  return streamout(&ull, sizeof(ull));
}

CArchive& CArchive::operator<<(bool b)
{
  return streamout(&b, sizeof(b));
}

CArchive& CArchive::operator<<(char c)
{
  return streamout(&c, sizeof(c));
}

CArchive& CArchive::operator<<(const std::string& str)
{
  auto size = static_cast<uint32_t>(str.size());
  if (size > MAX_STRING_SIZE)
    throw std::out_of_range("String too large, over 100MB");

  *this << size;

  return streamout(str.data(), size * sizeof(char));
}

CArchive& CArchive::operator<<(const std::wstring& wstr)
{
  if (wstr.size() > MAX_STRING_SIZE)
    throw std::out_of_range("String too large, over 100MB");

  auto size = static_cast<uint32_t>(wstr.size());

  *this << size;

  return streamout(wstr.data(), size * sizeof(wchar_t));
}

CArchive& CArchive::operator<<(const KODI::TIME::SystemTime& time)
{
  return streamout(&time, sizeof(KODI::TIME::SystemTime));
}

CArchive& CArchive::operator<<(IArchivable& obj)
{
  obj.Archive(*this);

  return *this;
}

CArchive& CArchive::operator<<(const CVariant& variant)
{
  *this << static_cast<int>(variant.type());
  switch (variant.type())
  {
  case CVariant::VariantTypeInteger:
    *this << variant.asInteger();
    break;
  case CVariant::VariantTypeUnsignedInteger:
    *this << variant.asUnsignedInteger();
    break;
  case CVariant::VariantTypeBoolean:
    *this << variant.asBoolean();
    break;
  case CVariant::VariantTypeString:
    *this << variant.asString();
    break;
  case CVariant::VariantTypeWideString:
    *this << variant.asWideString();
    break;
  case CVariant::VariantTypeDouble:
    *this << variant.asDouble();
    break;
  case CVariant::VariantTypeArray:
    *this << variant.size();
    for (auto i = variant.begin_array(); i != variant.end_array(); ++i)
      *this << *i;
    break;
  case CVariant::VariantTypeObject:
    *this << variant.size();
    for (auto itr = variant.begin_map(); itr != variant.end_map(); ++itr)
    {
      *this << itr->first;
      *this << itr->second;
    }
    break;
  case CVariant::VariantTypeNull:
  case CVariant::VariantTypeConstNull:
  default:
    break;
  }

  return *this;
}

CArchive& CArchive::operator<<(const std::vector<std::string>& strArray)
{
  if (std::numeric_limits<uint32_t>::max() < strArray.size())
    throw std::out_of_range("Array too large, over 2^32 in size");

  *this << static_cast<uint32_t>(strArray.size());

  for (auto&& item : strArray)
    *this << item;

  return *this;
}

CArchive& CArchive::operator<<(const std::vector<int>& iArray)
{
  if (std::numeric_limits<uint32_t>::max() < iArray.size())
    throw std::out_of_range("Array too large, over 2^32 in size");

  *this << static_cast<uint32_t>(iArray.size());

  for (auto&& item : iArray)
    *this << item;

  return *this;
}

CArchive& CArchive::operator>>(std::string& str)
{
  uint32_t iLength = 0;
  *this >> iLength;

  if (iLength > MAX_STRING_SIZE)
    throw std::out_of_range("String too large, over 100MB");

  auto s = std::unique_ptr<char[]>(new char[iLength]);
  streamin(s.get(), iLength * sizeof(char));
  str.assign(s.get(), iLength);

  return *this;
}

CArchive& CArchive::operator>>(std::wstring& wstr)
{
  uint32_t iLength = 0;
  *this >> iLength;

  if (iLength > MAX_STRING_SIZE)
    throw std::out_of_range("String too large, over 100MB");

  auto p = std::unique_ptr<wchar_t[]>(new wchar_t[iLength]);
  streamin(p.get(), iLength * sizeof(wchar_t));
  wstr.assign(p.get(), iLength);

  return *this;
}

CArchive& CArchive::operator>>(KODI::TIME::SystemTime& time)
{
  return streamin(&time, sizeof(KODI::TIME::SystemTime));
}

CArchive& CArchive::operator>>(IArchivable& obj)
{
  obj.Archive(*this);

  return *this;
}

CArchive& CArchive::operator>>(CVariant& variant)
{
  int type;
  *this >> type;
  variant = CVariant(static_cast<CVariant::VariantType>(type));

  switch (variant.type())
  {
  case CVariant::VariantTypeInteger:
  {
    int64_t value;
    *this >> value;
    variant = value;
    break;
  }
  case CVariant::VariantTypeUnsignedInteger:
  {
    uint64_t value;
    *this >> value;
    variant = value;
    break;
  }
  case CVariant::VariantTypeBoolean:
  {
    bool value;
    *this >> value;
    variant = value;
    break;
  }
  case CVariant::VariantTypeString:
  {
    std::string value;
    *this >> value;
    variant = value;
    break;
  }
  case CVariant::VariantTypeWideString:
  {
    std::wstring value;
    *this >> value;
    variant = value;
    break;
  }
  case CVariant::VariantTypeDouble:
  {
    double value;
    *this >> value;
    variant = value;
    break;
  }
  case CVariant::VariantTypeArray:
  {
    unsigned int size;
    *this >> size;
    for (; size > 0; size--)
    {
      CVariant value;
      *this >> value;
      variant.append(value);
    }
    break;
  }
  case CVariant::VariantTypeObject:
  {
    unsigned int size;
    *this >> size;
    for (; size > 0; size--)
    {
      std::string name;
      CVariant value;
      *this >> name;
      *this >> value;
      variant[name] = value;
    }
    break;
  }
  case CVariant::VariantTypeNull:
  case CVariant::VariantTypeConstNull:
  default:
    break;
  }

  return *this;
}

CArchive& CArchive::operator>>(std::vector<std::string>& strArray)
{
  uint32_t size;
  *this >> size;
  strArray.clear();
  for (uint32_t index = 0; index < size; index++)
  {
    std::string str;
    *this >> str;
    strArray.push_back(std::move(str));
  }

  return *this;
}

CArchive& CArchive::operator>>(std::vector<int>& iArray)
{
  uint32_t size;
  *this >> size;
  iArray.clear();
  for (uint32_t index = 0; index < size; index++)
  {
    int i;
    *this >> i;
    iArray.push_back(i);
  }

  return *this;
}

void CArchive::FlushBuffer()
{
  if (m_iMode == store && m_BufferPos != m_pBuffer.get())
  {
    if (m_pFile->Write(m_pBuffer.get(), m_BufferPos - m_pBuffer.get()) != m_BufferPos - m_pBuffer.get())
      CLog::Log(LOGERROR, "{}: Error flushing buffer", __FUNCTION__);
    else
    {
      m_BufferPos = m_pBuffer.get();
      m_BufferRemain = CARCHIVE_BUFFER_MAX;
    }
  }
}

CArchive &CArchive::streamout_bufferwrap(const uint8_t *ptr, size_t size)
{
  do
  {
    auto chunkSize = std::min(size, m_BufferRemain);
    m_BufferPos = std::copy(ptr, ptr + chunkSize, m_BufferPos);
    ptr += chunkSize;
    size -= chunkSize;
    m_BufferRemain -= chunkSize;
    if (m_BufferRemain == 0)
      FlushBuffer();
  } while (size > 0);
  return *this;
}

void CArchive::FillBuffer()
{
  if (m_iMode == load && m_BufferRemain == 0)
  {
    auto read = m_pFile->Read(m_pBuffer.get(), CARCHIVE_BUFFER_MAX);
    if (read > 0)
    {
      m_BufferRemain = read;
      m_BufferPos = m_pBuffer.get();
    }
  }
}

CArchive &CArchive::streamin_bufferwrap(uint8_t *ptr, size_t size)
{
  auto orig_ptr = ptr;
  auto orig_size = size;
  do
  {
    if (m_BufferRemain == 0)
    {
      FillBuffer();
      if (m_BufferRemain < CARCHIVE_BUFFER_MAX && m_BufferRemain < size)
      {
        CLog::Log(LOGERROR, "{}: can't stream in: requested {} bytes, was read {} bytes",
                  __FUNCTION__, static_cast<unsigned long>(orig_size),
                  static_cast<unsigned long>(ptr - orig_ptr + m_BufferRemain));

        memset(orig_ptr, 0, orig_size);
        return *this;
      }
    }
    auto chunkSize = std::min(size, m_BufferRemain);
    ptr = std::copy(m_BufferPos, m_BufferPos + chunkSize, ptr);
    m_BufferPos += chunkSize;
    m_BufferRemain -= chunkSize;
    size -= chunkSize;
  } while (size > 0);
  return *this;
}