/*

Copyright (c) 2015-2020, Arvid Norberg
Copyright (c) 2016, 2018, 2020, Alden Torres
Copyright (c) 2017-2018, Steven Siloti
All rights reserved.

You may use, distribute and modify this code under the terms of the BSD license,
see LICENSE file.
*/

#ifndef TORRENT_ANNOUNCE_ENTRY_HPP_INCLUDED
#define TORRENT_ANNOUNCE_ENTRY_HPP_INCLUDED

#include "libtorrent/config.hpp"
#include "libtorrent/fwd.hpp"
#include "libtorrent/time.hpp"
#include "libtorrent/error_code.hpp"
#include "libtorrent/string_view.hpp"
#include "libtorrent/socket.hpp"
#include "libtorrent/aux_/array.hpp"
#include "libtorrent/info_hash.hpp"

#include <string>
#include <cstdint>
#include <vector>

namespace libtorrent {

namespace aux { struct torrent; }

TORRENT_VERSION_NAMESPACE_2

// holds the per-info-hash state for a tracker, separately for the v1
// and v2 info-hashes. Since a hybrid torrent has both info-hashes, the
// state for the two announces (the message returned by the tracker, the
// time of the next announce, the most recent scrape numbers, etc.) are
// kept independently. ``announce_endpoint`` owns one ``announce_infohash``
// for each protocol version.
struct TORRENT_EXPORT announce_infohash
{
	// internal
	TORRENT_UNEXPORT announce_infohash();

	// 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;

	// the time of next tracker announce
	time_point32 next_announce = (time_point32::min)();

	// no announces before this time
	time_point32 min_announce = (time_point32::min)();

	// TODO: include the number of peers received from this tracker, at last
	// announce

	// these are either -1 or the scrape information this tracker last
	// responded with. *incomplete* is the current number of downloaders in
	// the swarm, *complete* is the current number of seeds in the swarm and
	// *downloaded* is the cumulative number of completed downloads of this
	// torrent, since the beginning of time (from this tracker's point of
	// view).

	// if this tracker has returned scrape data, these fields are filled in
	// with valid numbers. Otherwise they are set to -1. ``incomplete`` counts
	// the number of current downloaders. ``complete`` counts the number of
	// current peers completed the download, or "seeds". ``downloaded`` is the
	// cumulative number of completed downloads.
	int scrape_incomplete = -1;
	int scrape_complete = -1;
	int scrape_downloaded = -1;

	// the number of times in a row we have failed to announce to this
	// tracker.
	std::uint8_t fails : 7;

	// true while we're waiting for a response from the tracker.
	bool updating : 1;

	// set to true when we get a valid response from an announce
	// with event=started. If it is set, we won't send start in the subsequent
	// announces.
	bool start_sent : 1;

	// set to true when we send a event=completed.
	bool complete_sent : 1;

	// internal
	bool triggered_manually : 1;

#if TORRENT_ABI_VERSION <= 2
		// reset announce counters and clears the started sent flag.
		// The announce_endpoint will look like we've never talked to
		// the tracker.
		TORRENT_DEPRECATED void reset();

		// updates the failure counter and time-outs for re-trying.
		// This is called when the tracker announce fails.
		TORRENT_DEPRECATED void failed(int backoff_ratio, seconds32 retry_interval = seconds32(0));

		// returns true if we can announce to this tracker now.
		// The current time is passed in as ``now``. The ``is_seed``
		// argument is necessary because once we become a seed, we
		// need to announce right away, even if the re-announce timer
		// hasn't expired yet.
		TORRENT_DEPRECATED bool can_announce(time_point now, bool is_seed, std::uint8_t fail_limit) const;

		// returns true if the last time we tried to announce to this
		// tracker succeeded, or if we haven't tried yet.
		TORRENT_DEPRECATED bool is_working() const { return fails == 0; }
#endif
};

	// announces are sent to each tracker using every listen socket
	// this class holds information about one listen socket for one tracker
#if TORRENT_ABI_VERSION <= 2
	// this is to suppress deprecation warnings from implicit move constructor
#include "libtorrent/aux_/disable_warnings_push.hpp"
#endif
	struct TORRENT_EXPORT announce_endpoint
	{
#if TORRENT_ABI_VERSION <= 2
#include "libtorrent/aux_/disable_warnings_pop.hpp"
#endif

		announce_endpoint();

		// the local endpoint of the listen interface associated with this endpoint
		tcp::endpoint local_endpoint;

		// torrents can be announced using multiple info hashes
		// for different protocol versions

		// info_hashes[0] is the v1 info hash (SHA1)
		// info_hashes[1] is the v2 info hash (truncated SHA-256)
		aux::array<announce_infohash, num_protocols, protocol_version> info_hashes;

#if TORRENT_ABI_VERSION <= 2
		// reset announce counters and clears the started sent flag.
		// The announce_endpoint will look like we've never talked to
		// the tracker.
		TORRENT_DEPRECATED void reset();

		// deprecated in 2.0, use announce_infohash::can_announce
		// returns true if we can announce to this tracker now.
		// The current time is passed in as ``now``. The ``is_seed``
		// argument is necessary because once we become a seed, we
		// need to announce right away, even if the re-announce timer
		// hasn't expired yet.
		TORRENT_DEPRECATED bool can_announce(time_point now, bool is_seed, std::uint8_t fail_limit) const;

		// deprecated in 2.0, use announce_infohash::is_working
		// returns true if the last time we tried to announce to this
		// tracker succeeded, or if we haven't tried yet.
		TORRENT_DEPRECATED bool is_working() const;

		// for backwards compatibility
		TORRENT_DEPRECATED time_point32 next_announce = (time_point32::min)();
		TORRENT_DEPRECATED time_point32 min_announce = (time_point32::min)();
		TORRENT_DEPRECATED std::string message;
		TORRENT_DEPRECATED error_code last_error;
		TORRENT_DEPRECATED int scrape_incomplete = -1;
		TORRENT_DEPRECATED int scrape_complete = -1;
		TORRENT_DEPRECATED int scrape_downloaded = -1;
		TORRENT_DEPRECATED std::uint8_t fails : 7;
		TORRENT_DEPRECATED bool updating : 1;
		TORRENT_DEPRECATED bool start_sent : 1;
		TORRENT_DEPRECATED bool complete_sent : 1;
#endif

		// set to false to not announce from this endpoint
		bool enabled = true;
	};

	// this class holds information about one bittorrent tracker, as it
	// relates to a specific torrent.
	struct TORRENT_EXPORT announce_entry
	{
		// constructs a tracker announce entry with ``u`` as the URL.
		explicit announce_entry(string_view u);
		announce_entry();
		~announce_entry();
		announce_entry(announce_entry const&);
		announce_entry& operator=(announce_entry const&) &;

		// tracker URL as it appeared in the torrent file
		std::string url;

		// the current ``&trackerid=`` argument passed to the tracker.
		// this is optional and is normally empty (in which case no
		// trackerid is sent).
		std::string trackerid;

		// each local listen socket (endpoint) will announce to the tracker. This
		// list contains state per endpoint.
		std::vector<announce_endpoint> endpoints;

		// the tier this tracker belongs to
		std::uint8_t tier = 0;

		// the max number of failures to announce to this tracker in
		// a row, before this tracker is not used anymore. 0 means unlimited
		std::uint8_t fail_limit = 0;

		// flags for the source bitmask, each indicating where
		// we heard about this tracker
		enum tracker_source
		{
			// the tracker was part of the .torrent file
			source_torrent = 1,
			// the tracker was added programmatically via the add_tracker() function
			source_client = 2,
			// the tracker was part of a magnet link
			source_magnet_link = 4,
			// the tracker was received from the swarm via tracker exchange
			source_tex = 8
		};

		// a bitmask specifying which sources we got this tracker from.
		std::uint8_t source:4;

		// set to true the first time we receive a valid response
		// from this tracker.
		bool verified:1;

#if TORRENT_ABI_VERSION == 1
		// deprecated in 1.2
		// all of these will be set to false or 0
		// use the corresponding members in announce_endpoint
		TORRENT_DEPRECATED std::uint8_t fails:7;
		TORRENT_DEPRECATED bool send_stats:1;
		TORRENT_DEPRECATED bool start_sent:1;
		TORRENT_DEPRECATED bool complete_sent:1;
		// internal
		TORRENT_DEPRECATED bool triggered_manually:1;
		TORRENT_DEPRECATED bool updating:1;
#endif

#if TORRENT_ABI_VERSION <= 2
		// reset announce counters and clears the started sent flag.
		// The announce_entry will look like we've never talked to
		// the tracker.
		TORRENT_DEPRECATED void reset();

		// trims whitespace characters from the beginning of the URL.
		TORRENT_DEPRECATED void trim();
#endif

#if TORRENT_ABI_VERSION == 1
		// deprecated in 1.2, use announce_endpoint::can_announce
		// returns true if we can announce to this tracker now.
		// The current time is passed in as ``now``. The ``is_seed``
		// argument is necessary because once we become a seed, we
		// need to announce right away, even if the re-announce timer
		// hasn't expired yet.
		TORRENT_DEPRECATED bool can_announce(time_point now, bool is_seed) const;

		// deprecated in 1.2, use announce_endpoint::is_working
		// returns true if the last time we tried to announce to this
		// tracker succeeded, or if we haven't tried yet.
		TORRENT_DEPRECATED bool is_working() const;
#endif
	};

TORRENT_VERSION_NAMESPACE_2_END

}

#endif