Class MagnetPlugin

java.lang.Object

com.biglybt.plugin.magnet.MagnetPlugin

All Implemented Interfaces:

Plugin

public class MagnetPlugin
extends Object
implements Plugin

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	MagnetPlugin.DownloadActivity
private static interface	MagnetPlugin.DownloadAsyncListener
private static class	MagnetPlugin.DownloadResult
private static interface	MagnetPlugin.DownloadResultListener

Field Summary

Fields

Modifier and Type	Field	Description
private static DistributedDatabase[]	db_holder
private static AESemaphore	db_waiter
protected static final Object	DM_CATEGORY_CACHE
protected static final Object	DM_DN_CHANGED
protected static final Object	DM_TAG_CACHE
private static ByteArrayHashMap<MagnetPlugin.DownloadActivity>	download_activities
private static ByteArrayHashMap<Integer>	download_start_states
private boolean	first_download
static final int	FL_DISABLE_MD_LOOKUP
static final int	FL_NO_MD_LOOKUP_DELAY
static final int	FL_NONE
static final int	FL_RECOVERING
private CopyOnWriteList	listeners
private BooleanParameter	magnet_recovery
private BooleanParameter	magnet_rename
private StringParameter	md_extra_trackers
private static final String[]	MD_EXTRA_TRACKERS
private BooleanParameter	md_lookup
private IntParameter	md_lookup_delay
private static final int	MD_LOOKUP_DELAY_SECS_DEFAULT
private BooleanParameter	md_start_stopped
private Map<String, BooleanParameter>	net_params
private static final String	PLUGIN_CONFIGSECTION_ID
private static final int	PLUGIN_DOWNLOAD_TIMEOUT_SECS_DEFAULT
private PluginInterface	plugin_interface
private static final String	PLUGIN_NAME
static final String[]	SOURCE_KEYS
static final String[]	SOURCE_STRINGS
static final String[]	SOURCE_VALUES
private IntParameter	sources_extra_param
private StringListParameter	sources_param
protected static final int	SS_FORCE_START
protected static final int	SS_START
protected static final int	SS_STOPPED
private DirectoryParameter	storage_folder
private IntParameter	timeout_param

Constructor Summary

Constructors

Constructor	Description
MagnetPlugin()

Method Summary

Modifier and Type	Method	Description
private void	_downloadSupport(MagnetPluginProgressListener listener, byte[] hash, String args, InetSocketAddress[] sources, List<String> tags, Map<String,Object> initial_metadata, long _timeout, int flags, MagnetPlugin.DownloadResultListener result_listener)
void	addListener(MagnetPluginListener listener)
String	addSource(Download download, String magnet, InetSocketAddress address)
private byte[]	addTrackersAndWebSeedsEtc(byte[] torrent_data, String args, Set<String> networks, List<String> initial_tags, Map<String,Object> other_metadata)
private byte[]	addTrackersAndWebSeedsEtc(MagnetPlugin.DownloadResult result, String args, List<String> tags, Map<String,Object> other_metadata)
byte[]	badge()
byte[]	download(MagnetPluginProgressListener listener, byte[] hash, String args, InetSocketAddress[] sources, List<String> tags, Map<String,Object> other_metadata, long timeout, int flags)
void	downloadAsync(MagnetPluginProgressListener listener, byte[] hash, String args, InetSocketAddress[] sources, List<String> tags, Map<String,Object> other_metadata, long timeout, int flags, MagnetPlugin.DownloadAsyncListener dl_listener)
private void	downloadSupport(MagnetPluginProgressListener listener, byte[] hash, String args, InetSocketAddress[] sources, List<String> tags, Map<String,Object> initial_metadata, long timeout, int flags, MagnetPlugin.DownloadResultListener _result_listener)
protected File	getDefaultStorageDir()
List<String>	getExtraTrackers()
protected Map<String,Object>	getInitialMetadata(DownloadManager dm, Map<String,Object> existing_md)
protected List<String>	getInitialTags(DownloadManager from_dm)
URL	getMagnetURL(byte[] hash)
URL	getMagnetURL(TOTorrent torrent)
protected int	getMDDownloadStartState(DownloadManager dm)
protected String	getMessageText(String resource, String... params)
protected boolean	getRenameDisplayName()
protected File	getStorageDir()
void	initialize(PluginInterface _plugin_interface)	This method is called when the Plugin is loaded by the client
boolean	isNetworkEnabled(String net)
static void	load(PluginInterface plugin_interface)
private void	recoverableDownload(MagnetURIHandlerProgressListener muh_listener, byte[] hash, String args, InetSocketAddress[] sources, List<String> tags, Map<String,Object> other_metadata, long timeout, Long added_time, boolean is_recovering, MagnetPlugin.DownloadAsyncListener _dl_listener)
private void	recoverDownloads()
void	removeListener(MagnetPluginListener listener)
protected void	setDNChanged(DownloadManager dm)
protected void	setInitialMetadata(DownloadManager to_dm, List<String> tags, Map<String,Object> other_metadata)
private boolean	setInitialMetadata(TOTorrent torrent, List<String> tags, Map<String,Object> other_metadata)
protected boolean	updateInitialMetadata(Map map, DownloadManager from_dm)
protected void	updateLocale(LocaleUtilities lu)
private void	updateRecoverableDownloads()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Plugin

getInitialProperties

Field Details

FL_NONE

public static final int FL_NONE

See Also:

• Constant Field Values

FL_DISABLE_MD_LOOKUP

public static final int FL_DISABLE_MD_LOOKUP

See Also:

• Constant Field Values

FL_NO_MD_LOOKUP_DELAY

public static final int FL_NO_MD_LOOKUP_DELAY

See Also:

• Constant Field Values

FL_RECOVERING

public static final int FL_RECOVERING

See Also:

• Constant Field Values

MD_LOOKUP_DELAY_SECS_DEFAULT

private static final int MD_LOOKUP_DELAY_SECS_DEFAULT

See Also:

• Constant Field Values

MD_EXTRA_TRACKERS

private static final String[] MD_EXTRA_TRACKERS

PLUGIN_NAME

private static final String PLUGIN_NAME

See Also:

• Constant Field Values

PLUGIN_CONFIGSECTION_ID

private static final String PLUGIN_CONFIGSECTION_ID

See Also:

• Constant Field Values

SOURCE_VALUES

public static final String[] SOURCE_VALUES

SOURCE_KEYS

public static final String[] SOURCE_KEYS

SOURCE_STRINGS

public static final String[] SOURCE_STRINGS

DM_TAG_CACHE

protected static final Object DM_TAG_CACHE

DM_CATEGORY_CACHE

protected static final Object DM_CATEGORY_CACHE

DM_DN_CHANGED

protected static final Object DM_DN_CHANGED

db_holder

private static DistributedDatabase[] db_holder

db_waiter

private static AESemaphore db_waiter

plugin_interface

private PluginInterface plugin_interface

listeners

private CopyOnWriteList listeners

first_download

private boolean first_download

PLUGIN_DOWNLOAD_TIMEOUT_SECS_DEFAULT

private static final int PLUGIN_DOWNLOAD_TIMEOUT_SECS_DEFAULT

See Also:

• Constant Field Values

md_lookup

private BooleanParameter md_lookup

md_lookup_delay

private IntParameter md_lookup_delay

md_start_stopped

private BooleanParameter md_start_stopped

md_extra_trackers

private StringParameter md_extra_trackers

timeout_param

private IntParameter timeout_param

sources_param

private StringListParameter sources_param

sources_extra_param

private IntParameter sources_extra_param

magnet_recovery

private BooleanParameter magnet_recovery

magnet_rename

private BooleanParameter magnet_rename

storage_folder

private DirectoryParameter storage_folder

net_params

private Map<String, BooleanParameter> net_params

download_activities

private static ByteArrayHashMap<MagnetPlugin.DownloadActivity> download_activities

SS_FORCE_START

protected static final int SS_FORCE_START

See Also:

• Constant Field Values

SS_START

protected static final int SS_START

See Also:

• Constant Field Values

SS_STOPPED

protected static final int SS_STOPPED

See Also:

• Constant Field Values

download_start_states

private static ByteArrayHashMap<Integer> download_start_states

Constructor Details

MagnetPlugin

public MagnetPlugin()

Method Details

load

public static void load(PluginInterface plugin_interface)

initialize

public void initialize(PluginInterface _plugin_interface)

Description copied from interface: Plugin

This method is called when the Plugin is loaded by the client

Specified by:

initialize in interface Plugin

Parameters:

_plugin_interface - the interface that the plugin must use to communicate with the client

getRenameDisplayName

protected boolean getRenameDisplayName()

addSource

public String addSource(Download download,
 String magnet,
 InetSocketAddress address)

updateLocale

protected void updateLocale(LocaleUtilities lu)

recoverDownloads

private void recoverDownloads()

getDefaultStorageDir

protected File getDefaultStorageDir()

getStorageDir

protected File getStorageDir()

updateRecoverableDownloads

private void updateRecoverableDownloads()

recoverableDownload

private void recoverableDownload(MagnetURIHandlerProgressListener muh_listener,
 byte[] hash,
 String args,
 InetSocketAddress[] sources,
 List<String> tags,
 Map<String,Object> other_metadata,
 long timeout,
 Long added_time,
 boolean is_recovering,
 MagnetPlugin.DownloadAsyncListener _dl_listener)

isNetworkEnabled

public boolean isNetworkEnabled(String net)

getMagnetURL

public URL getMagnetURL(byte[] hash)

getMagnetURL

public URL getMagnetURL(TOTorrent torrent)
                 throws TOTorrentException

Throws:

TOTorrentException

getExtraTrackers

public List<String> getExtraTrackers()

badge

public byte[] badge()

download

public byte[] download(MagnetPluginProgressListener listener,
 byte[] hash,
 String args,
 InetSocketAddress[] sources,
 List<String> tags,
 Map<String,Object> other_metadata,
 long timeout,
 int flags)
                throws MagnetURIHandlerException

Throws:

MagnetURIHandlerException

downloadAsync

public void downloadAsync(MagnetPluginProgressListener listener,
 byte[] hash,
 String args,
 InetSocketAddress[] sources,
 List<String> tags,
 Map<String,Object> other_metadata,
 long timeout,
 int flags,
 MagnetPlugin.DownloadAsyncListener dl_listener)

addTrackersAndWebSeedsEtc

private byte[] addTrackersAndWebSeedsEtc(MagnetPlugin.DownloadResult result,
 String args,
 List<String> tags,
 Map<String,Object> other_metadata)

addTrackersAndWebSeedsEtc

private byte[] addTrackersAndWebSeedsEtc(byte[] torrent_data,
 String args,
 Set<String> networks,
 List<String> initial_tags,
 Map<String,Object> other_metadata)

getInitialTags

protected List<String> getInitialTags(DownloadManager from_dm)

updateInitialMetadata

protected boolean updateInitialMetadata(Map map,
 DownloadManager from_dm)

setDNChanged

protected void setDNChanged(DownloadManager dm)

getMDDownloadStartState

protected int getMDDownloadStartState(DownloadManager dm)

getInitialMetadata

protected Map<String,Object> getInitialMetadata(DownloadManager dm,
 Map<String,Object> existing_md)

setInitialMetadata

protected void setInitialMetadata(DownloadManager to_dm,
 List<String> tags,
 Map<String,Object> other_metadata)

setInitialMetadata

private boolean setInitialMetadata(TOTorrent torrent,
 List<String> tags,
 Map<String,Object> other_metadata)

downloadSupport

private void downloadSupport(MagnetPluginProgressListener listener,
 byte[] hash,
 String args,
 InetSocketAddress[] sources,
 List<String> tags,
 Map<String,Object> initial_metadata,
 long timeout,
 int flags,
 MagnetPlugin.DownloadResultListener _result_listener)

_downloadSupport

private void _downloadSupport(MagnetPluginProgressListener listener,
 byte[] hash,
 String args,
 InetSocketAddress[] sources,
 List<String> tags,
 Map<String,Object> initial_metadata,
 long _timeout,
 int flags,
 MagnetPlugin.DownloadResultListener result_listener)

getMessageText

protected String getMessageText(String resource,
 String... params)

addListener

public void addListener(MagnetPluginListener listener)

removeListener

public void removeListener(MagnetPluginListener listener)