2015-04-14 21:59:41 +08:00
|
|
|
package torrent
|
|
|
|
|
2015-04-28 13:24:17 +08:00
|
|
|
import (
|
2016-05-03 14:47:11 +08:00
|
|
|
"strings"
|
|
|
|
|
2015-09-06 10:33:22 +08:00
|
|
|
"github.com/anacrolix/missinggo/pubsub"
|
2016-01-06 09:19:49 +08:00
|
|
|
|
2015-04-28 13:24:17 +08:00
|
|
|
"github.com/anacrolix/torrent/metainfo"
|
|
|
|
)
|
|
|
|
|
2015-09-06 10:31:23 +08:00
|
|
|
// The torrent's infohash. This is fixed and cannot change. It uniquely
|
|
|
|
// identifies a torrent.
|
2016-04-04 11:01:31 +08:00
|
|
|
func (t *Torrent) InfoHash() metainfo.Hash {
|
2016-04-03 16:40:43 +08:00
|
|
|
return t.infoHash
|
2015-08-02 01:55:48 +08:00
|
|
|
}
|
|
|
|
|
2016-04-20 18:10:10 +08:00
|
|
|
// Returns a channel that is closed when the info (.Info()) for the torrent
|
|
|
|
// has become available.
|
2016-04-03 16:40:43 +08:00
|
|
|
func (t *Torrent) GotInfo() <-chan struct{} {
|
2016-05-09 14:44:06 +08:00
|
|
|
t.cl.mu.Lock()
|
|
|
|
defer t.cl.mu.Unlock()
|
2016-05-09 13:47:39 +08:00
|
|
|
return t.gotMetainfo.C()
|
2015-04-28 13:24:17 +08:00
|
|
|
}
|
|
|
|
|
2016-01-16 22:49:34 +08:00
|
|
|
// Returns the metainfo info dictionary, or nil if it's not yet available.
|
2016-08-26 18:29:05 +08:00
|
|
|
func (t *Torrent) Info() *metainfo.Info {
|
2017-08-29 13:16:53 +08:00
|
|
|
t.cl.mu.Lock()
|
|
|
|
defer t.cl.mu.Unlock()
|
2016-04-03 16:40:43 +08:00
|
|
|
return t.info
|
2015-04-14 21:59:41 +08:00
|
|
|
}
|
|
|
|
|
2015-06-03 11:30:55 +08:00
|
|
|
// Returns a Reader bound to the torrent's data. All read calls block until
|
2016-01-28 14:22:10 +08:00
|
|
|
// the data requested is actually available.
|
2018-01-06 13:37:13 +08:00
|
|
|
func (t *Torrent) NewReader() Reader {
|
|
|
|
r := reader{
|
2016-08-30 13:41:26 +08:00
|
|
|
mu: &t.cl.mu,
|
2016-04-03 16:40:43 +08:00
|
|
|
t: t,
|
2015-04-14 21:59:41 +08:00
|
|
|
readahead: 5 * 1024 * 1024,
|
|
|
|
}
|
2018-01-06 13:37:13 +08:00
|
|
|
t.addReader(&r)
|
|
|
|
return &r
|
2015-04-14 21:59:41 +08:00
|
|
|
}
|
2015-06-01 16:22:12 +08:00
|
|
|
|
|
|
|
// Returns the state of pieces of the torrent. They are grouped into runs of
|
|
|
|
// same state. The sum of the state run lengths is the number of pieces
|
|
|
|
// in the torrent.
|
2016-04-03 16:40:43 +08:00
|
|
|
func (t *Torrent) PieceStateRuns() []PieceStateRun {
|
2016-02-21 00:31:50 +08:00
|
|
|
t.cl.mu.Lock()
|
|
|
|
defer t.cl.mu.Unlock()
|
2016-04-03 16:40:43 +08:00
|
|
|
return t.pieceStateRuns()
|
2015-06-01 16:22:12 +08:00
|
|
|
}
|
2015-06-23 00:02:22 +08:00
|
|
|
|
2016-04-03 16:40:43 +08:00
|
|
|
func (t *Torrent) PieceState(piece int) PieceState {
|
2016-02-21 00:31:50 +08:00
|
|
|
t.cl.mu.Lock()
|
|
|
|
defer t.cl.mu.Unlock()
|
2016-04-03 16:40:43 +08:00
|
|
|
return t.pieceState(piece)
|
2016-02-07 18:57:57 +08:00
|
|
|
}
|
|
|
|
|
2016-01-16 22:49:34 +08:00
|
|
|
// The number of pieces in the torrent. This requires that the info has been
|
|
|
|
// obtained first.
|
2016-04-03 16:40:43 +08:00
|
|
|
func (t *Torrent) NumPieces() int {
|
|
|
|
return t.numPieces()
|
2015-06-23 00:02:22 +08:00
|
|
|
}
|
|
|
|
|
2017-06-02 12:46:28 +08:00
|
|
|
// Get missing bytes count for specific piece.
|
|
|
|
func (t *Torrent) PieceBytesMissing(piece int) int64 {
|
|
|
|
t.cl.mu.Lock()
|
|
|
|
defer t.cl.mu.Unlock()
|
|
|
|
|
|
|
|
return int64(t.pieces[piece].bytesLeft())
|
|
|
|
}
|
|
|
|
|
2016-04-18 19:52:30 +08:00
|
|
|
// Drop the torrent from the client, and close it. It's always safe to do
|
|
|
|
// this. No data corruption can, or should occur to either the torrent's data,
|
|
|
|
// or connected peers.
|
2016-04-03 16:40:43 +08:00
|
|
|
func (t *Torrent) Drop() {
|
2015-06-23 00:02:22 +08:00
|
|
|
t.cl.mu.Lock()
|
2016-04-03 16:40:43 +08:00
|
|
|
t.cl.dropTorrent(t.infoHash)
|
2015-06-23 00:02:22 +08:00
|
|
|
t.cl.mu.Unlock()
|
|
|
|
}
|
2015-07-21 20:54:02 +08:00
|
|
|
|
2015-09-06 10:31:23 +08:00
|
|
|
// Number of bytes of the entire torrent we have completed.
|
2016-04-03 16:40:43 +08:00
|
|
|
func (t *Torrent) BytesCompleted() int64 {
|
2015-07-21 20:54:02 +08:00
|
|
|
t.cl.mu.RLock()
|
|
|
|
defer t.cl.mu.RUnlock()
|
2016-04-03 16:40:43 +08:00
|
|
|
return t.bytesCompleted()
|
2015-07-21 20:54:02 +08:00
|
|
|
}
|
2015-09-06 10:33:22 +08:00
|
|
|
|
2015-12-12 11:00:07 +08:00
|
|
|
// The subscription emits as (int) the index of pieces as their state changes.
|
|
|
|
// A state change is when the PieceState for a piece alters in value.
|
2016-04-03 16:40:43 +08:00
|
|
|
func (t *Torrent) SubscribePieceStateChanges() *pubsub.Subscription {
|
|
|
|
return t.pieceStateChanges.Subscribe()
|
2015-09-06 10:33:22 +08:00
|
|
|
}
|
2015-11-22 15:44:33 +08:00
|
|
|
|
2015-12-12 11:00:07 +08:00
|
|
|
// Returns true if the torrent is currently being seeded. This occurs when the
|
|
|
|
// client is willing to upload without wanting anything in return.
|
2016-04-03 16:40:43 +08:00
|
|
|
func (t *Torrent) Seeding() bool {
|
2015-11-22 15:44:33 +08:00
|
|
|
t.cl.mu.Lock()
|
|
|
|
defer t.cl.mu.Unlock()
|
2016-05-11 19:44:55 +08:00
|
|
|
return t.seeding()
|
2015-11-22 15:44:33 +08:00
|
|
|
}
|
2015-12-12 11:03:04 +08:00
|
|
|
|
|
|
|
// Clobbers the torrent display name. The display name is used as the torrent
|
|
|
|
// name if the metainfo is not available.
|
2016-04-03 16:40:43 +08:00
|
|
|
func (t *Torrent) SetDisplayName(dn string) {
|
2015-12-12 11:03:04 +08:00
|
|
|
t.cl.mu.Lock()
|
|
|
|
defer t.cl.mu.Unlock()
|
2016-04-03 16:40:43 +08:00
|
|
|
t.setDisplayName(dn)
|
2015-12-12 11:03:04 +08:00
|
|
|
}
|
2016-01-16 21:14:15 +08:00
|
|
|
|
2016-01-16 22:49:34 +08:00
|
|
|
// The current working name for the torrent. Either the name in the info dict,
|
|
|
|
// or a display name given such as by the dn value in a magnet link, or "".
|
2016-04-03 16:40:43 +08:00
|
|
|
func (t *Torrent) Name() string {
|
2016-01-16 21:14:15 +08:00
|
|
|
t.cl.mu.Lock()
|
|
|
|
defer t.cl.mu.Unlock()
|
2016-04-03 16:40:43 +08:00
|
|
|
return t.name()
|
2016-01-16 21:14:15 +08:00
|
|
|
}
|
|
|
|
|
2016-04-20 18:10:10 +08:00
|
|
|
// The completed length of all the torrent data, in all its files. This is
|
|
|
|
// derived from the torrent info, when it is available.
|
2016-04-03 16:40:43 +08:00
|
|
|
func (t *Torrent) Length() int64 {
|
2016-04-20 18:10:39 +08:00
|
|
|
if t.info == nil {
|
|
|
|
panic("not valid until info obtained")
|
2016-01-16 21:14:15 +08:00
|
|
|
}
|
2016-04-20 18:10:39 +08:00
|
|
|
return t.length
|
2016-01-16 21:14:15 +08:00
|
|
|
}
|
2016-01-16 22:49:04 +08:00
|
|
|
|
|
|
|
// Returns a run-time generated metainfo for the torrent that includes the
|
|
|
|
// info bytes and announce-list as currently known to the client.
|
2016-08-26 18:29:05 +08:00
|
|
|
func (t *Torrent) Metainfo() metainfo.MetaInfo {
|
2016-01-16 22:49:04 +08:00
|
|
|
t.cl.mu.Lock()
|
|
|
|
defer t.cl.mu.Unlock()
|
2016-05-22 20:45:08 +08:00
|
|
|
return t.newMetaInfo()
|
2016-01-16 22:49:04 +08:00
|
|
|
}
|
2016-01-18 15:35:14 +08:00
|
|
|
|
2018-01-06 13:37:13 +08:00
|
|
|
func (t *Torrent) addReader(r *reader) {
|
2016-01-18 15:35:14 +08:00
|
|
|
t.cl.mu.Lock()
|
|
|
|
defer t.cl.mu.Unlock()
|
2016-04-03 16:40:43 +08:00
|
|
|
if t.readers == nil {
|
2018-01-06 13:37:13 +08:00
|
|
|
t.readers = make(map[*reader]struct{})
|
2016-01-18 15:35:14 +08:00
|
|
|
}
|
2016-04-03 16:40:43 +08:00
|
|
|
t.readers[r] = struct{}{}
|
2016-10-31 16:00:08 +08:00
|
|
|
r.posChanged()
|
2016-01-18 15:35:14 +08:00
|
|
|
}
|
|
|
|
|
2018-01-06 13:37:13 +08:00
|
|
|
func (t *Torrent) deleteReader(r *reader) {
|
2016-04-03 16:40:43 +08:00
|
|
|
delete(t.readers, r)
|
|
|
|
t.readersChanged()
|
2016-01-18 15:35:14 +08:00
|
|
|
}
|
2016-01-18 22:28:56 +08:00
|
|
|
|
2016-04-03 16:40:43 +08:00
|
|
|
func (t *Torrent) DownloadPieces(begin, end int) {
|
2016-01-18 22:28:56 +08:00
|
|
|
t.cl.mu.Lock()
|
|
|
|
defer t.cl.mu.Unlock()
|
2016-04-03 16:40:43 +08:00
|
|
|
t.pendPieceRange(begin, end)
|
2016-02-04 22:18:54 +08:00
|
|
|
}
|
|
|
|
|
2016-04-03 16:40:43 +08:00
|
|
|
func (t *Torrent) CancelPieces(begin, end int) {
|
2016-02-04 22:18:54 +08:00
|
|
|
t.cl.mu.Lock()
|
|
|
|
defer t.cl.mu.Unlock()
|
2016-04-03 16:40:43 +08:00
|
|
|
t.unpendPieceRange(begin, end)
|
2016-02-20 11:39:56 +08:00
|
|
|
}
|
2016-05-03 14:47:11 +08:00
|
|
|
|
|
|
|
// Returns handles to the files in the torrent. This requires the metainfo is
|
|
|
|
// available first.
|
|
|
|
func (t *Torrent) Files() (ret []File) {
|
|
|
|
info := t.Info()
|
|
|
|
if info == nil {
|
|
|
|
return
|
|
|
|
}
|
|
|
|
var offset int64
|
|
|
|
for _, fi := range info.UpvertedFiles() {
|
|
|
|
ret = append(ret, File{
|
|
|
|
t,
|
|
|
|
strings.Join(append([]string{info.Name}, fi.Path...), "/"),
|
|
|
|
offset,
|
|
|
|
fi.Length,
|
|
|
|
fi,
|
|
|
|
})
|
|
|
|
offset += fi.Length
|
|
|
|
}
|
|
|
|
return
|
|
|
|
}
|
|
|
|
|
2016-05-12 10:26:09 +08:00
|
|
|
func (t *Torrent) AddPeers(pp []Peer) {
|
2016-05-03 14:47:11 +08:00
|
|
|
cl := t.cl
|
|
|
|
cl.mu.Lock()
|
|
|
|
defer cl.mu.Unlock()
|
2016-06-15 13:29:47 +08:00
|
|
|
t.addPeers(pp)
|
2016-05-03 14:47:11 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
// Marks the entire torrent for download. Requires the info first, see
|
|
|
|
// GotInfo.
|
|
|
|
func (t *Torrent) DownloadAll() {
|
|
|
|
t.cl.mu.Lock()
|
|
|
|
defer t.cl.mu.Unlock()
|
|
|
|
t.pendPieceRange(0, t.numPieces())
|
|
|
|
}
|
|
|
|
|
|
|
|
func (t *Torrent) String() string {
|
|
|
|
s := t.name()
|
|
|
|
if s == "" {
|
2017-07-01 14:02:06 +08:00
|
|
|
s = t.infoHash.HexString()
|
2016-05-03 14:47:11 +08:00
|
|
|
}
|
|
|
|
return s
|
|
|
|
}
|
2016-05-23 08:18:58 +08:00
|
|
|
|
2017-02-15 15:40:30 +08:00
|
|
|
func (t *Torrent) AddTrackers(announceList [][]string) {
|
2016-05-23 08:18:58 +08:00
|
|
|
t.cl.mu.Lock()
|
|
|
|
defer t.cl.mu.Unlock()
|
2017-02-15 15:40:30 +08:00
|
|
|
t.addTrackers(announceList)
|
2016-05-23 08:18:58 +08:00
|
|
|
}
|
2017-09-15 17:22:32 +08:00
|
|
|
|
2017-09-15 17:35:16 +08:00
|
|
|
func (t *Torrent) Piece(i int) *Piece {
|
2017-09-15 17:22:32 +08:00
|
|
|
t.cl.mu.Lock()
|
|
|
|
defer t.cl.mu.Unlock()
|
|
|
|
return &t.pieces[i]
|
|
|
|
}
|