forked from premiere/premiere-libtorrent
515 lines
16 KiB
C++
515 lines
16 KiB
C++
/*
|
|
|
|
Copyright (c) 2003-2012, Arvid Norberg
|
|
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.
|
|
|
|
*/
|
|
|
|
#ifndef TORRENT_TORRENT_INFO_HPP_INCLUDED
|
|
#define TORRENT_TORRENT_INFO_HPP_INCLUDED
|
|
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
#ifdef _MSC_VER
|
|
#pragma warning(push, 1)
|
|
#endif
|
|
|
|
#include <boost/optional.hpp>
|
|
#include <boost/shared_array.hpp>
|
|
|
|
#ifdef _MSC_VER
|
|
#pragma warning(pop)
|
|
#endif
|
|
|
|
#include "libtorrent/config.hpp"
|
|
#include "libtorrent/entry.hpp"
|
|
#include "libtorrent/lazy_entry.hpp"
|
|
#include "libtorrent/peer_id.hpp"
|
|
#include "libtorrent/size_type.hpp"
|
|
#include "libtorrent/ptime.hpp"
|
|
#include "libtorrent/intrusive_ptr_base.hpp"
|
|
#include "libtorrent/assert.hpp"
|
|
#include "libtorrent/file_storage.hpp"
|
|
#include "libtorrent/copy_ptr.hpp"
|
|
#include "libtorrent/socket.hpp"
|
|
#include "libtorrent/policy.hpp" // for policy::peer
|
|
|
|
namespace libtorrent
|
|
{
|
|
class peer_connection;
|
|
struct session_settings;
|
|
|
|
enum
|
|
{
|
|
// wait at least 5 seconds before retrying a failed tracker
|
|
tracker_retry_delay_min = 5
|
|
// when tracker_failed_max trackers
|
|
// has failed, wait 60 minutes instead
|
|
, tracker_retry_delay_max = 60 * 60
|
|
};
|
|
|
|
TORRENT_EXTRA_EXPORT int merkle_num_leafs(int);
|
|
TORRENT_EXTRA_EXPORT int merkle_num_nodes(int);
|
|
TORRENT_EXTRA_EXPORT int merkle_get_parent(int);
|
|
TORRENT_EXTRA_EXPORT int merkle_get_sibling(int);
|
|
TORRENT_EXTRA_EXPORT void trim_path_element(std::string& path_element);
|
|
|
|
struct TORRENT_EXPORT announce_entry
|
|
{
|
|
announce_entry(std::string const& u);
|
|
announce_entry();
|
|
~announce_entry();
|
|
|
|
// tracker URL as it appeared in the torrent file
|
|
std::string url;
|
|
std::string trackerid;
|
|
|
|
// if this tracker has returned an error or warning message
|
|
// that message is stored here
|
|
std::string message;
|
|
|
|
// if this tracker failed the last time it was contacted
|
|
// this error code specifies what error occurred
|
|
error_code last_error;
|
|
|
|
int next_announce_in() const;
|
|
int min_announce_in() const;
|
|
|
|
// the time of next tracker announce
|
|
ptime next_announce;
|
|
|
|
// no announces before this time
|
|
ptime min_announce;
|
|
|
|
// TODO: include the number of peers received from this tracker, at last announce
|
|
|
|
// if this tracker has returned scrape data, these fields are filled
|
|
// in with valid numbers. Otherwise they are set to -1.
|
|
// the number of current downloaders
|
|
int scrape_incomplete;
|
|
// the number of current seeds
|
|
int scrape_complete;
|
|
// the cumulative number of completed downloads, ever
|
|
int scrape_downloaded;
|
|
|
|
// the tier this tracker belongs to
|
|
boost::uint8_t tier;
|
|
|
|
// the number of times this tracker can fail
|
|
// in a row before it's removed. 0 means unlimited
|
|
boost::uint8_t fail_limit;
|
|
|
|
// the number of times in a row this tracker has failed
|
|
boost::uint8_t fails:7;
|
|
|
|
// true if we're currently trying to announce with
|
|
// this tracker
|
|
bool updating:1;
|
|
|
|
enum tracker_source
|
|
{
|
|
source_torrent = 1,
|
|
source_client = 2,
|
|
source_magnet_link = 4,
|
|
source_tex = 8
|
|
};
|
|
|
|
// where did we get this tracker from
|
|
boost::uint8_t source:4;
|
|
|
|
// is set to true if we have ever received a response from
|
|
// this tracker
|
|
bool verified:1;
|
|
|
|
// this is true if event start has been sent to the tracker
|
|
bool start_sent:1;
|
|
|
|
// this is true if event completed has been sent to the tracker
|
|
bool complete_sent:1;
|
|
|
|
// this is false the stats sent to this tracker will be 0
|
|
bool send_stats:1;
|
|
|
|
void reset()
|
|
{
|
|
start_sent = false;
|
|
next_announce = min_time();
|
|
min_announce = min_time();
|
|
}
|
|
|
|
void failed(session_settings const& sett, int retry_interval = 0);
|
|
|
|
bool will_announce(ptime now) const
|
|
{
|
|
return now <= next_announce
|
|
&& (fails < fail_limit || fail_limit == 0)
|
|
&& !updating;
|
|
}
|
|
|
|
bool can_announce(ptime now, bool is_seed) const;
|
|
|
|
bool is_working() const
|
|
{ return fails == 0; }
|
|
|
|
void trim();
|
|
};
|
|
|
|
struct web_seed_entry
|
|
{
|
|
// http seeds are different from url seeds in the
|
|
// protocol they use. http seeds follows the original
|
|
// http seed spec. by John Hoffman
|
|
enum type_t { url_seed, http_seed };
|
|
|
|
typedef std::vector<std::pair<std::string, std::string> > headers_t;
|
|
|
|
web_seed_entry(std::string const& url_, type_t type_
|
|
, std::string const& auth_ = std::string()
|
|
, headers_t const& extra_headers_ = headers_t());
|
|
|
|
bool operator==(web_seed_entry const& e) const
|
|
{ return url == e.url && type == e.type; }
|
|
|
|
bool operator<(web_seed_entry const& e) const
|
|
{
|
|
if (url < e.url) return true;
|
|
if (url > e.url) return false;
|
|
return type < e.type;
|
|
}
|
|
|
|
std::string url;
|
|
type_t type;
|
|
std::string auth;
|
|
headers_t extra_headers;
|
|
|
|
// if this is > now, we can't reconnect yet
|
|
ptime retry;
|
|
|
|
// this indicates whether or not we're resolving the
|
|
// hostname of this URL
|
|
bool resolving;
|
|
|
|
// if the user wanted to remove this while
|
|
// we were resolving it. In this case, we set
|
|
// the removed flag to true, to make the resolver
|
|
// callback remove it
|
|
bool removed;
|
|
|
|
tcp::endpoint endpoint;
|
|
|
|
// this is the peer_info field used for the
|
|
// connection, just to count hash failures
|
|
// it's also used to hold the peer_connection
|
|
// pointer, when the web seed is connected
|
|
policy::peer peer_info;
|
|
};
|
|
|
|
#ifndef BOOST_NO_EXCEPTIONS
|
|
// for backwards compatibility with 0.14
|
|
typedef libtorrent_exception invalid_torrent_file;
|
|
#endif
|
|
|
|
class TORRENT_EXPORT torrent_info : public intrusive_ptr_base<torrent_info>
|
|
{
|
|
public:
|
|
|
|
#ifdef TORRENT_DEBUG
|
|
void check_invariant() const;
|
|
#endif
|
|
|
|
#ifndef BOOST_NO_EXCEPTIONS
|
|
torrent_info(lazy_entry const& torrent_file, int flags = 0);
|
|
torrent_info(char const* buffer, int size, int flags = 0);
|
|
torrent_info(std::string const& filename, int flags = 0);
|
|
#if TORRENT_USE_WSTRING
|
|
torrent_info(std::wstring const& filename, int flags = 0);
|
|
#endif // TORRENT_USE_WSTRING
|
|
#endif
|
|
|
|
torrent_info(torrent_info const& t, int flags = 0);
|
|
torrent_info(sha1_hash const& info_hash, int flags = 0);
|
|
torrent_info(lazy_entry const& torrent_file, error_code& ec, int flags = 0);
|
|
torrent_info(char const* buffer, int size, error_code& ec, int flags = 0);
|
|
torrent_info(std::string const& filename, error_code& ec, int flags = 0);
|
|
#if TORRENT_USE_WSTRING
|
|
torrent_info(std::wstring const& filename, error_code& ec, int flags = 0);
|
|
#endif // TORRENT_USE_WSTRING
|
|
|
|
~torrent_info();
|
|
|
|
file_storage const& files() const { return m_files; }
|
|
file_storage const& orig_files() const { return m_orig_files ? *m_orig_files : m_files; }
|
|
|
|
void rename_file(int index, std::string const& new_filename)
|
|
{
|
|
copy_on_write();
|
|
m_files.rename_file(index, new_filename);
|
|
}
|
|
|
|
#if TORRENT_USE_WSTRING
|
|
void rename_file(int index, std::wstring const& new_filename)
|
|
{
|
|
copy_on_write();
|
|
m_files.rename_file(index, new_filename);
|
|
}
|
|
#endif // TORRENT_USE_WSTRING
|
|
|
|
void remap_files(file_storage const& f);
|
|
|
|
void add_tracker(std::string const& url, int tier = 0);
|
|
std::vector<announce_entry> const& trackers() const { return m_urls; }
|
|
|
|
#ifndef TORRENT_NO_DEPRECATE
|
|
// deprecated in 0.16. Use web_seeds() instead
|
|
TORRENT_DEPRECATED_PREFIX
|
|
std::vector<std::string> url_seeds() const TORRENT_DEPRECATED;
|
|
TORRENT_DEPRECATED_PREFIX
|
|
std::vector<std::string> http_seeds() const TORRENT_DEPRECATED;
|
|
#endif // TORRENT_NO_DEPRECATE
|
|
|
|
void add_url_seed(std::string const& url
|
|
, std::string const& extern_auth = std::string()
|
|
, web_seed_entry::headers_t const& extra_headers = web_seed_entry::headers_t());
|
|
|
|
void add_http_seed(std::string const& url
|
|
, std::string const& extern_auth = std::string()
|
|
, web_seed_entry::headers_t const& extra_headers = web_seed_entry::headers_t());
|
|
|
|
std::vector<web_seed_entry> const& web_seeds() const
|
|
{ return m_web_seeds; }
|
|
|
|
size_type total_size() const { return m_files.total_size(); }
|
|
int piece_length() const { return m_files.piece_length(); }
|
|
int num_pieces() const { return m_files.num_pieces(); }
|
|
const sha1_hash& info_hash() const { return m_info_hash; }
|
|
const std::string& name() const { return m_files.name(); }
|
|
|
|
typedef file_storage::iterator file_iterator;
|
|
typedef file_storage::reverse_iterator reverse_file_iterator;
|
|
|
|
file_iterator begin_files() const { return m_files.begin(); }
|
|
file_iterator end_files() const { return m_files.end(); }
|
|
reverse_file_iterator rbegin_files() const { return m_files.rbegin(); }
|
|
reverse_file_iterator rend_files() const { return m_files.rend(); }
|
|
int num_files() const { return m_files.num_files(); }
|
|
file_entry file_at(int index) const { return m_files.at(index); }
|
|
|
|
file_iterator file_at_offset(size_type offset) const
|
|
{ return m_files.file_at_offset(offset); }
|
|
std::vector<file_slice> map_block(int piece, size_type offset, int size) const
|
|
{ return m_files.map_block(piece, offset, size); }
|
|
peer_request map_file(int file, size_type offset, int size) const
|
|
{ return m_files.map_file(file, offset, size); }
|
|
|
|
#ifndef TORRENT_NO_DEPRECATE
|
|
// ------- start deprecation -------
|
|
// these functions will be removed in a future version
|
|
TORRENT_DEPRECATED_PREFIX
|
|
torrent_info(entry const& torrent_file) TORRENT_DEPRECATED;
|
|
TORRENT_DEPRECATED_PREFIX
|
|
void print(std::ostream& os) const TORRENT_DEPRECATED;
|
|
// ------- end deprecation -------
|
|
#endif
|
|
|
|
#ifdef TORRENT_USE_OPENSSL
|
|
std::string const& ssl_cert() const { return m_ssl_root_cert; }
|
|
#endif
|
|
|
|
bool is_valid() const { return m_files.is_valid(); }
|
|
|
|
bool priv() const { return m_private; }
|
|
|
|
bool is_i2p() const { return m_i2p; }
|
|
|
|
int piece_size(int index) const { return m_files.piece_size(index); }
|
|
|
|
sha1_hash hash_for_piece(int index) const
|
|
{ return sha1_hash(hash_for_piece_ptr(index)); }
|
|
|
|
std::vector<sha1_hash> const& merkle_tree() const { return m_merkle_tree; }
|
|
void set_merkle_tree(std::vector<sha1_hash>& h)
|
|
{ TORRENT_ASSERT(h.size() == m_merkle_tree.size() ); m_merkle_tree.swap(h); }
|
|
|
|
char const* hash_for_piece_ptr(int index) const
|
|
{
|
|
TORRENT_ASSERT(index >= 0);
|
|
TORRENT_ASSERT(index < m_files.num_pieces());
|
|
if (is_merkle_torrent())
|
|
{
|
|
TORRENT_ASSERT(index < int(m_merkle_tree.size() - m_merkle_first_leaf));
|
|
return (const char*)&m_merkle_tree[m_merkle_first_leaf + index][0];
|
|
}
|
|
else
|
|
{
|
|
TORRENT_ASSERT(m_piece_hashes);
|
|
TORRENT_ASSERT(m_piece_hashes >= m_info_section.get());
|
|
TORRENT_ASSERT(m_piece_hashes < m_info_section.get() + m_info_section_size);
|
|
TORRENT_ASSERT(index < int(m_info_section_size / 20));
|
|
return &m_piece_hashes[index*20];
|
|
}
|
|
}
|
|
|
|
boost::optional<time_t> creation_date() const;
|
|
|
|
const std::string& creator() const
|
|
{ return m_created_by; }
|
|
|
|
const std::string& comment() const
|
|
{ return m_comment; }
|
|
|
|
// dht nodes to add to the routing table/bootstrap from
|
|
typedef std::vector<std::pair<std::string, int> > nodes_t;
|
|
|
|
nodes_t const& nodes() const
|
|
{ return m_nodes; }
|
|
void add_node(std::pair<std::string, int> const& node)
|
|
{ m_nodes.push_back(node); }
|
|
|
|
bool parse_info_section(lazy_entry const& e, error_code& ec, int flags);
|
|
|
|
lazy_entry const* info(char const* key) const
|
|
{
|
|
if (m_info_dict.type() == lazy_entry::none_t)
|
|
{
|
|
error_code ec;
|
|
lazy_bdecode(m_info_section.get(), m_info_section.get()
|
|
+ m_info_section_size, m_info_dict, ec);
|
|
}
|
|
return m_info_dict.dict_find(key);
|
|
}
|
|
|
|
void swap(torrent_info& ti);
|
|
|
|
boost::shared_array<char> metadata() const
|
|
{ return m_info_section; }
|
|
|
|
int metadata_size() const { return m_info_section_size; }
|
|
|
|
bool add_merkle_nodes(std::map<int, sha1_hash> const& subtree
|
|
, int piece);
|
|
std::map<int, sha1_hash> build_merkle_list(int piece) const;
|
|
bool is_merkle_torrent() const { return !m_merkle_tree.empty(); }
|
|
|
|
// if we're logging member offsets, we need access to them
|
|
#if !defined TORRENT_LOGGING \
|
|
&& !defined TORRENT_VERBOSE_LOGGING \
|
|
&& !defined TORRENT_ERROR_LOGGING
|
|
private:
|
|
#endif
|
|
|
|
// not assignable
|
|
torrent_info const& operator=(torrent_info const&);
|
|
|
|
void copy_on_write();
|
|
bool parse_torrent_file(lazy_entry const& libtorrent, error_code& ec, int flags);
|
|
|
|
// the index to the first leaf. This is where the hash for the
|
|
// first piece is stored
|
|
boost::uint32_t m_merkle_first_leaf;
|
|
|
|
file_storage m_files;
|
|
|
|
// if m_files is modified, it is first copied into
|
|
// m_orig_files so that the original name and
|
|
// filenames are preserved.
|
|
copy_ptr<const file_storage> m_orig_files;
|
|
|
|
// the urls to the trackers
|
|
std::vector<announce_entry> m_urls;
|
|
std::vector<web_seed_entry> m_web_seeds;
|
|
nodes_t m_nodes;
|
|
|
|
// if this is a merkle torrent, this is the merkle
|
|
// tree. It has space for merkle_num_nodes(merkle_num_leafs(num_pieces))
|
|
// hashes
|
|
std::vector<sha1_hash> m_merkle_tree;
|
|
|
|
// this is a copy of the info section from the torrent.
|
|
// it use maintained in this flat format in order to
|
|
// make it available through the metadata extension
|
|
boost::shared_array<char> m_info_section;
|
|
|
|
// this is a pointer into the m_info_section buffer
|
|
// pointing to the first byte of the first sha-1 hash
|
|
char const* m_piece_hashes;
|
|
|
|
// if a comment is found in the torrent file
|
|
// this will be set to that comment
|
|
// TODO: 2 these strings (m_comment, m_created_by, m_ssl_root_cert) could be lazy_entry* to save memory
|
|
std::string m_comment;
|
|
|
|
// an optional string naming the software used
|
|
// to create the torrent file
|
|
std::string m_created_by;
|
|
|
|
#ifdef TORRENT_USE_OPENSSL
|
|
// for ssl-torrens, this contains the root
|
|
// certificate, in .pem format (i.e. ascii
|
|
// base64 encoded with head and tails)
|
|
std::string m_ssl_root_cert;
|
|
#endif
|
|
|
|
// the info section parsed. points into m_info_section
|
|
// parsed lazily
|
|
mutable lazy_entry m_info_dict;
|
|
|
|
// if a creation date is found in the torrent file
|
|
// this will be set to that, otherwise it'll be
|
|
// 1970, Jan 1
|
|
time_t m_creation_date;
|
|
|
|
// the hash that identifies this torrent
|
|
sha1_hash m_info_hash;
|
|
|
|
// the number of bytes in m_info_section
|
|
boost::uint32_t m_info_section_size:24;
|
|
|
|
// this is used when creating a torrent. If there's
|
|
// only one file there are cases where it's impossible
|
|
// to know if it should be written as a multifile torrent
|
|
// or not. e.g. test/test there's one file and one directory
|
|
// and they have the same name.
|
|
bool m_multifile:1;
|
|
|
|
// this is true if the torrent is private. i.e., is should not
|
|
// be announced on the dht
|
|
bool m_private:1;
|
|
|
|
// this is true if one of the trackers has an .i2p top
|
|
// domain in its hostname. This means the DHT and LSD
|
|
// features are disabled for this torrent (unless the
|
|
// settings allows mixing i2p peers with regular peers)
|
|
bool m_i2p:1;
|
|
};
|
|
|
|
}
|
|
|
|
#endif // TORRENT_TORRENT_INFO_HPP_INCLUDED
|
|
|