/***************************************************************************
 *   Copyright (C) 2005 by Ivan Vasic                                      *
 *   ivasic@gmail.com                                                      *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.             *
 ***************************************************************************/
#ifndef BTTRACKERSLIST_H
#define BTTRACKERSLIST_H

#include <kurl.h>
#include <btcore_export.h>

namespace bt
{
	struct TrackerTier;

	/**
	 * @author Ivan Vasić <ivasic@gmail.com>
	 * 
	 * This interface is used to provide access to AnnounceList object which holds a list of available trackers for a torrent.
	*/
	class BTCORE_EXPORT TrackersList
	{
		public:
			TrackersList();
			virtual ~TrackersList();
			
			/**
			 * Get the current tracker URL.
			 */
			virtual KUrl getTrackerURL() const = 0;
			
			/**
			 * Gets a list of available trackers.
			 */
			virtual KUrl::List getTrackerURLs() = 0;
		
			/**
			 * Adds a tracker URL to the list.
			 * @param url The URL
			 * @param custom Is it a custom tracker
			 * @param tier Which tier (or priority) the tracker has, tier 1 are 
			 * the main trackers, tier 2 are backups ...
			 */
			virtual void addTracker(const KUrl &url, bool custom = true,int tier = 1) = 0;
		
			/**
			 * Removes the tracker from the list.
			 * @param url - Tracker url.
			 */
			virtual bool removeTracker(const KUrl &url) = 0;
		
			/**
			 * Sets the current tracker and does the announce.
			 * @param url - Tracker url.
			 */
			virtual void setTracker(const KUrl &url) = 0;
			
			/**
			 * Restores the default tracker and does the announce.
			 */
			virtual void restoreDefault() = 0;
			
			/**
			 * Enable or disable a tracker
			 * @param url The url 
			 * @param enabled True to enable, false to disable
			 */
			virtual void setTrackerEnabled(const KUrl & url,bool enabled) = 0;
			
			/**
			 * See if a tracker is enabled
			 * @param url The tracker url
			 * @return true if it is, false if it isn't
			 */
			virtual bool isTrackerEnabled(const KUrl & url) const = 0;
			
			/**
			 * Merge an other tracker list.
			 * @param first The first TrackerTier
			 */
			void merge(const bt::TrackerTier* first);

	};

}

#endif
