/src/libtorrent/src/entry.cpp

Source
/*

Copyright (c) 2003-2008, 2010, 2014-2020, Arvid Norberg
Copyright (c) 2016-2017, Alden Torres
Copyright (c) 2016, Steven Siloti
Copyright (c) 2017, Andrei Kurushin
Copyright (c) 2019, Amir Abrams
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:

    * Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in
      the documentation and/or other materials provided with the distribution.
    * Neither the name of the author nor the names of its
      contributors may be used to endorse or promote products derived
      from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.

*/

#include "libtorrent/config.hpp"
#include "libtorrent/bdecode.hpp"
#include "libtorrent/bencode.hpp"
#include "libtorrent/entry.hpp"
#include "libtorrent/hex.hpp"
#include "libtorrent/string_util.hpp"
#include "libtorrent/aux_/throw.hpp"

namespace libtorrent {

namespace aux {

  string_view integer_to_str(std::array<char, 21>& buf, entry::integer_type val)
  {
    if (val >= 0)
    {
      if (val < 10)
      {
        buf[0] = '0' + static_cast<char>(val);
        return {buf.data(), std::size_t(1)};
      }
      if (val < 100)
      {
        buf[0] = '0' + (val / 10) % 10;
        buf[1] = '0' + val % 10;
        return {buf.data(), std::size_t(2)};
      }
      if (val < 1000)
      {
        buf[0] = '0' + (val / 100) % 10;
        buf[1] = '0' + (val / 10) % 10;
        buf[2] = '0' + val % 10;
        return {buf.data(), std::size_t(3)};
      }
      if (val < 10000)
      {
        buf[0] = '0' + (val / 1000) % 10;
        buf[1] = '0' + (val / 100) % 10;
        buf[2] = '0' + (val / 10) % 10;
        buf[3] = '0' + val % 10;
        return {buf.data(), std::size_t(4)};
      }
      if (val < 100000)
      {
        buf[0] = '0' + (val / 10000) % 10;
        buf[1] = '0' + (val / 1000) % 10;
        buf[2] = '0' + (val / 100) % 10;
        buf[3] = '0' + (val / 10) % 10;
        buf[4] = '0' + val % 10;
        return {buf.data(), std::size_t(5)};
      }
    }
    // val == 0 is handled in the fast-path above
    TORRENT_ASSERT(val != 0);
    // slow path
    // convert positive values to negative, since the negative space is
    // larger, so we can fit INT64_MIN
    int sign = 1;
    if (val > 0)
    {
      sign = 0;
      val = -val;
    }
    char* ptr = &buf.back();
    do
    {
      *ptr-- = '0' - char(val % 10);
      val /= 10;
    } while (val != 0);
    if (sign) *ptr-- = '-';
    ++ptr;
    return {ptr, static_cast<std::size_t>(&buf.back() - ptr + 1)};
  }
} // aux

namespace {

  [[noreturn]] inline void throw_error()
  { aux::throw_ex<system_error>(errors::invalid_entry_type); }

  template <class T>
  void call_destructor(T* o)
  {
    TORRENT_ASSERT(o);
    o->~T();
  }
} // anonymous

  entry& entry::operator[](string_view key)
  {
    // at least GCC-5.4 for ARM (on travis) has a libstdc++ whose debug map$
    // doesn't seem to support transparent comparators$
#if ! defined _GLIBCXX_DEBUG
    auto const i = dict().find(key);
#else
    auto const i = dict().find(std::string(key));
#endif
    if (i != dict().end()) return i->second;
    auto const ret = dict().emplace(
      std::piecewise_construct,
      std::forward_as_tuple(key),
      std::forward_as_tuple()).first;
    return ret->second;
  }

  const entry& entry::operator[](string_view key) const
  {
    // at least GCC-5.4 for ARM (on travis) has a libstdc++ whose debug map$
    // doesn't seem to support transparent comparators$
#if ! defined _GLIBCXX_DEBUG
    auto const i = dict().find(key);
#else
    auto const i = dict().find(std::string(key));
#endif
    if (i == dict().end()) throw_error();
    return i->second;
  }

  entry* entry::find_key(string_view key)
  {
#if ! defined _GLIBCXX_DEBUG
    auto const i = dict().find(key);
#else
    auto const i = dict().find(std::string(key));
#endif
    if (i == dict().end()) return nullptr;
    return &i->second;
  }

  entry const* entry::find_key(string_view key) const
  {
#if ! defined _GLIBCXX_DEBUG
    auto const i = dict().find(key);
#else
    auto const i = dict().find(std::string(key));
#endif
    if (i == dict().end()) return nullptr;
    return &i->second;
  }

  entry::data_type entry::type() const
  {
#if TORRENT_USE_ASSERTS
    m_type_queried = true;
#endif
    return entry::data_type(m_type);
  }

  entry::~entry() { destruct(); }

  entry& entry::operator=(const entry& e) &
  {
    if (&e == this) return *this;
    destruct();
    copy(e);
    return *this;
  }

  entry& entry::operator=(entry&& e) & noexcept
  {
    if (&e == this) return *this;
    destruct();
    const auto t = e.type();
    switch (t)
    {
    case int_t:
      new (&data) integer_type(std::move(e.integer()));
      break;
    case string_t:
      new (&data) string_type(std::move(e.string()));
      break;
    case list_t:
      new (&data) list_type(std::move(e.list()));
      break;
    case dictionary_t:
      new (&data) dictionary_type(std::move(e.dict()));
      break;
    case undefined_t:
      break;
    case preformatted_t:
      new (&data) preformatted_type(std::move(e.preformatted()));
      break;
    }
    m_type = t;
#if TORRENT_USE_ASSERTS
    m_type_queried = true;
#endif
    return *this;
  }

  entry::integer_type& entry::integer()
  {
    if (m_type == undefined_t) construct(int_t);
#ifdef BOOST_NO_EXCEPTIONS
    TORRENT_ASSERT(m_type_queried);
#endif
    if (m_type != int_t) throw_error();
    TORRENT_ASSERT(m_type == int_t);
    return *reinterpret_cast<integer_type*>(&data);
  }

  entry::integer_type const& entry::integer() const
  {
    if (m_type != int_t) throw_error();
#ifdef BOOST_NO_EXCEPTIONS
    TORRENT_ASSERT(m_type_queried);
#endif
    TORRENT_ASSERT(m_type == int_t);
    return *reinterpret_cast<const integer_type*>(&data);
  }

  entry::string_type& entry::string()
  {
    if (m_type == undefined_t) construct(string_t);
#ifdef BOOST_NO_EXCEPTIONS
    TORRENT_ASSERT(m_type_queried);
#endif
    if (m_type != string_t) throw_error();
    TORRENT_ASSERT(m_type == string_t);
    return *reinterpret_cast<string_type*>(&data);
  }

  entry::string_type const& entry::string() const
  {
    if (m_type != string_t) throw_error();
#ifdef BOOST_NO_EXCEPTIONS
    TORRENT_ASSERT(m_type_queried);
#endif
    TORRENT_ASSERT(m_type == string_t);
    return *reinterpret_cast<const string_type*>(&data);
  }

  entry::list_type& entry::list()
  {
    if (m_type == undefined_t) construct(list_t);
#ifdef BOOST_NO_EXCEPTIONS
    TORRENT_ASSERT(m_type_queried);
#endif
    if (m_type != list_t) throw_error();
    TORRENT_ASSERT(m_type == list_t);
    return *reinterpret_cast<list_type*>(&data);
  }

  entry::list_type const& entry::list() const
  {
    if (m_type != list_t) throw_error();
#ifdef BOOST_NO_EXCEPTIONS
    TORRENT_ASSERT(m_type_queried);
#endif
    TORRENT_ASSERT(m_type == list_t);
    return *reinterpret_cast<const list_type*>(&data);
  }

  entry::dictionary_type& entry::dict()
  {
    if (m_type == undefined_t) construct(dictionary_t);
#ifdef BOOST_NO_EXCEPTIONS
    TORRENT_ASSERT(m_type_queried);
#endif
    if (m_type != dictionary_t) throw_error();
    TORRENT_ASSERT(m_type == dictionary_t);
    return *reinterpret_cast<dictionary_type*>(&data);
  }

  entry::dictionary_type const& entry::dict() const
  {
    if (m_type != dictionary_t) throw_error();
#ifdef BOOST_NO_EXCEPTIONS
    TORRENT_ASSERT(m_type_queried);
#endif
    TORRENT_ASSERT(m_type == dictionary_t);
    return *reinterpret_cast<const dictionary_type*>(&data);
  }

  entry::preformatted_type& entry::preformatted()
  {
    if (m_type == undefined_t) construct(preformatted_t);
#ifdef BOOST_NO_EXCEPTIONS
    TORRENT_ASSERT(m_type_queried);
#endif
    if (m_type != preformatted_t) throw_error();
    TORRENT_ASSERT(m_type == preformatted_t);
    return *reinterpret_cast<preformatted_type*>(&data);
  }

  entry::preformatted_type const& entry::preformatted() const
  {
    if (m_type != preformatted_t) throw_error();
#ifdef BOOST_NO_EXCEPTIONS
    TORRENT_ASSERT(m_type_queried);
#endif
    TORRENT_ASSERT(m_type == preformatted_t);
    return *reinterpret_cast<const preformatted_type*>(&data);
  }

  entry::entry()
    : m_type(undefined_t)
  {
#if TORRENT_USE_ASSERTS
    m_type_queried = true;
#endif
  }

  entry::entry(data_type t)
    : m_type(undefined_t)
  {
    construct(t);
#if TORRENT_USE_ASSERTS
    m_type_queried = true;
#endif
  }

  entry::entry(const entry& e)
    : m_type(undefined_t)
  {
    copy(e);
#if TORRENT_USE_ASSERTS
    m_type_queried = e.m_type_queried;
#endif
  }

  entry::entry(entry&& e) noexcept
    : m_type(undefined_t)
  {
    this->operator=(std::move(e));
  }

  entry::entry(bdecode_node const& n)
    : m_type(undefined_t)
  {
    this->operator=(n);
  }

  entry::entry(dictionary_type v)
    : m_type(undefined_t)
  {
#if TORRENT_USE_ASSERTS
    m_type_queried = true;
#endif
    new(&data) dictionary_type(std::move(v));
    m_type = dictionary_t;
  }

  entry::entry(span<char const> v)
    : m_type(undefined_t)
  {
#if TORRENT_USE_ASSERTS
    m_type_queried = true;
#endif
    new(&data) string_type(v.data(), std::size_t(v.size()));
    m_type = string_t;
  }

  entry::entry(list_type v)
    : m_type(undefined_t)
  {
#if TORRENT_USE_ASSERTS
    m_type_queried = true;
#endif
    new(&data) list_type(std::move(v));
    m_type = list_t;
  }

  entry::entry(integer_type v)
    : m_type(undefined_t)
  {
#if TORRENT_USE_ASSERTS
    m_type_queried = true;
#endif
    new(&data) integer_type(std::move(v));
    m_type = int_t;
  }

  entry::entry(preformatted_type v)
    : m_type(undefined_t)
  {
#if TORRENT_USE_ASSERTS
    m_type_queried = true;
#endif
    new(&data) preformatted_type(std::move(v));
    m_type = preformatted_t;
  }

  // convert a bdecode_node into an old school entry
  entry& entry::operator=(bdecode_node const& e) &
  {
    destruct();
    switch (e.type())
    {
      case bdecode_node::string_t:
        this->string() = e.string_value().to_string();
        break;
      case bdecode_node::int_t:
        this->integer() = e.int_value();
        break;
      case bdecode_node::dict_t:
      {
        dictionary_type& d = this->dict();
        for (int i = 0; i < e.dict_size(); ++i)
        {
          std::pair<string_view, bdecode_node> elem = e.dict_at(i);
          d[elem.first.to_string()] = elem.second;
        }
        break;
      }
      case bdecode_node::list_t:
      {
        list_type& l = this->list();
        for (int i = 0; i < e.list_size(); ++i)
        {
          l.emplace_back();
          l.back() = e.list_at(i);
        }
        break;
      }
      case bdecode_node::none_t:
        break;
    }
    return *this;
  }

  entry& entry::operator=(preformatted_type v) &
  {
    destruct();
    new(&data) preformatted_type(std::move(v));
    m_type = preformatted_t;
#if TORRENT_USE_ASSERTS
    m_type_queried = true;
#endif
    return *this;
  }

  entry& entry::operator=(dictionary_type v) &
  {
    destruct();
    new(&data) dictionary_type(std::move(v));
    m_type = dictionary_t;
#if TORRENT_USE_ASSERTS
    m_type_queried = true;
#endif
    return *this;
  }

  entry& entry::operator=(span<char const> v) &
  {
    destruct();
    new(&data) string_type(v.data(), std::size_t(v.size()));
    m_type = string_t;
#if TORRENT_USE_ASSERTS
    m_type_queried = true;
#endif
    return *this;
  }

  entry& entry::operator=(list_type v) &
  {
    destruct();
    new(&data) list_type(std::move(v));
    m_type = list_t;
#if TORRENT_USE_ASSERTS
    m_type_queried = true;
#endif
    return *this;
  }

  entry& entry::operator=(integer_type v) &
  {
    destruct();
    new(&data) integer_type(std::move(v));
    m_type = int_t;
#if TORRENT_USE_ASSERTS
    m_type_queried = true;
#endif
    return *this;
  }

  bool operator==(entry const& lhs, entry const& rhs)
  {
    if (lhs.type() != rhs.type()) return false;

    switch (lhs.type())
    {
    case entry::int_t:
      return lhs.integer() == rhs.integer();
    case entry::string_t:
      return lhs.string() == rhs.string();
    case entry::list_t:
      return lhs.list() == rhs.list();
    case entry::dictionary_t:
      return lhs.dict() == rhs.dict();
    case entry::preformatted_t:
      return lhs.preformatted() == rhs.preformatted();
    case entry::undefined_t:
      return true;
    }
    return false;
  }

  void entry::construct(data_type t)
  {
    switch (t)
    {
    case int_t:
      new (&data) integer_type(0);
      break;
    case string_t:
      new (&data) string_type;
      break;
    case list_t:
      new (&data) list_type;
      break;
    case dictionary_t:
      new (&data) dictionary_type;
      break;
    case undefined_t:
      break;
    case preformatted_t:
      new (&data) preformatted_type;
      break;
    }
    m_type = t;
#if TORRENT_USE_ASSERTS
    m_type_queried = true;
#endif
  }

  void entry::copy(entry const& e)
  {
    switch (e.type())
    {
    case int_t:
      new (&data) integer_type(e.integer());
      break;
    case string_t:
      new (&data) string_type(e.string());
      break;
    case list_t:
      new (&data) list_type(e.list());
      break;
    case dictionary_t:
      new (&data) dictionary_type(e.dict());
      break;
    case undefined_t:
      TORRENT_ASSERT(e.type() == undefined_t);
      break;
    case preformatted_t:
      new (&data) preformatted_type(e.preformatted());
      break;
    }
    m_type = e.type();
#if TORRENT_USE_ASSERTS
    m_type_queried = true;
#endif
  }

  void entry::destruct()
  {
    switch(m_type)
    {
    case int_t:
      call_destructor(reinterpret_cast<integer_type*>(&data));
      break;
    case string_t:
      call_destructor(reinterpret_cast<string_type*>(&data));
      break;
    case list_t:
      call_destructor(reinterpret_cast<list_type*>(&data));
      break;
    case dictionary_t:
      call_destructor(reinterpret_cast<dictionary_type*>(&data));
      break;
    case preformatted_t:
      call_destructor(reinterpret_cast<preformatted_type*>(&data));
      break;
    default:
      TORRENT_ASSERT(m_type == undefined_t);
      break;
    }
    m_type = undefined_t;
#if TORRENT_USE_ASSERTS
    m_type_queried = false;
#endif
  }

  void entry::swap(entry& e)
  {
    bool clear_this = false;
    bool clear_that = false;

    if (m_type == undefined_t && e.m_type == undefined_t)
      return;

    if (m_type == undefined_t)
    {
      construct(data_type(e.m_type));
      clear_that = true;
    }

    if (e.m_type == undefined_t)
    {
      e.construct(data_type(m_type));
      clear_this = true;
    }

    if (m_type == e.m_type)
    {
      switch (m_type)
      {
      case int_t:
        std::swap(*reinterpret_cast<integer_type*>(&data)
          , *reinterpret_cast<integer_type*>(&e.data));
        break;
      case string_t:
        std::swap(*reinterpret_cast<string_type*>(&data)
          , *reinterpret_cast<string_type*>(&e.data));
        break;
      case list_t:
        std::swap(*reinterpret_cast<list_type*>(&data)
          , *reinterpret_cast<list_type*>(&e.data));
        break;
      case dictionary_t:
        std::swap(*reinterpret_cast<dictionary_type*>(&data)
          , *reinterpret_cast<dictionary_type*>(&e.data));
        break;
      case preformatted_t:
        std::swap(*reinterpret_cast<preformatted_type*>(&data)
          , *reinterpret_cast<preformatted_type*>(&e.data));
        break;
      default:
        break;
      }

      if (clear_this)
        destruct();

      if (clear_that)
        e.destruct();
    }
    else
    {
      // currently, only swapping entries of the same type or where one
      // of the entries is uninitialized is supported.
      TORRENT_ASSERT_FAIL();
    }
  }

namespace {
  bool is_binary(std::string const& str)
  {
    return std::any_of(str.begin(), str.end()
      , [](char const c) { return !is_print(c); });
  }

  std::string print_string(std::string const& str)
  {
    if (is_binary(str)) return aux::to_hex(str);
    else return str;
  }

  void add_indent(std::string& out, int const indent)
  {
    out.resize(out.size() + size_t(indent), ' ');
  }

  void print_list(std::string&, entry const&, int, bool);
  void print_dict(std::string&, entry const&, int, bool);

  void to_string_impl(std::string& out, entry const& e, int const indent
    , bool const single_line)
  {
    TORRENT_ASSERT(indent >= 0);
    switch (e.type())
    {
    case entry::int_t:
      out += libtorrent::to_string(e.integer()).data();
      break;
    case entry::string_t:
      out += "'";
      out += print_string(e.string());
      out += "'";
      break;
    case entry::list_t:
      print_list(out, e, indent + 1, single_line);
      break;
    case entry::dictionary_t:
      print_dict(out, e, indent + 1, single_line);
      break;
    case entry::preformatted_t:
      out += "<preformatted>";
      break;
    case entry::undefined_t:
      out += "<uninitialized>";
      break;
    }
  }

  void print_list(std::string& out, entry const& e
    , int const indent, bool const single_line)
  {
    out += single_line ? "[ " : "[\n";
    bool first = true;
    for (auto const& item : e.list())
    {
      if (!first) out += single_line ? ", " : ",\n";
      first = false;
      if (!single_line) add_indent(out, indent);
      to_string_impl(out, item, indent, single_line);
    }
    out += " ]";
  }

  void print_dict(std::string& out, entry const& e
    , int const indent, bool const single_line)
  {
    out += single_line ? "{ " : "{\n";
    bool first = true;
    for (auto const& item : e.dict())
    {
      if (!first) out += single_line ? ", " : ",\n";
      first = false;
      if (!single_line) add_indent(out, indent);
      out += "'";
      out += print_string(item.first);
      out += "': ";

      to_string_impl(out, item.second, indent+1, single_line);
    }
    out += " }";
  }
}

  std::string entry::to_string(bool const single_line) const
  {
    std::string ret;
    to_string_impl(ret, *this, 0, single_line);
    return ret;
  }

}

Coverage Report

Created: 2025-11-24 06:32