client.go

   1 package torrent
   2
   3 import (
   4         "bufio"
   5         "bytes"
   6         "crypto/rand"
   7         "crypto/sha1"
   8         "encoding/hex"
   9         "errors"
  10         "expvar"
  11         "fmt"
  12         "io"
  13         "log"
  14         "math/big"
  15         mathRand "math/rand"
  16         "net"
  17         "net/url"
  18         "os"
  19         "path/filepath"
  20         "sort"
  21         "strconv"
  22         "strings"
  23         "time"
  24
  25         "github.com/anacrolix/missinggo"
  26         . "github.com/anacrolix/missinggo"
  27         "github.com/anacrolix/missinggo/perf"
  28         "github.com/anacrolix/missinggo/pubsub"
  29         "github.com/anacrolix/sync"
  30         "github.com/anacrolix/utp"
  31         "github.com/bradfitz/iter"
  32         "github.com/edsrzf/mmap-go"
  33
  34         "github.com/anacrolix/torrent/bencode"
  35         filePkg "github.com/anacrolix/torrent/data/file"
  36         "github.com/anacrolix/torrent/dht"
  37         "github.com/anacrolix/torrent/internal/pieceordering"
  38         "github.com/anacrolix/torrent/iplist"
  39         "github.com/anacrolix/torrent/metainfo"
  40         "github.com/anacrolix/torrent/mse"
  41         pp "github.com/anacrolix/torrent/peer_protocol"
  42         "github.com/anacrolix/torrent/tracker"
  43 )
  44
  45 var (
  46         unwantedChunksReceived   = expvar.NewInt("chunksReceivedUnwanted")
  47         unexpectedChunksReceived = expvar.NewInt("chunksReceivedUnexpected")
  48         chunksReceived           = expvar.NewInt("chunksReceived")
  49
  50         peersAddedBySource = expvar.NewMap("peersAddedBySource")
  51
  52         uploadChunksPosted    = expvar.NewInt("uploadChunksPosted")
  53         unexpectedCancels     = expvar.NewInt("unexpectedCancels")
  54         postedCancels         = expvar.NewInt("postedCancels")
  55         duplicateConnsAvoided = expvar.NewInt("duplicateConnsAvoided")
  56
  57         pieceHashedCorrect    = expvar.NewInt("pieceHashedCorrect")
  58         pieceHashedNotCorrect = expvar.NewInt("pieceHashedNotCorrect")
  59
  60         unsuccessfulDials = expvar.NewInt("dialSuccessful")
  61         successfulDials   = expvar.NewInt("dialUnsuccessful")
  62
  63         acceptUTP    = expvar.NewInt("acceptUTP")
  64         acceptTCP    = expvar.NewInt("acceptTCP")
  65         acceptReject = expvar.NewInt("acceptReject")
  66
  67         peerExtensions                    = expvar.NewMap("peerExtensions")
  68         completedHandshakeConnectionFlags = expvar.NewMap("completedHandshakeConnectionFlags")
  69         // Count of connections to peer with same client ID.
  70         connsToSelf = expvar.NewInt("connsToSelf")
  71         // Number of completed connections to a client we're already connected with.
  72         duplicateClientConns       = expvar.NewInt("duplicateClientConns")
  73         receivedMessageTypes       = expvar.NewMap("receivedMessageTypes")
  74         supportedExtensionMessages = expvar.NewMap("supportedExtensionMessages")
  75 )
  76
  77 const (
  78         // Justification for set bits follows.
  79         //
  80         // Extension protocol ([5]|=0x10):
  81         // http://www.bittorrent.org/beps/bep_0010.html
  82         //
  83         // Fast Extension ([7]|=0x04):
  84         // http://bittorrent.org/beps/bep_0006.html.
  85         // Disabled until AllowedFast is implemented.
  86         //
  87         // DHT ([7]|=1):
  88         // http://www.bittorrent.org/beps/bep_0005.html
  89         defaultExtensionBytes = "\x00\x00\x00\x00\x00\x10\x00\x01"
  90
  91         socketsPerTorrent     = 80
  92         torrentPeersHighWater = 200
  93         torrentPeersLowWater  = 50
  94
  95         // Limit how long handshake can take. This is to reduce the lingering
  96         // impact of a few bad apples. 4s loses 1% of successful handshakes that
  97         // are obtained with 60s timeout, and 5% of unsuccessful handshakes.
  98         btHandshakeTimeout = 4 * time.Second
  99         handshakesTimeout  = 20 * time.Second
 100
 101         // These are our extended message IDs.
 102         metadataExtendedId = iota + 1 // 0 is reserved for deleting keys
 103         pexExtendedId
 104
 105         // Updated occasionally to when there's been some changes to client
 106         // behaviour in case other clients are assuming anything of us. See also
 107         // `bep20`.
 108         extendedHandshakeClientVersion = "go.torrent dev 20150624"
 109 )
 110
 111 // Currently doesn't really queue, but should in the future.
 112 func (cl *Client) queuePieceCheck(t *torrent, pieceIndex int) {
 113         piece := &t.Pieces[pieceIndex]
 114         if piece.QueuedForHash {
 115                 return
 116         }
 117         piece.QueuedForHash = true
 118         t.publishPieceChange(int(pieceIndex))
 119         go cl.verifyPiece(t, int(pieceIndex))
 120 }
 121
 122 // Queue a piece check if one isn't already queued, and the piece has never
 123 // been checked before.
 124 func (cl *Client) queueFirstHash(t *torrent, piece int) {
 125         p := &t.Pieces[piece]
 126         if p.EverHashed || p.Hashing || p.QueuedForHash || t.pieceComplete(piece) {
 127                 return
 128         }
 129         cl.queuePieceCheck(t, piece)
 130 }
 131
 132 // Clients contain zero or more Torrents. A client manages a blocklist, the
 133 // TCP/UDP protocol ports, and DHT as desired.
 134 type Client struct {
 135         halfOpenLimit  int
 136         peerID         [20]byte
 137         listeners      []net.Listener
 138         utpSock        *utp.Socket
 139         dHT            *dht.Server
 140         ipBlockList    iplist.Ranger
 141         bannedTorrents map[InfoHash]struct{}
 142         config         Config
 143         pruneTimer     *time.Timer
 144         extensionBytes peerExtensionBytes
 145         // Set of addresses that have our client ID. This intentionally will
 146         // include ourselves if we end up trying to connect to our own address
 147         // through legitimate channels.
 148         dopplegangerAddrs map[string]struct{}
 149
 150         torrentDataOpener TorrentDataOpener
 151
 152         mu    sync.RWMutex
 153         event sync.Cond
 154         quit  chan struct{}
 155
 156         torrents map[InfoHash]*torrent
 157 }
 158
 159 func (me *Client) IPBlockList() iplist.Ranger {
 160         me.mu.Lock()
 161         defer me.mu.Unlock()
 162         return me.ipBlockList
 163 }
 164
 165 func (me *Client) SetIPBlockList(list iplist.Ranger) {
 166         me.mu.Lock()
 167         defer me.mu.Unlock()
 168         me.ipBlockList = list
 169         if me.dHT != nil {
 170                 me.dHT.SetIPBlockList(list)
 171         }
 172 }
 173
 174 func (me *Client) PeerID() string {
 175         return string(me.peerID[:])
 176 }
 177
 178 func (me *Client) ListenAddr() (addr net.Addr) {
 179         for _, l := range me.listeners {
 180                 addr = l.Addr()
 181                 break
 182         }
 183         return
 184 }
 185
 186 type hashSorter struct {
 187         Hashes []InfoHash
 188 }
 189
 190 func (me hashSorter) Len() int {
 191         return len(me.Hashes)
 192 }
 193
 194 func (me hashSorter) Less(a, b int) bool {
 195         return (&big.Int{}).SetBytes(me.Hashes[a][:]).Cmp((&big.Int{}).SetBytes(me.Hashes[b][:])) < 0
 196 }
 197
 198 func (me hashSorter) Swap(a, b int) {
 199         me.Hashes[a], me.Hashes[b] = me.Hashes[b], me.Hashes[a]
 200 }
 201
 202 func (cl *Client) sortedTorrents() (ret []*torrent) {
 203         var hs hashSorter
 204         for ih := range cl.torrents {
 205                 hs.Hashes = append(hs.Hashes, ih)
 206         }
 207         sort.Sort(hs)
 208         for _, ih := range hs.Hashes {
 209                 ret = append(ret, cl.torrent(ih))
 210         }
 211         return
 212 }
 213
 214 // Writes out a human readable status of the client, such as for writing to a
 215 // HTTP status page.
 216 func (cl *Client) WriteStatus(_w io.Writer) {
 217         cl.mu.RLock()
 218         defer cl.mu.RUnlock()
 219         w := bufio.NewWriter(_w)
 220         defer w.Flush()
 221         if addr := cl.ListenAddr(); addr != nil {
 222                 fmt.Fprintf(w, "Listening on %s\n", cl.ListenAddr())
 223         } else {
 224                 fmt.Fprintln(w, "Not listening!")
 225         }
 226         fmt.Fprintf(w, "Peer ID: %+q\n", cl.peerID)
 227         if cl.dHT != nil {
 228                 dhtStats := cl.dHT.Stats()
 229                 fmt.Fprintf(w, "DHT nodes: %d (%d good, %d banned)\n", dhtStats.Nodes, dhtStats.GoodNodes, dhtStats.BadNodes)
 230                 fmt.Fprintf(w, "DHT Server ID: %x\n", cl.dHT.ID())
 231                 fmt.Fprintf(w, "DHT port: %d\n", addrPort(cl.dHT.Addr()))
 232                 fmt.Fprintf(w, "DHT announces: %d\n", dhtStats.ConfirmedAnnounces)
 233                 fmt.Fprintf(w, "Outstanding transactions: %d\n", dhtStats.OutstandingTransactions)
 234         }
 235         fmt.Fprintf(w, "# Torrents: %d\n", len(cl.torrents))
 236         fmt.Fprintln(w)
 237         for _, t := range cl.sortedTorrents() {
 238                 if t.Name() == "" {
 239                         fmt.Fprint(w, "<unknown name>")
 240                 } else {
 241                         fmt.Fprint(w, t.Name())
 242                 }
 243                 fmt.Fprint(w, "\n")
 244                 if t.haveInfo() {
 245                         fmt.Fprintf(w, "%f%% of %d bytes", 100*(1-float32(t.bytesLeft())/float32(t.Length())), t.Length())
 246                 } else {
 247                         w.WriteString("<missing metainfo>")
 248                 }
 249                 fmt.Fprint(w, "\n")
 250                 t.writeStatus(w, cl)
 251                 fmt.Fprintln(w)
 252         }
 253 }
 254
 255 func dataReadAt(d Data, b []byte, off int64) (n int, err error) {
 256         // defer func() {
 257         //      if err == io.ErrUnexpectedEOF && n != 0 {
 258         //              err = nil
 259         //      }
 260         // }()
 261         // log.Println("data read at", len(b), off)
 262         return d.ReadAt(b, off)
 263 }
 264
 265 // Calculates the number of pieces to set to Readahead priority, after the
 266 // Now, and Next pieces.
 267 func readaheadPieces(readahead, pieceLength int64) (ret int) {
 268         // Expand the readahead to fit any partial pieces. Subtract 1 for the
 269         // "next" piece that is assigned.
 270         ret = int((readahead+pieceLength-1)/pieceLength - 1)
 271         // Lengthen the "readahead tail" to smooth blockiness that occurs when the
 272         // piece length is much larger than the readahead.
 273         if ret < 2 {
 274                 ret++
 275         }
 276         return
 277 }
 278
 279 func (cl *Client) readRaisePiecePriorities(t *torrent, off, readaheadBytes int64) {
 280         index := int(off / int64(t.usualPieceSize()))
 281         cl.raisePiecePriority(t, index, PiecePriorityNow)
 282         index++
 283         if index >= t.numPieces() {
 284                 return
 285         }
 286         cl.raisePiecePriority(t, index, PiecePriorityNext)
 287         for range iter.N(readaheadPieces(readaheadBytes, t.Info.PieceLength)) {
 288                 index++
 289                 if index >= t.numPieces() {
 290                         break
 291                 }
 292                 cl.raisePiecePriority(t, index, PiecePriorityReadahead)
 293         }
 294 }
 295
 296 func (cl *Client) addUrgentRequests(t *torrent, off int64, n int) {
 297         for n > 0 {
 298                 req, ok := t.offsetRequest(off)
 299                 if !ok {
 300                         break
 301                 }
 302                 if _, ok := t.urgent[req]; !ok && !t.haveChunk(req) {
 303                         if t.urgent == nil {
 304                                 t.urgent = make(map[request]struct{}, (n+int(t.chunkSize)-1)/int(t.chunkSize))
 305                         }
 306                         t.urgent[req] = struct{}{}
 307                         cl.event.Broadcast() // Why?
 308                         index := int(req.Index)
 309                         cl.queueFirstHash(t, index)
 310                         cl.pieceChanged(t, index)
 311                 }
 312                 reqOff := t.requestOffset(req)
 313                 n1 := req.Length - pp.Integer(off-reqOff)
 314                 off += int64(n1)
 315                 n -= int(n1)
 316         }
 317         // log.Print(t.urgent)
 318 }
 319
 320 func (cl *Client) configDir() string {
 321         if cl.config.ConfigDir == "" {
 322                 return filepath.Join(os.Getenv("HOME"), ".config/torrent")
 323         }
 324         return cl.config.ConfigDir
 325 }
 326
 327 // The directory where the Client expects to find and store configuration
 328 // data. Defaults to $HOME/.config/torrent.
 329 func (cl *Client) ConfigDir() string {
 330         return cl.configDir()
 331 }
 332
 333 func (t *torrent) connPendPiece(c *connection, piece int) {
 334         c.pendPiece(piece, t.Pieces[piece].Priority, t)
 335 }
 336
 337 func (cl *Client) raisePiecePriority(t *torrent, piece int, priority piecePriority) {
 338         if t.Pieces[piece].Priority < priority {
 339                 cl.prioritizePiece(t, piece, priority)
 340         }
 341 }
 342
 343 func (cl *Client) prioritizePiece(t *torrent, piece int, priority piecePriority) {
 344         if t.havePiece(piece) {
 345                 priority = PiecePriorityNone
 346         }
 347         if priority != PiecePriorityNone {
 348                 cl.queueFirstHash(t, piece)
 349         }
 350         p := &t.Pieces[piece]
 351         if p.Priority != priority {
 352                 p.Priority = priority
 353                 cl.pieceChanged(t, piece)
 354         }
 355 }
 356
 357 func loadPackedBlocklist(filename string) (ret iplist.Ranger, err error) {
 358         f, err := os.Open(filename)
 359         if os.IsNotExist(err) {
 360                 err = nil
 361                 return
 362         }
 363         if err != nil {
 364                 return
 365         }
 366         defer f.Close()
 367         mm, err := mmap.Map(f, mmap.RDONLY, 0)
 368         if err != nil {
 369                 return
 370         }
 371         ret = iplist.NewFromPacked(mm)
 372         return
 373 }
 374
 375 func (cl *Client) setEnvBlocklist() (err error) {
 376         filename := os.Getenv("TORRENT_BLOCKLIST_FILE")
 377         defaultBlocklist := filename == ""
 378         if defaultBlocklist {
 379                 cl.ipBlockList, err = loadPackedBlocklist(filepath.Join(cl.configDir(), "packed-blocklist"))
 380                 if err != nil {
 381                         return
 382                 }
 383                 if cl.ipBlockList != nil {
 384                         return
 385                 }
 386                 filename = filepath.Join(cl.configDir(), "blocklist")
 387         }
 388         f, err := os.Open(filename)
 389         if err != nil {
 390                 if defaultBlocklist {
 391                         err = nil
 392                 }
 393                 return
 394         }
 395         defer f.Close()
 396         cl.ipBlockList, err = iplist.NewFromReader(f)
 397         return
 398 }
 399
 400 func (cl *Client) initBannedTorrents() error {
 401         f, err := os.Open(filepath.Join(cl.configDir(), "banned_infohashes"))
 402         if err != nil {
 403                 if os.IsNotExist(err) {
 404                         return nil
 405                 }
 406                 return fmt.Errorf("error opening banned infohashes file: %s", err)
 407         }
 408         defer f.Close()
 409         scanner := bufio.NewScanner(f)
 410         cl.bannedTorrents = make(map[InfoHash]struct{})
 411         for scanner.Scan() {
 412                 if strings.HasPrefix(strings.TrimSpace(scanner.Text()), "#") {
 413                         continue
 414                 }
 415                 var ihs string
 416                 n, err := fmt.Sscanf(scanner.Text(), "%x", &ihs)
 417                 if err != nil {
 418                         return fmt.Errorf("error reading infohash: %s", err)
 419                 }
 420                 if n != 1 {
 421                         continue
 422                 }
 423                 if len(ihs) != 20 {
 424                         return errors.New("bad infohash")
 425                 }
 426                 var ih InfoHash
 427                 CopyExact(&ih, ihs)
 428                 cl.bannedTorrents[ih] = struct{}{}
 429         }
 430         if err := scanner.Err(); err != nil {
 431                 return fmt.Errorf("error scanning file: %s", err)
 432         }
 433         return nil
 434 }
 435
 436 // Creates a new client.
 437 func NewClient(cfg *Config) (cl *Client, err error) {
 438         if cfg == nil {
 439                 cfg = &Config{}
 440         }
 441
 442         defer func() {
 443                 if err != nil {
 444                         cl = nil
 445                 }
 446         }()
 447         cl = &Client{
 448                 halfOpenLimit: socketsPerTorrent,
 449                 config:        *cfg,
 450                 torrentDataOpener: func(md *metainfo.Info) Data {
 451                         return filePkg.TorrentData(md, cfg.DataDir)
 452                 },
 453                 dopplegangerAddrs: make(map[string]struct{}),
 454
 455                 quit:     make(chan struct{}),
 456                 torrents: make(map[InfoHash]*torrent),
 457         }
 458         CopyExact(&cl.extensionBytes, defaultExtensionBytes)
 459         cl.event.L = &cl.mu
 460         if cfg.TorrentDataOpener != nil {
 461                 cl.torrentDataOpener = cfg.TorrentDataOpener
 462         }
 463
 464         if cfg.IPBlocklist != nil {
 465                 cl.ipBlockList = cfg.IPBlocklist
 466         } else if !cfg.NoDefaultBlocklist {
 467                 err = cl.setEnvBlocklist()
 468                 if err != nil {
 469                         return
 470                 }
 471         }
 472
 473         if err = cl.initBannedTorrents(); err != nil {
 474                 err = fmt.Errorf("error initing banned torrents: %s", err)
 475                 return
 476         }
 477
 478         if cfg.PeerID != "" {
 479                 CopyExact(&cl.peerID, cfg.PeerID)
 480         } else {
 481                 o := copy(cl.peerID[:], bep20)
 482                 _, err = rand.Read(cl.peerID[o:])
 483                 if err != nil {
 484                         panic("error generating peer id")
 485                 }
 486         }
 487
 488         // Returns the laddr string to listen on for the next Listen call.
 489         listenAddr := func() string {
 490                 if addr := cl.ListenAddr(); addr != nil {
 491                         return addr.String()
 492                 }
 493                 if cfg.ListenAddr == "" {
 494                         return ":50007"
 495                 }
 496                 return cfg.ListenAddr
 497         }
 498         if !cl.config.DisableTCP {
 499                 var l net.Listener
 500                 l, err = net.Listen(func() string {
 501                         if cl.config.DisableIPv6 {
 502                                 return "tcp4"
 503                         } else {
 504                                 return "tcp"
 505                         }
 506                 }(), listenAddr())
 507                 if err != nil {
 508                         return
 509                 }
 510                 cl.listeners = append(cl.listeners, l)
 511                 go cl.acceptConnections(l, false)
 512         }
 513         if !cl.config.DisableUTP {
 514                 cl.utpSock, err = utp.NewSocket(func() string {
 515                         if cl.config.DisableIPv6 {
 516                                 return "udp4"
 517                         } else {
 518                                 return "udp"
 519                         }
 520                 }(), listenAddr())
 521                 if err != nil {
 522                         return
 523                 }
 524                 cl.listeners = append(cl.listeners, cl.utpSock)
 525                 go cl.acceptConnections(cl.utpSock, true)
 526         }
 527         if !cfg.NoDHT {
 528                 dhtCfg := cfg.DHTConfig
 529                 if dhtCfg == nil {
 530                         dhtCfg = &dht.ServerConfig{}
 531                 }
 532                 if dhtCfg.IPBlocklist == nil {
 533                         dhtCfg.IPBlocklist = cl.ipBlockList
 534                 }
 535                 if dhtCfg.Addr == "" {
 536                         dhtCfg.Addr = listenAddr()
 537                 }
 538                 if dhtCfg.Conn == nil && cl.utpSock != nil {
 539                         dhtCfg.Conn = cl.utpSock
 540                 }
 541                 cl.dHT, err = dht.NewServer(dhtCfg)
 542                 if err != nil {
 543                         return
 544                 }
 545         }
 546
 547         return
 548 }
 549
 550 func (cl *Client) stopped() bool {
 551         select {
 552         case <-cl.quit:
 553                 return true
 554         default:
 555                 return false
 556         }
 557 }
 558
 559 // Stops the client. All connections to peers are closed and all activity will
 560 // come to a halt.
 561 func (me *Client) Close() {
 562         me.mu.Lock()
 563         defer me.mu.Unlock()
 564         select {
 565         case <-me.quit:
 566                 return
 567         default:
 568         }
 569         close(me.quit)
 570         if me.dHT != nil {
 571                 me.dHT.Close()
 572         }
 573         for _, l := range me.listeners {
 574                 l.Close()
 575         }
 576         for _, t := range me.torrents {
 577                 t.close()
 578         }
 579         me.event.Broadcast()
 580 }
 581
 582 var ipv6BlockRange = iplist.Range{Description: "non-IPv4 address"}
 583
 584 func (cl *Client) ipBlockRange(ip net.IP) (r iplist.Range, blocked bool) {
 585         if cl.ipBlockList == nil {
 586                 return
 587         }
 588         ip4 := ip.To4()
 589         // If blocklists are enabled, then block non-IPv4 addresses, because
 590         // blocklists do not yet support IPv6.
 591         if ip4 == nil {
 592                 if missinggo.CryHeard() {
 593                         log.Printf("blocking non-IPv4 address: %s", ip)
 594                 }
 595                 r = ipv6BlockRange
 596                 blocked = true
 597                 return
 598         }
 599         return cl.ipBlockList.Lookup(ip4)
 600 }
 601
 602 func (cl *Client) waitAccept() {
 603         cl.mu.Lock()
 604         defer cl.mu.Unlock()
 605         for {
 606                 for _, t := range cl.torrents {
 607                         if cl.wantConns(t) {
 608                                 return
 609                         }
 610                 }
 611                 select {
 612                 case <-cl.quit:
 613                         return
 614                 default:
 615                 }
 616                 cl.event.Wait()
 617         }
 618 }
 619
 620 func (cl *Client) acceptConnections(l net.Listener, utp bool) {
 621         for {
 622                 cl.waitAccept()
 623                 // We accept all connections immediately, because we don't know what
 624                 // torrent they're for.
 625                 conn, err := l.Accept()
 626                 select {
 627                 case <-cl.quit:
 628                         if conn != nil {
 629                                 conn.Close()
 630                         }
 631                         return
 632                 default:
 633                 }
 634                 if err != nil {
 635                         log.Print(err)
 636                         return
 637                 }
 638                 if utp {
 639                         acceptUTP.Add(1)
 640                 } else {
 641                         acceptTCP.Add(1)
 642                 }
 643                 cl.mu.RLock()
 644                 doppleganger := cl.dopplegangerAddr(conn.RemoteAddr().String())
 645                 _, blocked := cl.ipBlockRange(AddrIP(conn.RemoteAddr()))
 646                 cl.mu.RUnlock()
 647                 if blocked || doppleganger {
 648                         acceptReject.Add(1)
 649                         // log.Printf("inbound connection from %s blocked by %s", conn.RemoteAddr(), blockRange)
 650                         conn.Close()
 651                         continue
 652                 }
 653                 go cl.incomingConnection(conn, utp)
 654         }
 655 }
 656
 657 func (cl *Client) incomingConnection(nc net.Conn, utp bool) {
 658         defer nc.Close()
 659         if tc, ok := nc.(*net.TCPConn); ok {
 660                 tc.SetLinger(0)
 661         }
 662         c := newConnection()
 663         c.conn = nc
 664         c.rw = nc
 665         c.Discovery = peerSourceIncoming
 666         c.uTP = utp
 667         err := cl.runReceivedConn(c)
 668         if err != nil {
 669                 // log.Print(err)
 670         }
 671 }
 672
 673 // Returns a handle to the given torrent, if it's present in the client.
 674 func (cl *Client) Torrent(ih InfoHash) (T Torrent, ok bool) {
 675         cl.mu.Lock()
 676         defer cl.mu.Unlock()
 677         t, ok := cl.torrents[ih]
 678         if !ok {
 679                 return
 680         }
 681         T = Torrent{cl, t}
 682         return
 683 }
 684
 685 func (me *Client) torrent(ih InfoHash) *torrent {
 686         return me.torrents[ih]
 687 }
 688
 689 type dialResult struct {
 690         Conn net.Conn
 691         UTP  bool
 692 }
 693
 694 func doDial(dial func(addr string, t *torrent) (net.Conn, error), ch chan dialResult, utp bool, addr string, t *torrent) {
 695         conn, err := dial(addr, t)
 696         if err != nil {
 697                 if conn != nil {
 698                         conn.Close()
 699                 }
 700                 conn = nil // Pedantic
 701         }
 702         ch <- dialResult{conn, utp}
 703         if err == nil {
 704                 successfulDials.Add(1)
 705                 return
 706         }
 707         unsuccessfulDials.Add(1)
 708 }
 709
 710 func reducedDialTimeout(max time.Duration, halfOpenLimit int, pendingPeers int) (ret time.Duration) {
 711         ret = max / time.Duration((pendingPeers+halfOpenLimit)/halfOpenLimit)
 712         if ret < minDialTimeout {
 713                 ret = minDialTimeout
 714         }
 715         return
 716 }
 717
 718 // Returns whether an address is known to connect to a client with our own ID.
 719 func (me *Client) dopplegangerAddr(addr string) bool {
 720         _, ok := me.dopplegangerAddrs[addr]
 721         return ok
 722 }
 723
 724 // Start the process of connecting to the given peer for the given torrent if
 725 // appropriate.
 726 func (me *Client) initiateConn(peer Peer, t *torrent) {
 727         if peer.Id == me.peerID {
 728                 return
 729         }
 730         addr := net.JoinHostPort(peer.IP.String(), fmt.Sprintf("%d", peer.Port))
 731         if me.dopplegangerAddr(addr) || t.addrActive(addr) {
 732                 duplicateConnsAvoided.Add(1)
 733                 return
 734         }
 735         if r, ok := me.ipBlockRange(peer.IP); ok {
 736                 log.Printf("outbound connect to %s blocked by IP blocklist rule %s", peer.IP, r)
 737                 return
 738         }
 739         t.HalfOpen[addr] = struct{}{}
 740         go me.outgoingConnection(t, addr, peer.Source)
 741 }
 742
 743 func (me *Client) dialTimeout(t *torrent) time.Duration {
 744         me.mu.Lock()
 745         pendingPeers := len(t.Peers)
 746         me.mu.Unlock()
 747         return reducedDialTimeout(nominalDialTimeout, me.halfOpenLimit, pendingPeers)
 748 }
 749
 750 func (me *Client) dialTCP(addr string, t *torrent) (c net.Conn, err error) {
 751         c, err = net.DialTimeout("tcp", addr, me.dialTimeout(t))
 752         if err == nil {
 753                 c.(*net.TCPConn).SetLinger(0)
 754         }
 755         return
 756 }
 757
 758 func (me *Client) dialUTP(addr string, t *torrent) (c net.Conn, err error) {
 759         return me.utpSock.DialTimeout(addr, me.dialTimeout(t))
 760 }
 761
 762 // Returns a connection over UTP or TCP, whichever is first to connect.
 763 func (me *Client) dialFirst(addr string, t *torrent) (conn net.Conn, utp bool) {
 764         // Initiate connections via TCP and UTP simultaneously. Use the first one
 765         // that succeeds.
 766         left := 0
 767         if !me.config.DisableUTP {
 768                 left++
 769         }
 770         if !me.config.DisableTCP {
 771                 left++
 772         }
 773         resCh := make(chan dialResult, left)
 774         if !me.config.DisableUTP {
 775                 go doDial(me.dialUTP, resCh, true, addr, t)
 776         }
 777         if !me.config.DisableTCP {
 778                 go doDial(me.dialTCP, resCh, false, addr, t)
 779         }
 780         var res dialResult
 781         // Wait for a successful connection.
 782         for ; left > 0 && res.Conn == nil; left-- {
 783                 res = <-resCh
 784         }
 785         if left > 0 {
 786                 // There are still incompleted dials.
 787                 go func() {
 788                         for ; left > 0; left-- {
 789                                 conn := (<-resCh).Conn
 790                                 if conn != nil {
 791                                         conn.Close()
 792                                 }
 793                         }
 794                 }()
 795         }
 796         conn = res.Conn
 797         utp = res.UTP
 798         return
 799 }
 800
 801 func (me *Client) noLongerHalfOpen(t *torrent, addr string) {
 802         if _, ok := t.HalfOpen[addr]; !ok {
 803                 panic("invariant broken")
 804         }
 805         delete(t.HalfOpen, addr)
 806         me.openNewConns(t)
 807 }
 808
 809 // Performs initiator handshakes and returns a connection.
 810 func (me *Client) handshakesConnection(nc net.Conn, t *torrent, encrypted, utp bool) (c *connection, err error) {
 811         c = newConnection()
 812         c.conn = nc
 813         c.rw = nc
 814         c.encrypted = encrypted
 815         c.uTP = utp
 816         err = nc.SetDeadline(time.Now().Add(handshakesTimeout))
 817         if err != nil {
 818                 return
 819         }
 820         ok, err := me.initiateHandshakes(c, t)
 821         if !ok {
 822                 c = nil
 823         }
 824         return
 825 }
 826
 827 // Returns nil connection and nil error if no connection could be established
 828 // for valid reasons.
 829 func (me *Client) establishOutgoingConn(t *torrent, addr string) (c *connection, err error) {
 830         nc, utp := me.dialFirst(addr, t)
 831         if nc == nil {
 832                 return
 833         }
 834         c, err = me.handshakesConnection(nc, t, !me.config.DisableEncryption, utp)
 835         if err != nil {
 836                 nc.Close()
 837                 return
 838         } else if c != nil {
 839                 return
 840         }
 841         nc.Close()
 842         if me.config.DisableEncryption {
 843                 // We already tried without encryption.
 844                 return
 845         }
 846         // Try again without encryption, using whichever protocol type worked last
 847         // time.
 848         if utp {
 849                 nc, err = me.dialUTP(addr, t)
 850         } else {
 851                 nc, err = me.dialTCP(addr, t)
 852         }
 853         if err != nil {
 854                 err = fmt.Errorf("error dialing for unencrypted connection: %s", err)
 855                 return
 856         }
 857         c, err = me.handshakesConnection(nc, t, false, utp)
 858         if err != nil {
 859                 nc.Close()
 860         }
 861         return
 862 }
 863
 864 // Called to dial out and run a connection. The addr we're given is already
 865 // considered half-open.
 866 func (me *Client) outgoingConnection(t *torrent, addr string, ps peerSource) {
 867         c, err := me.establishOutgoingConn(t, addr)
 868         me.mu.Lock()
 869         defer me.mu.Unlock()
 870         // Don't release lock between here and addConnection, unless it's for
 871         // failure.
 872         me.noLongerHalfOpen(t, addr)
 873         if err != nil {
 874                 return
 875         }
 876         if c == nil {
 877                 return
 878         }
 879         defer c.Close()
 880         c.Discovery = ps
 881         err = me.runInitiatedHandshookConn(c, t)
 882         if err != nil {
 883                 // log.Print(err)
 884         }
 885 }
 886
 887 // The port number for incoming peer connections. 0 if the client isn't
 888 // listening.
 889 func (cl *Client) incomingPeerPort() int {
 890         listenAddr := cl.ListenAddr()
 891         if listenAddr == nil {
 892                 return 0
 893         }
 894         return addrPort(listenAddr)
 895 }
 896
 897 // Convert a net.Addr to its compact IP representation. Either 4 or 16 bytes
 898 // per "yourip" field of http://www.bittorrent.org/beps/bep_0010.html.
 899 func addrCompactIP(addr net.Addr) (string, error) {
 900         host, _, err := net.SplitHostPort(addr.String())
 901         if err != nil {
 902                 return "", err
 903         }
 904         ip := net.ParseIP(host)
 905         if v4 := ip.To4(); v4 != nil {
 906                 if len(v4) != 4 {
 907                         panic(v4)
 908                 }
 909                 return string(v4), nil
 910         }
 911         return string(ip.To16()), nil
 912 }
 913
 914 func handshakeWriter(w io.Writer, bb <-chan []byte, done chan<- error) {
 915         var err error
 916         for b := range bb {
 917                 _, err = w.Write(b)
 918                 if err != nil {
 919                         break
 920                 }
 921         }
 922         done <- err
 923 }
 924
 925 type (
 926         peerExtensionBytes [8]byte
 927         peerID             [20]byte
 928 )
 929
 930 func (me *peerExtensionBytes) SupportsExtended() bool {
 931         return me[5]&0x10 != 0
 932 }
 933
 934 func (me *peerExtensionBytes) SupportsDHT() bool {
 935         return me[7]&0x01 != 0
 936 }
 937
 938 func (me *peerExtensionBytes) SupportsFast() bool {
 939         return me[7]&0x04 != 0
 940 }
 941
 942 type handshakeResult struct {
 943         peerExtensionBytes
 944         peerID
 945         InfoHash
 946 }
 947
 948 // ih is nil if we expect the peer to declare the InfoHash, such as when the
 949 // peer initiated the connection. Returns ok if the handshake was successful,
 950 // and err if there was an unexpected condition other than the peer simply
 951 // abandoning the handshake.
 952 func handshake(sock io.ReadWriter, ih *InfoHash, peerID [20]byte, extensions peerExtensionBytes) (res handshakeResult, ok bool, err error) {
 953         // Bytes to be sent to the peer. Should never block the sender.
 954         postCh := make(chan []byte, 4)
 955         // A single error value sent when the writer completes.
 956         writeDone := make(chan error, 1)
 957         // Performs writes to the socket and ensures posts don't block.
 958         go handshakeWriter(sock, postCh, writeDone)
 959
 960         defer func() {
 961                 close(postCh) // Done writing.
 962                 if !ok {
 963                         return
 964                 }
 965                 if err != nil {
 966                         panic(err)
 967                 }
 968                 // Wait until writes complete before returning from handshake.
 969                 err = <-writeDone
 970                 if err != nil {
 971                         err = fmt.Errorf("error writing: %s", err)
 972                 }
 973         }()
 974
 975         post := func(bb []byte) {
 976                 select {
 977                 case postCh <- bb:
 978                 default:
 979                         panic("mustn't block while posting")
 980                 }
 981         }
 982
 983         post([]byte(pp.Protocol))
 984         post(extensions[:])
 985         if ih != nil { // We already know what we want.
 986                 post(ih[:])
 987                 post(peerID[:])
 988         }
 989         var b [68]byte
 990         _, err = io.ReadFull(sock, b[:68])
 991         if err != nil {
 992                 err = nil
 993                 return
 994         }
 995         if string(b[:20]) != pp.Protocol {
 996                 return
 997         }
 998         CopyExact(&res.peerExtensionBytes, b[20:28])
 999         CopyExact(&res.InfoHash, b[28:48])
1000         CopyExact(&res.peerID, b[48:68])
1001         peerExtensions.Add(hex.EncodeToString(res.peerExtensionBytes[:]), 1)
1002
1003         // TODO: Maybe we can just drop peers here if we're not interested. This
1004         // could prevent them trying to reconnect, falsely believing there was
1005         // just a problem.
1006         if ih == nil { // We were waiting for the peer to tell us what they wanted.
1007                 post(res.InfoHash[:])
1008                 post(peerID[:])
1009         }
1010
1011         ok = true
1012         return
1013 }
1014
1015 // Wraps a raw connection and provides the interface we want for using the
1016 // connection in the message loop.
1017 type deadlineReader struct {
1018         nc net.Conn
1019         r  io.Reader
1020 }
1021
1022 func (me deadlineReader) Read(b []byte) (n int, err error) {
1023         // Keep-alives should be received every 2 mins. Give a bit of gracetime.
1024         err = me.nc.SetReadDeadline(time.Now().Add(150 * time.Second))
1025         if err != nil {
1026                 err = fmt.Errorf("error setting read deadline: %s", err)
1027         }
1028         n, err = me.r.Read(b)
1029         // Convert common errors into io.EOF.
1030         // if err != nil {
1031         //      if opError, ok := err.(*net.OpError); ok && opError.Op == "read" && opError.Err == syscall.ECONNRESET {
1032         //              err = io.EOF
1033         //      } else if netErr, ok := err.(net.Error); ok && netErr.Timeout() {
1034         //              if n != 0 {
1035         //                      panic(n)
1036         //              }
1037         //              err = io.EOF
1038         //      }
1039         // }
1040         return
1041 }
1042
1043 type readWriter struct {
1044         io.Reader
1045         io.Writer
1046 }
1047
1048 func maybeReceiveEncryptedHandshake(rw io.ReadWriter, skeys [][]byte) (ret io.ReadWriter, encrypted bool, err error) {
1049         var protocol [len(pp.Protocol)]byte
1050         _, err = io.ReadFull(rw, protocol[:])
1051         if err != nil {
1052                 return
1053         }
1054         ret = readWriter{
1055                 io.MultiReader(bytes.NewReader(protocol[:]), rw),
1056                 rw,
1057         }
1058         if string(protocol[:]) == pp.Protocol {
1059                 return
1060         }
1061         encrypted = true
1062         ret, err = mse.ReceiveHandshake(ret, skeys)
1063         return
1064 }
1065
1066 func (cl *Client) receiveSkeys() (ret [][]byte) {
1067         for ih := range cl.torrents {
1068                 ret = append(ret, ih[:])
1069         }
1070         return
1071 }
1072
1073 func (me *Client) initiateHandshakes(c *connection, t *torrent) (ok bool, err error) {
1074         if c.encrypted {
1075                 c.rw, err = mse.InitiateHandshake(c.rw, t.InfoHash[:], nil)
1076                 if err != nil {
1077                         return
1078                 }
1079         }
1080         ih, ok, err := me.connBTHandshake(c, &t.InfoHash)
1081         if ih != t.InfoHash {
1082                 ok = false
1083         }
1084         return
1085 }
1086
1087 // Do encryption and bittorrent handshakes as receiver.
1088 func (cl *Client) receiveHandshakes(c *connection) (t *torrent, err error) {
1089         cl.mu.Lock()
1090         skeys := cl.receiveSkeys()
1091         cl.mu.Unlock()
1092         if !cl.config.DisableEncryption {
1093                 c.rw, c.encrypted, err = maybeReceiveEncryptedHandshake(c.rw, skeys)
1094                 if err != nil {
1095                         if err == mse.ErrNoSecretKeyMatch {
1096                                 err = nil
1097                         }
1098                         return
1099                 }
1100         }
1101         ih, ok, err := cl.connBTHandshake(c, nil)
1102         if err != nil {
1103                 err = fmt.Errorf("error during bt handshake: %s", err)
1104                 return
1105         }
1106         if !ok {
1107                 return
1108         }
1109         cl.mu.Lock()
1110         t = cl.torrents[ih]
1111         cl.mu.Unlock()
1112         return
1113 }
1114
1115 // Returns !ok if handshake failed for valid reasons.
1116 func (cl *Client) connBTHandshake(c *connection, ih *InfoHash) (ret InfoHash, ok bool, err error) {
1117         res, ok, err := handshake(c.rw, ih, cl.peerID, cl.extensionBytes)
1118         if err != nil || !ok {
1119                 return
1120         }
1121         ret = res.InfoHash
1122         c.PeerExtensionBytes = res.peerExtensionBytes
1123         c.PeerID = res.peerID
1124         c.completedHandshake = time.Now()
1125         return
1126 }
1127
1128 func (cl *Client) runInitiatedHandshookConn(c *connection, t *torrent) (err error) {
1129         if c.PeerID == cl.peerID {
1130                 // Only if we initiated the connection is the remote address a
1131                 // listen addr for a doppleganger.
1132                 connsToSelf.Add(1)
1133                 addr := c.conn.RemoteAddr().String()
1134                 cl.dopplegangerAddrs[addr] = struct{}{}
1135                 return
1136         }
1137         return cl.runHandshookConn(c, t)
1138 }
1139
1140 func (cl *Client) runReceivedConn(c *connection) (err error) {
1141         err = c.conn.SetDeadline(time.Now().Add(handshakesTimeout))
1142         if err != nil {
1143                 return
1144         }
1145         t, err := cl.receiveHandshakes(c)
1146         if err != nil {
1147                 err = fmt.Errorf("error receiving handshakes: %s", err)
1148                 return
1149         }
1150         if t == nil {
1151                 return
1152         }
1153         cl.mu.Lock()
1154         defer cl.mu.Unlock()
1155         if c.PeerID == cl.peerID {
1156                 return
1157         }
1158         return cl.runHandshookConn(c, t)
1159 }
1160
1161 func (cl *Client) runHandshookConn(c *connection, t *torrent) (err error) {
1162         c.conn.SetWriteDeadline(time.Time{})
1163         c.rw = readWriter{
1164                 deadlineReader{c.conn, c.rw},
1165                 c.rw,
1166         }
1167         completedHandshakeConnectionFlags.Add(c.connectionFlags(), 1)
1168         if !cl.addConnection(t, c) {
1169                 return
1170         }
1171         defer cl.dropConnection(t, c)
1172         go c.writer()
1173         go c.writeOptimizer(time.Minute)
1174         cl.sendInitialMessages(c, t)
1175         if t.haveInfo() {
1176                 t.initRequestOrdering(c)
1177         }
1178         err = cl.connectionLoop(t, c)
1179         if err != nil {
1180                 err = fmt.Errorf("error during connection loop: %s", err)
1181         }
1182         return
1183 }
1184
1185 func (me *Client) sendInitialMessages(conn *connection, torrent *torrent) {
1186         if conn.PeerExtensionBytes.SupportsExtended() && me.extensionBytes.SupportsExtended() {
1187                 conn.Post(pp.Message{
1188                         Type:       pp.Extended,
1189                         ExtendedID: pp.HandshakeExtendedID,
1190                         ExtendedPayload: func() []byte {
1191                                 d := map[string]interface{}{
1192                                         "m": func() (ret map[string]int) {
1193                                                 ret = make(map[string]int, 2)
1194                                                 ret["ut_metadata"] = metadataExtendedId
1195                                                 if !me.config.DisablePEX {
1196                                                         ret["ut_pex"] = pexExtendedId
1197                                                 }
1198                                                 return
1199                                         }(),
1200                                         "v": extendedHandshakeClientVersion,
1201                                         // No upload queue is implemented yet.
1202                                         "reqq": 64,
1203                                 }
1204                                 if !me.config.DisableEncryption {
1205                                         d["e"] = 1
1206                                 }
1207                                 if torrent.metadataSizeKnown() {
1208                                         d["metadata_size"] = torrent.metadataSize()
1209                                 }
1210                                 if p := me.incomingPeerPort(); p != 0 {
1211                                         d["p"] = p
1212                                 }
1213                                 yourip, err := addrCompactIP(conn.remoteAddr())
1214                                 if err != nil {
1215                                         log.Printf("error calculating yourip field value in extension handshake: %s", err)
1216                                 } else {
1217                                         d["yourip"] = yourip
1218                                 }
1219                                 // log.Printf("sending %v", d)
1220                                 b, err := bencode.Marshal(d)
1221                                 if err != nil {
1222                                         panic(err)
1223                                 }
1224                                 return b
1225                         }(),
1226                 })
1227         }
1228         if torrent.haveAnyPieces() {
1229                 conn.Bitfield(torrent.bitfield())
1230         } else if me.extensionBytes.SupportsFast() && conn.PeerExtensionBytes.SupportsFast() {
1231                 conn.Post(pp.Message{
1232                         Type: pp.HaveNone,
1233                 })
1234         }
1235         if conn.PeerExtensionBytes.SupportsDHT() && me.extensionBytes.SupportsDHT() && me.dHT != nil {
1236                 conn.Post(pp.Message{
1237                         Type: pp.Port,
1238                         Port: uint16(AddrPort(me.dHT.Addr())),
1239                 })
1240         }
1241 }
1242
1243 // Randomizes the piece order for this connection. Every connection will be
1244 // given a different ordering. Having it stored per connection saves having to
1245 // randomize during request filling, and constantly recalculate the ordering
1246 // based on piece priorities.
1247 func (t *torrent) initRequestOrdering(c *connection) {
1248         if c.pieceRequestOrder != nil || c.piecePriorities != nil {
1249                 panic("double init of request ordering")
1250         }
1251         c.pieceRequestOrder = pieceordering.New()
1252         for i := range iter.N(t.Info.NumPieces()) {
1253                 if !c.PeerHasPiece(i) {
1254                         continue
1255                 }
1256                 if !t.wantPiece(i) {
1257                         continue
1258                 }
1259                 t.connPendPiece(c, i)
1260         }
1261 }
1262
1263 func (me *Client) peerGotPiece(t *torrent, c *connection, piece int) error {
1264         if !c.peerHasAll {
1265                 if t.haveInfo() {
1266                         if c.PeerPieces == nil {
1267                                 c.PeerPieces = make([]bool, t.numPieces())
1268                         }
1269                 } else {
1270                         for piece >= len(c.PeerPieces) {
1271                                 c.PeerPieces = append(c.PeerPieces, false)
1272                         }
1273                 }
1274                 if piece >= len(c.PeerPieces) {
1275                         return errors.New("peer got out of range piece index")
1276                 }
1277                 c.PeerPieces[piece] = true
1278         }
1279         if t.wantPiece(piece) {
1280                 t.connPendPiece(c, piece)
1281                 me.replenishConnRequests(t, c)
1282         }
1283         return nil
1284 }
1285
1286 func (me *Client) peerUnchoked(torrent *torrent, conn *connection) {
1287         me.replenishConnRequests(torrent, conn)
1288 }
1289
1290 func (cl *Client) connCancel(t *torrent, cn *connection, r request) (ok bool) {
1291         ok = cn.Cancel(r)
1292         if ok {
1293                 postedCancels.Add(1)
1294         }
1295         return
1296 }
1297
1298 func (cl *Client) connDeleteRequest(t *torrent, cn *connection, r request) bool {
1299         if !cn.RequestPending(r) {
1300                 return false
1301         }
1302         delete(cn.Requests, r)
1303         return true
1304 }
1305
1306 func (cl *Client) requestPendingMetadata(t *torrent, c *connection) {
1307         if t.haveInfo() {
1308                 return
1309         }
1310         if c.PeerExtensionIDs["ut_metadata"] == 0 {
1311                 // Peer doesn't support this.
1312                 return
1313         }
1314         // Request metadata pieces that we don't have in a random order.
1315         var pending []int
1316         for index := 0; index < t.metadataPieceCount(); index++ {
1317                 if !t.haveMetadataPiece(index) && !c.requestedMetadataPiece(index) {
1318                         pending = append(pending, index)
1319                 }
1320         }
1321         for _, i := range mathRand.Perm(len(pending)) {
1322                 c.requestMetadataPiece(pending[i])
1323         }
1324 }
1325
1326 func (cl *Client) completedMetadata(t *torrent) {
1327         h := sha1.New()
1328         h.Write(t.MetaData)
1329         var ih InfoHash
1330         CopyExact(&ih, h.Sum(nil))
1331         if ih != t.InfoHash {
1332                 log.Print("bad metadata")
1333                 t.invalidateMetadata()
1334                 return
1335         }
1336         var info metainfo.Info
1337         err := bencode.Unmarshal(t.MetaData, &info)
1338         if err != nil {
1339                 log.Printf("error unmarshalling metadata: %s", err)
1340                 t.invalidateMetadata()
1341                 return
1342         }
1343         // TODO(anacrolix): If this fails, I think something harsher should be
1344         // done.
1345         err = cl.setMetaData(t, &info, t.MetaData)
1346         if err != nil {
1347                 log.Printf("error setting metadata: %s", err)
1348                 t.invalidateMetadata()
1349                 return
1350         }
1351         if cl.config.Debug {
1352                 log.Printf("%s: got metadata from peers", t)
1353         }
1354 }
1355
1356 // Process incoming ut_metadata message.
1357 func (cl *Client) gotMetadataExtensionMsg(payload []byte, t *torrent, c *connection) (err error) {
1358         var d map[string]int
1359         err = bencode.Unmarshal(payload, &d)
1360         if err != nil {
1361                 err = fmt.Errorf("error unmarshalling payload: %s: %q", err, payload)
1362                 return
1363         }
1364         msgType, ok := d["msg_type"]
1365         if !ok {
1366                 err = errors.New("missing msg_type field")
1367                 return
1368         }
1369         piece := d["piece"]
1370         switch msgType {
1371         case pp.DataMetadataExtensionMsgType:
1372                 if t.haveInfo() {
1373                         break
1374                 }
1375                 begin := len(payload) - metadataPieceSize(d["total_size"], piece)
1376                 if begin < 0 || begin >= len(payload) {
1377                         log.Printf("got bad metadata piece")
1378                         break
1379                 }
1380                 if !c.requestedMetadataPiece(piece) {
1381                         log.Printf("got unexpected metadata piece %d", piece)
1382                         break
1383                 }
1384                 c.metadataRequests[piece] = false
1385                 t.saveMetadataPiece(piece, payload[begin:])
1386                 c.UsefulChunksReceived++
1387                 c.lastUsefulChunkReceived = time.Now()
1388                 if !t.haveAllMetadataPieces() {
1389                         break
1390                 }
1391                 cl.completedMetadata(t)
1392         case pp.RequestMetadataExtensionMsgType:
1393                 if !t.haveMetadataPiece(piece) {
1394                         c.Post(t.newMetadataExtensionMessage(c, pp.RejectMetadataExtensionMsgType, d["piece"], nil))
1395                         break
1396                 }
1397                 start := (1 << 14) * piece
1398                 c.Post(t.newMetadataExtensionMessage(c, pp.DataMetadataExtensionMsgType, piece, t.MetaData[start:start+t.metadataPieceSize(piece)]))
1399         case pp.RejectMetadataExtensionMsgType:
1400         default:
1401                 err = errors.New("unknown msg_type value")
1402         }
1403         return
1404 }
1405
1406 // Extracts the port as an integer from an address string.
1407 func addrPort(addr net.Addr) int {
1408         return AddrPort(addr)
1409 }
1410
1411 func (cl *Client) peerHasAll(t *torrent, cn *connection) {
1412         cn.peerHasAll = true
1413         cn.PeerPieces = nil
1414         if t.haveInfo() {
1415                 for i := 0; i < t.numPieces(); i++ {
1416                         cl.peerGotPiece(t, cn, i)
1417                 }
1418         }
1419 }
1420
1421 func (me *Client) upload(t *torrent, c *connection) {
1422         if me.config.NoUpload {
1423                 return
1424         }
1425         if !c.PeerInterested {
1426                 return
1427         }
1428         seeding := me.seeding(t)
1429         if !seeding && !t.connHasWantedPieces(c) {
1430                 return
1431         }
1432 another:
1433         for seeding || c.chunksSent < c.UsefulChunksReceived+6 {
1434                 c.Unchoke()
1435                 for r := range c.PeerRequests {
1436                         err := me.sendChunk(t, c, r)
1437                         if err != nil {
1438                                 log.Printf("error sending chunk %+v to peer: %s", r, err)
1439                         }
1440                         delete(c.PeerRequests, r)
1441                         goto another
1442                 }
1443                 return
1444         }
1445         c.Choke()
1446 }
1447
1448 func (me *Client) sendChunk(t *torrent, c *connection, r request) error {
1449         // Count the chunk being sent, even if it isn't.
1450         c.chunksSent++
1451         b := make([]byte, r.Length)
1452         tp := &t.Pieces[r.Index]
1453         tp.pendingWritesMutex.Lock()
1454         for tp.pendingWrites != 0 {
1455                 tp.noPendingWrites.Wait()
1456         }
1457         tp.pendingWritesMutex.Unlock()
1458         p := t.Info.Piece(int(r.Index))
1459         n, err := dataReadAt(t.data, b, p.Offset()+int64(r.Begin))
1460         if err != nil {
1461                 return err
1462         }
1463         if n != len(b) {
1464                 log.Fatal(b)
1465         }
1466         c.Post(pp.Message{
1467                 Type:  pp.Piece,
1468                 Index: r.Index,
1469                 Begin: r.Begin,
1470                 Piece: b,
1471         })
1472         uploadChunksPosted.Add(1)
1473         c.lastChunkSent = time.Now()
1474         return nil
1475 }
1476
1477 // Processes incoming bittorrent messages. The client lock is held upon entry
1478 // and exit.
1479 func (me *Client) connectionLoop(t *torrent, c *connection) error {
1480         decoder := pp.Decoder{
1481                 R:         bufio.NewReader(c.rw),
1482                 MaxLength: 256 * 1024,
1483         }
1484         for {
1485                 me.mu.Unlock()
1486                 var msg pp.Message
1487                 err := decoder.Decode(&msg)
1488                 receivedMessageTypes.Add(strconv.FormatInt(int64(msg.Type), 10), 1)
1489                 me.mu.Lock()
1490                 c.lastMessageReceived = time.Now()
1491                 select {
1492                 case <-c.closing:
1493                         return nil
1494                 default:
1495                 }
1496                 if err != nil {
1497                         if me.stopped() || err == io.EOF {
1498                                 return nil
1499                         }
1500                         return err
1501                 }
1502                 if msg.Keepalive {
1503                         continue
1504                 }
1505                 switch msg.Type {
1506                 case pp.Choke:
1507                         c.PeerChoked = true
1508                         for r := range c.Requests {
1509                                 me.connDeleteRequest(t, c, r)
1510                         }
1511                         // We can then reset our interest.
1512                         me.replenishConnRequests(t, c)
1513                 case pp.Reject:
1514                         me.connDeleteRequest(t, c, newRequest(msg.Index, msg.Begin, msg.Length))
1515                         me.replenishConnRequests(t, c)
1516                 case pp.Unchoke:
1517                         c.PeerChoked = false
1518                         me.peerUnchoked(t, c)
1519                 case pp.Interested:
1520                         c.PeerInterested = true
1521                         me.upload(t, c)
1522                 case pp.NotInterested:
1523                         c.PeerInterested = false
1524                         c.Choke()
1525                 case pp.Have:
1526                         me.peerGotPiece(t, c, int(msg.Index))
1527                 case pp.Request:
1528                         if c.Choked {
1529                                 break
1530                         }
1531                         if !c.PeerInterested {
1532                                 err = errors.New("peer sent request but isn't interested")
1533                                 break
1534                         }
1535                         if c.PeerRequests == nil {
1536                                 c.PeerRequests = make(map[request]struct{}, maxRequests)
1537                         }
1538                         c.PeerRequests[newRequest(msg.Index, msg.Begin, msg.Length)] = struct{}{}
1539                         me.upload(t, c)
1540                 case pp.Cancel:
1541                         req := newRequest(msg.Index, msg.Begin, msg.Length)
1542                         if !c.PeerCancel(req) {
1543                                 unexpectedCancels.Add(1)
1544                         }
1545                 case pp.Bitfield:
1546                         if c.PeerPieces != nil || c.peerHasAll {
1547                                 err = errors.New("received unexpected bitfield")
1548                                 break
1549                         }
1550                         if t.haveInfo() {
1551                                 if len(msg.Bitfield) < t.numPieces() {
1552                                         err = errors.New("received invalid bitfield")
1553                                         break
1554                                 }
1555                                 msg.Bitfield = msg.Bitfield[:t.numPieces()]
1556                         }
1557                         c.PeerPieces = msg.Bitfield
1558                         for index, has := range c.PeerPieces {
1559                                 if has {
1560                                         me.peerGotPiece(t, c, index)
1561                                 }
1562                         }
1563                 case pp.HaveAll:
1564                         if c.PeerPieces != nil || c.peerHasAll {
1565                                 err = errors.New("unexpected have-all")
1566                                 break
1567                         }
1568                         me.peerHasAll(t, c)
1569                 case pp.HaveNone:
1570                         if c.peerHasAll || c.PeerPieces != nil {
1571                                 err = errors.New("unexpected have-none")
1572                                 break
1573                         }
1574                         c.PeerPieces = make([]bool, func() int {
1575                                 if t.haveInfo() {
1576                                         return t.numPieces()
1577                                 } else {
1578                                         return 0
1579                                 }
1580                         }())
1581                 case pp.Piece:
1582                         err = me.downloadedChunk(t, c, &msg)
1583                 case pp.Extended:
1584                         switch msg.ExtendedID {
1585                         case pp.HandshakeExtendedID:
1586                                 // TODO: Create a bencode struct for this.
1587                                 var d map[string]interface{}
1588                                 err = bencode.Unmarshal(msg.ExtendedPayload, &d)
1589                                 if err != nil {
1590                                         err = fmt.Errorf("error decoding extended message payload: %s", err)
1591                                         break
1592                                 }
1593                                 // log.Printf("got handshake from %q: %#v", c.Socket.RemoteAddr().String(), d)
1594                                 if reqq, ok := d["reqq"]; ok {
1595                                         if i, ok := reqq.(int64); ok {
1596                                                 c.PeerMaxRequests = int(i)
1597                                         }
1598                                 }
1599                                 if v, ok := d["v"]; ok {
1600                                         c.PeerClientName = v.(string)
1601                                 }
1602                                 m, ok := d["m"]
1603                                 if !ok {
1604                                         err = errors.New("handshake missing m item")
1605                                         break
1606                                 }
1607                                 mTyped, ok := m.(map[string]interface{})
1608                                 if !ok {
1609                                         err = errors.New("handshake m value is not dict")
1610                                         break
1611                                 }
1612                                 if c.PeerExtensionIDs == nil {
1613                                         c.PeerExtensionIDs = make(map[string]byte, len(mTyped))
1614                                 }
1615                                 for name, v := range mTyped {
1616                                         id, ok := v.(int64)
1617                                         if !ok {
1618                                                 log.Printf("bad handshake m item extension ID type: %T", v)
1619                                                 continue
1620                                         }
1621                                         if id == 0 {
1622                                                 delete(c.PeerExtensionIDs, name)
1623                                         } else {
1624                                                 if c.PeerExtensionIDs[name] == 0 {
1625                                                         supportedExtensionMessages.Add(name, 1)
1626                                                 }
1627                                                 c.PeerExtensionIDs[name] = byte(id)
1628                                         }
1629                                 }
1630                                 metadata_sizeUntyped, ok := d["metadata_size"]
1631                                 if ok {
1632                                         metadata_size, ok := metadata_sizeUntyped.(int64)
1633                                         if !ok {
1634                                                 log.Printf("bad metadata_size type: %T", metadata_sizeUntyped)
1635                                         } else {
1636                                                 t.setMetadataSize(metadata_size, me)
1637                                         }
1638                                 }
1639                                 if _, ok := c.PeerExtensionIDs["ut_metadata"]; ok {
1640                                         me.requestPendingMetadata(t, c)
1641                                 }
1642                         case metadataExtendedId:
1643                                 err = me.gotMetadataExtensionMsg(msg.ExtendedPayload, t, c)
1644                                 if err != nil {
1645                                         err = fmt.Errorf("error handling metadata extension message: %s", err)
1646                                 }
1647                         case pexExtendedId:
1648                                 if me.config.DisablePEX {
1649                                         break
1650                                 }
1651                                 var pexMsg peerExchangeMessage
1652                                 err := bencode.Unmarshal(msg.ExtendedPayload, &pexMsg)
1653                                 if err != nil {
1654                                         err = fmt.Errorf("error unmarshalling PEX message: %s", err)
1655                                         break
1656                                 }
1657                                 go func() {
1658                                         me.mu.Lock()
1659                                         me.addPeers(t, func() (ret []Peer) {
1660                                                 for i, cp := range pexMsg.Added {
1661                                                         p := Peer{
1662                                                                 IP:     make([]byte, 4),
1663                                                                 Port:   int(cp.Port),
1664                                                                 Source: peerSourcePEX,
1665                                                         }
1666                                                         if i < len(pexMsg.AddedFlags) && pexMsg.AddedFlags[i]&0x01 != 0 {
1667                                                                 p.SupportsEncryption = true
1668                                                         }
1669                                                         CopyExact(p.IP, cp.IP[:])
1670                                                         ret = append(ret, p)
1671                                                 }
1672                                                 return
1673                                         }())
1674                                         me.mu.Unlock()
1675                                 }()
1676                         default:
1677                                 err = fmt.Errorf("unexpected extended message ID: %v", msg.ExtendedID)
1678                         }
1679                         if err != nil {
1680                                 // That client uses its own extension IDs for outgoing message
1681                                 // types, which is incorrect.
1682                                 if bytes.HasPrefix(c.PeerID[:], []byte("-SD0100-")) ||
1683                                         strings.HasPrefix(string(c.PeerID[:]), "-XL0012-") {
1684                                         return nil
1685                                 }
1686                         }
1687                 case pp.Port:
1688                         if me.dHT == nil {
1689                                 break
1690                         }
1691                         pingAddr, err := net.ResolveUDPAddr("", c.remoteAddr().String())
1692                         if err != nil {
1693                                 panic(err)
1694                         }
1695                         if msg.Port != 0 {
1696                                 pingAddr.Port = int(msg.Port)
1697                         }
1698                         _, err = me.dHT.Ping(pingAddr)
1699                 default:
1700                         err = fmt.Errorf("received unknown message type: %#v", msg.Type)
1701                 }
1702                 if err != nil {
1703                         return err
1704                 }
1705         }
1706 }
1707
1708 // Returns true if connection is removed from torrent.Conns.
1709 func (me *Client) deleteConnection(t *torrent, c *connection) bool {
1710         for i0, _c := range t.Conns {
1711                 if _c != c {
1712                         continue
1713                 }
1714                 i1 := len(t.Conns) - 1
1715                 if i0 != i1 {
1716                         t.Conns[i0] = t.Conns[i1]
1717                 }
1718                 t.Conns = t.Conns[:i1]
1719                 return true
1720         }
1721         return false
1722 }
1723
1724 func (me *Client) dropConnection(t *torrent, c *connection) {
1725         me.event.Broadcast()
1726         c.Close()
1727         if c.piecePriorities != nil {
1728                 t.connPiecePriorites.Put(c.piecePriorities)
1729                 // I wonder if it's safe to set it to nil. Probably not. Since it's
1730                 // only read, it doesn't particularly matter if a closing connection
1731                 // shares the slice with another connection.
1732         }
1733         if me.deleteConnection(t, c) {
1734                 me.openNewConns(t)
1735         }
1736 }
1737
1738 // Returns true if the connection is added.
1739 func (me *Client) addConnection(t *torrent, c *connection) bool {
1740         if me.stopped() {
1741                 return false
1742         }
1743         select {
1744         case <-t.ceasingNetworking:
1745                 return false
1746         default:
1747         }
1748         if !me.wantConns(t) {
1749                 return false
1750         }
1751         for _, c0 := range t.Conns {
1752                 if c.PeerID == c0.PeerID {
1753                         // Already connected to a client with that ID.
1754                         duplicateClientConns.Add(1)
1755                         return false
1756                 }
1757         }
1758         if len(t.Conns) >= socketsPerTorrent {
1759                 c := t.worstBadConn(me)
1760                 if c == nil {
1761                         return false
1762                 }
1763                 if me.config.Debug && missinggo.CryHeard() {
1764                         log.Printf("%s: dropping connection to make room for new one:\n    %s", t, c)
1765                 }
1766                 c.Close()
1767                 me.deleteConnection(t, c)
1768         }
1769         if len(t.Conns) >= socketsPerTorrent {
1770                 panic(len(t.Conns))
1771         }
1772         t.Conns = append(t.Conns, c)
1773         return true
1774 }
1775
1776 func (t *torrent) needData() bool {
1777         if !t.haveInfo() {
1778                 return true
1779         }
1780         if len(t.urgent) != 0 {
1781                 return true
1782         }
1783         for i := range t.Pieces {
1784                 p := &t.Pieces[i]
1785                 if p.Priority != PiecePriorityNone {
1786                         return true
1787                 }
1788         }
1789         return false
1790 }
1791
1792 func (cl *Client) usefulConn(t *torrent, c *connection) bool {
1793         select {
1794         case <-c.closing:
1795                 return false
1796         default:
1797         }
1798         if !t.haveInfo() {
1799                 return c.supportsExtension("ut_metadata")
1800         }
1801         if cl.seeding(t) {
1802                 return c.PeerInterested
1803         }
1804         return t.connHasWantedPieces(c)
1805 }
1806
1807 func (me *Client) wantConns(t *torrent) bool {
1808         if !me.seeding(t) && !t.needData() {
1809                 return false
1810         }
1811         if len(t.Conns) < socketsPerTorrent {
1812                 return true
1813         }
1814         return t.worstBadConn(me) != nil
1815 }
1816
1817 func (me *Client) openNewConns(t *torrent) {
1818         select {
1819         case <-t.ceasingNetworking:
1820                 return
1821         default:
1822         }
1823         for len(t.Peers) != 0 {
1824                 if !me.wantConns(t) {
1825                         return
1826                 }
1827                 if len(t.HalfOpen) >= me.halfOpenLimit {
1828                         return
1829                 }
1830                 var (
1831                         k peersKey
1832                         p Peer
1833                 )
1834                 for k, p = range t.Peers {
1835                         break
1836                 }
1837                 delete(t.Peers, k)
1838                 me.initiateConn(p, t)
1839         }
1840         t.wantPeers.Broadcast()
1841 }
1842
1843 func (me *Client) addPeers(t *torrent, peers []Peer) {
1844         for _, p := range peers {
1845                 if me.dopplegangerAddr(net.JoinHostPort(
1846                         p.IP.String(),
1847                         strconv.FormatInt(int64(p.Port), 10),
1848                 )) {
1849                         continue
1850                 }
1851                 if _, ok := me.ipBlockRange(p.IP); ok {
1852                         continue
1853                 }
1854                 if p.Port == 0 {
1855                         // The spec says to scrub these yourselves. Fine.
1856                         continue
1857                 }
1858                 t.addPeer(p, me)
1859         }
1860 }
1861
1862 func (cl *Client) cachedMetaInfoFilename(ih InfoHash) string {
1863         return filepath.Join(cl.configDir(), "torrents", ih.HexString()+".torrent")
1864 }
1865
1866 func (cl *Client) saveTorrentFile(t *torrent) error {
1867         path := cl.cachedMetaInfoFilename(t.InfoHash)
1868         os.MkdirAll(filepath.Dir(path), 0777)
1869         f, err := os.OpenFile(path, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0666)
1870         if err != nil {
1871                 return fmt.Errorf("error opening file: %s", err)
1872         }
1873         defer f.Close()
1874         e := bencode.NewEncoder(f)
1875         err = e.Encode(t.MetaInfo())
1876         if err != nil {
1877                 return fmt.Errorf("error marshalling metainfo: %s", err)
1878         }
1879         mi, err := cl.torrentCacheMetaInfo(t.InfoHash)
1880         if err != nil {
1881                 // For example, a script kiddy makes us load too many files, and we're
1882                 // able to save the torrent, but not load it again to check it.
1883                 return nil
1884         }
1885         if !bytes.Equal(mi.Info.Hash, t.InfoHash[:]) {
1886                 log.Fatalf("%x != %x", mi.Info.Hash, t.InfoHash[:])
1887         }
1888         return nil
1889 }
1890
1891 func (cl *Client) startTorrent(t *torrent) {
1892         if t.Info == nil || t.data == nil {
1893                 panic("nope")
1894         }
1895         // If the client intends to upload, it needs to know what state pieces are
1896         // in.
1897         if !cl.config.NoUpload {
1898                 // Queue all pieces for hashing. This is done sequentially to avoid
1899                 // spamming goroutines.
1900                 for i := range t.Pieces {
1901                         t.Pieces[i].QueuedForHash = true
1902                 }
1903                 go func() {
1904                         for i := range t.Pieces {
1905                                 cl.verifyPiece(t, i)
1906                         }
1907                 }()
1908         }
1909 }
1910
1911 // Storage cannot be changed once it's set.
1912 func (cl *Client) setStorage(t *torrent, td Data) (err error) {
1913         err = t.setStorage(td)
1914         cl.event.Broadcast()
1915         if err != nil {
1916                 return
1917         }
1918         cl.startTorrent(t)
1919         return
1920 }
1921
1922 type TorrentDataOpener func(*metainfo.Info) Data
1923
1924 func (cl *Client) setMetaData(t *torrent, md *metainfo.Info, bytes []byte) (err error) {
1925         err = t.setMetadata(md, bytes)
1926         if err != nil {
1927                 return
1928         }
1929         if !cl.config.DisableMetainfoCache {
1930                 if err := cl.saveTorrentFile(t); err != nil {
1931                         log.Printf("error saving torrent file for %s: %s", t, err)
1932                 }
1933         }
1934         cl.event.Broadcast()
1935         close(t.gotMetainfo)
1936         td := cl.torrentDataOpener(md)
1937         err = cl.setStorage(t, td)
1938         return
1939 }
1940
1941 // Prepare a Torrent without any attachment to a Client. That means we can
1942 // initialize fields all fields that don't require the Client without locking
1943 // it.
1944 func newTorrent(ih InfoHash) (t *torrent, err error) {
1945         t = &torrent{
1946                 InfoHash:  ih,
1947                 chunkSize: defaultChunkSize,
1948                 Peers:     make(map[peersKey]Peer),
1949
1950                 closing:           make(chan struct{}),
1951                 ceasingNetworking: make(chan struct{}),
1952
1953                 gotMetainfo: make(chan struct{}),
1954
1955                 HalfOpen:          make(map[string]struct{}),
1956                 pieceStateChanges: pubsub.NewPubSub(),
1957         }
1958         t.wantPeers.L = &t.stateMu
1959         return
1960 }
1961
1962 func init() {
1963         // For shuffling the tracker tiers.
1964         mathRand.Seed(time.Now().Unix())
1965 }
1966
1967 // The trackers within each tier must be shuffled before use.
1968 // http://stackoverflow.com/a/12267471/149482
1969 // http://www.bittorrent.org/beps/bep_0012.html#order-of-processing
1970 func shuffleTier(tier []tracker.Client) {
1971         for i := range tier {
1972                 j := mathRand.Intn(i + 1)
1973                 tier[i], tier[j] = tier[j], tier[i]
1974         }
1975 }
1976
1977 func copyTrackers(base [][]tracker.Client) (copy [][]tracker.Client) {
1978         for _, tier := range base {
1979                 copy = append(copy, append([]tracker.Client{}, tier...))
1980         }
1981         return
1982 }
1983
1984 func mergeTier(tier []tracker.Client, newURLs []string) []tracker.Client {
1985 nextURL:
1986         for _, url := range newURLs {
1987                 for _, tr := range tier {
1988                         if tr.URL() == url {
1989                                 continue nextURL
1990                         }
1991                 }
1992                 tr, err := tracker.New(url)
1993                 if err != nil {
1994                         // log.Printf("error creating tracker client for %q: %s", url, err)
1995                         continue
1996                 }
1997                 tier = append(tier, tr)
1998         }
1999         return tier
2000 }
2001
2002 func (t *torrent) addTrackers(announceList [][]string) {
2003         newTrackers := copyTrackers(t.Trackers)
2004         for tierIndex, tier := range announceList {
2005                 if tierIndex < len(newTrackers) {
2006                         newTrackers[tierIndex] = mergeTier(newTrackers[tierIndex], tier)
2007                 } else {
2008                         newTrackers = append(newTrackers, mergeTier(nil, tier))
2009                 }
2010                 shuffleTier(newTrackers[tierIndex])
2011         }
2012         t.Trackers = newTrackers
2013 }
2014
2015 // Don't call this before the info is available.
2016 func (t *torrent) bytesCompleted() int64 {
2017         if !t.haveInfo() {
2018                 return 0
2019         }
2020         return t.Info.TotalLength() - t.bytesLeft()
2021 }
2022
2023 // A file-like handle to some torrent data resource.
2024 type Handle interface {
2025         io.Reader
2026         io.Seeker
2027         io.Closer
2028         io.ReaderAt
2029 }
2030
2031 // Returns handles to the files in the torrent. This requires the metainfo is
2032 // available first.
2033 func (t Torrent) Files() (ret []File) {
2034         t.cl.mu.Lock()
2035         info := t.Info()
2036         t.cl.mu.Unlock()
2037         if info == nil {
2038                 return
2039         }
2040         var offset int64
2041         for _, fi := range info.UpvertedFiles() {
2042                 ret = append(ret, File{
2043                         t,
2044                         strings.Join(append([]string{info.Name}, fi.Path...), "/"),
2045                         offset,
2046                         fi.Length,
2047                         fi,
2048                 })
2049                 offset += fi.Length
2050         }
2051         return
2052 }
2053
2054 // Marks the pieces in the given region for download.
2055 func (t Torrent) SetRegionPriority(off, len int64) {
2056         t.cl.mu.Lock()
2057         defer t.cl.mu.Unlock()
2058         pieceSize := int64(t.usualPieceSize())
2059         for i := off / pieceSize; i*pieceSize < off+len; i++ {
2060                 t.cl.raisePiecePriority(t.torrent, int(i), PiecePriorityNormal)
2061         }
2062 }
2063
2064 func (t Torrent) AddPeers(pp []Peer) error {
2065         cl := t.cl
2066         cl.mu.Lock()
2067         defer cl.mu.Unlock()
2068         cl.addPeers(t.torrent, pp)
2069         return nil
2070 }
2071
2072 // Marks the entire torrent for download. Requires the info first, see
2073 // GotInfo.
2074 func (t Torrent) DownloadAll() {
2075         t.cl.mu.Lock()
2076         defer t.cl.mu.Unlock()
2077         for i := range iter.N(t.numPieces()) {
2078                 t.cl.raisePiecePriority(t.torrent, i, PiecePriorityNormal)
2079         }
2080         // Nice to have the first and last pieces sooner for various interactive
2081         // purposes.
2082         t.cl.raisePiecePriority(t.torrent, 0, PiecePriorityReadahead)
2083         t.cl.raisePiecePriority(t.torrent, t.numPieces()-1, PiecePriorityReadahead)
2084 }
2085
2086 // Returns nil metainfo if it isn't in the cache. Checks that the retrieved
2087 // metainfo has the correct infohash.
2088 func (cl *Client) torrentCacheMetaInfo(ih InfoHash) (mi *metainfo.MetaInfo, err error) {
2089         if cl.config.DisableMetainfoCache {
2090                 return
2091         }
2092         f, err := os.Open(cl.cachedMetaInfoFilename(ih))
2093         if err != nil {
2094                 if os.IsNotExist(err) {
2095                         err = nil
2096                 }
2097                 return
2098         }
2099         defer f.Close()
2100         dec := bencode.NewDecoder(f)
2101         err = dec.Decode(&mi)
2102         if err != nil {
2103                 return
2104         }
2105         if !bytes.Equal(mi.Info.Hash, ih[:]) {
2106                 err = fmt.Errorf("cached torrent has wrong infohash: %x != %x", mi.Info.Hash, ih[:])
2107                 return
2108         }
2109         return
2110 }
2111
2112 // Specifies a new torrent for adding to a client. There are helpers for
2113 // magnet URIs and torrent metainfo files.
2114 type TorrentSpec struct {
2115         // The tiered tracker URIs.
2116         Trackers [][]string
2117         InfoHash InfoHash
2118         Info     *metainfo.InfoEx
2119         // The name to use if the Name field from the Info isn't available.
2120         DisplayName string
2121         // The chunk size to use for outbound requests. Defaults to 16KiB if not
2122         // set.
2123         ChunkSize int
2124 }
2125
2126 func TorrentSpecFromMagnetURI(uri string) (spec *TorrentSpec, err error) {
2127         m, err := ParseMagnetURI(uri)
2128         if err != nil {
2129                 return
2130         }
2131         spec = &TorrentSpec{
2132                 Trackers:    [][]string{m.Trackers},
2133                 DisplayName: m.DisplayName,
2134                 InfoHash:    m.InfoHash,
2135         }
2136         return
2137 }
2138
2139 func TorrentSpecFromMetaInfo(mi *metainfo.MetaInfo) (spec *TorrentSpec) {
2140         spec = &TorrentSpec{
2141                 Trackers:    mi.AnnounceList,
2142                 Info:        &mi.Info,
2143                 DisplayName: mi.Info.Name,
2144         }
2145
2146         if len(spec.Trackers) == 0 {
2147                 spec.Trackers = [][]string{[]string{mi.Announce}}
2148         } else {
2149                 spec.Trackers[0] = append(spec.Trackers[0], mi.Announce)
2150         }
2151
2152         CopyExact(&spec.InfoHash, &mi.Info.Hash)
2153         return
2154 }
2155
2156 // Add or merge a torrent spec. If the torrent is already present, the
2157 // trackers will be merged with the existing ones. If the Info isn't yet
2158 // known, it will be set. The display name is replaced if the new spec
2159 // provides one. Returns new if the torrent wasn't already in the client.
2160 func (cl *Client) AddTorrentSpec(spec *TorrentSpec) (T Torrent, new bool, err error) {
2161         T.cl = cl
2162         cl.mu.Lock()
2163         defer cl.mu.Unlock()
2164
2165         t, ok := cl.torrents[spec.InfoHash]
2166         if !ok {
2167                 new = true
2168
2169                 if _, ok := cl.bannedTorrents[spec.InfoHash]; ok {
2170                         err = errors.New("banned torrent")
2171                         return
2172                 }
2173
2174                 t, err = newTorrent(spec.InfoHash)
2175                 if err != nil {
2176                         return
2177                 }
2178                 if spec.ChunkSize != 0 {
2179                         t.chunkSize = pp.Integer(spec.ChunkSize)
2180                 }
2181         }
2182         if spec.DisplayName != "" {
2183                 t.setDisplayName(spec.DisplayName)
2184         }
2185         // Try to merge in info we have on the torrent. Any err left will
2186         // terminate the function.
2187         if t.Info == nil {
2188                 if spec.Info != nil {
2189                         err = cl.setMetaData(t, &spec.Info.Info, spec.Info.Bytes)
2190                 } else {
2191                         var mi *metainfo.MetaInfo
2192                         mi, err = cl.torrentCacheMetaInfo(spec.InfoHash)
2193                         if err != nil {
2194                                 log.Printf("error getting cached metainfo: %s", err)
2195                                 err = nil
2196                         } else if mi != nil {
2197                                 t.addTrackers(mi.AnnounceList)
2198                                 err = cl.setMetaData(t, &mi.Info.Info, mi.Info.Bytes)
2199                         }
2200                 }
2201         }
2202         if err != nil {
2203                 return
2204         }
2205         t.addTrackers(spec.Trackers)
2206
2207         cl.torrents[spec.InfoHash] = t
2208         T.torrent = t
2209
2210         // From this point onwards, we can consider the torrent a part of the
2211         // client.
2212         if new {
2213                 if !cl.config.DisableTrackers {
2214                         go cl.announceTorrentTrackers(T.torrent)
2215                 }
2216                 if cl.dHT != nil {
2217                         go cl.announceTorrentDHT(T.torrent, true)
2218                 }
2219         }
2220         return
2221 }
2222
2223 func (me *Client) dropTorrent(infoHash InfoHash) (err error) {
2224         t, ok := me.torrents[infoHash]
2225         if !ok {
2226                 err = fmt.Errorf("no such torrent")
2227                 return
2228         }
2229         err = t.close()
2230         if err != nil {
2231                 panic(err)
2232         }
2233         delete(me.torrents, infoHash)
2234         return
2235 }
2236
2237 // Returns true when peers are required, or false if the torrent is closing.
2238 func (cl *Client) waitWantPeers(t *torrent) bool {
2239         cl.mu.Lock()
2240         defer cl.mu.Unlock()
2241         t.stateMu.Lock()
2242         defer t.stateMu.Unlock()
2243         for {
2244                 select {
2245                 case <-t.ceasingNetworking:
2246                         return false
2247                 default:
2248                 }
2249                 if len(t.Peers) > torrentPeersLowWater {
2250                         goto wait
2251                 }
2252                 if t.needData() || cl.seeding(t) {
2253                         return true
2254                 }
2255         wait:
2256                 cl.mu.Unlock()
2257                 t.wantPeers.Wait()
2258                 t.stateMu.Unlock()
2259                 cl.mu.Lock()
2260                 t.stateMu.Lock()
2261         }
2262 }
2263
2264 // Returns whether the client should make effort to seed the torrent.
2265 func (cl *Client) seeding(t *torrent) bool {
2266         if cl.config.NoUpload {
2267                 return false
2268         }
2269         if !cl.config.Seed {
2270                 return false
2271         }
2272         if t.needData() {
2273                 return false
2274         }
2275         return true
2276 }
2277
2278 func (cl *Client) announceTorrentDHT(t *torrent, impliedPort bool) {
2279         for cl.waitWantPeers(t) {
2280                 // log.Printf("getting peers for %q from DHT", t)
2281                 ps, err := cl.dHT.Announce(string(t.InfoHash[:]), cl.incomingPeerPort(), impliedPort)
2282                 if err != nil {
2283                         log.Printf("error getting peers from dht: %s", err)
2284                         return
2285                 }
2286                 // Count all the unique addresses we got during this announce.
2287                 allAddrs := make(map[string]struct{})
2288         getPeers:
2289                 for {
2290                         select {
2291                         case v, ok := <-ps.Peers:
2292                                 if !ok {
2293                                         break getPeers
2294                                 }
2295                                 addPeers := make([]Peer, 0, len(v.Peers))
2296                                 for _, cp := range v.Peers {
2297                                         if cp.Port == 0 {
2298                                                 // Can't do anything with this.
2299                                                 continue
2300                                         }
2301                                         addPeers = append(addPeers, Peer{
2302                                                 IP:     cp.IP[:],
2303                                                 Port:   int(cp.Port),
2304                                                 Source: peerSourceDHT,
2305                                         })
2306                                         key := (&net.UDPAddr{
2307                                                 IP:   cp.IP[:],
2308                                                 Port: int(cp.Port),
2309                                         }).String()
2310                                         allAddrs[key] = struct{}{}
2311                                 }
2312                                 cl.mu.Lock()
2313                                 cl.addPeers(t, addPeers)
2314                                 numPeers := len(t.Peers)
2315                                 cl.mu.Unlock()
2316                                 if numPeers >= torrentPeersHighWater {
2317                                         break getPeers
2318                                 }
2319                         case <-t.ceasingNetworking:
2320                                 ps.Close()
2321                                 return
2322                         }
2323                 }
2324                 ps.Close()
2325                 // log.Printf("finished DHT peer scrape for %s: %d peers", t, len(allAddrs))
2326         }
2327 }
2328
2329 func (cl *Client) trackerBlockedUnlocked(tr tracker.Client) (blocked bool, err error) {
2330         url_, err := url.Parse(tr.URL())
2331         if err != nil {
2332                 return
2333         }
2334         host, _, err := net.SplitHostPort(url_.Host)
2335         if err != nil {
2336                 host = url_.Host
2337         }
2338         addr, err := net.ResolveIPAddr("ip", host)
2339         if err != nil {
2340                 return
2341         }
2342         cl.mu.RLock()
2343         _, blocked = cl.ipBlockRange(addr.IP)
2344         cl.mu.RUnlock()
2345         return
2346 }
2347
2348 func (cl *Client) announceTorrentSingleTracker(tr tracker.Client, req *tracker.AnnounceRequest, t *torrent) error {
2349         blocked, err := cl.trackerBlockedUnlocked(tr)
2350         if err != nil {
2351                 return fmt.Errorf("error determining if tracker blocked: %s", err)
2352         }
2353         if blocked {
2354                 return fmt.Errorf("tracker blocked: %s", tr)
2355         }
2356         if err := tr.Connect(); err != nil {
2357                 return fmt.Errorf("error connecting: %s", err)
2358         }
2359         resp, err := tr.Announce(req)
2360         if err != nil {
2361                 return fmt.Errorf("error announcing: %s", err)
2362         }
2363         var peers []Peer
2364         for _, peer := range resp.Peers {
2365                 peers = append(peers, Peer{
2366                         IP:   peer.IP,
2367                         Port: peer.Port,
2368                 })
2369         }
2370         cl.mu.Lock()
2371         cl.addPeers(t, peers)
2372         cl.mu.Unlock()
2373
2374         // log.Printf("%s: %d new peers from %s", t, len(peers), tr)
2375
2376         time.Sleep(time.Second * time.Duration(resp.Interval))
2377         return nil
2378 }
2379
2380 func (cl *Client) announceTorrentTrackersFastStart(req *tracker.AnnounceRequest, trackers [][]tracker.Client, t *torrent) (atLeastOne bool) {
2381         oks := make(chan bool)
2382         outstanding := 0
2383         for _, tier := range trackers {
2384                 for _, tr := range tier {
2385                         outstanding++
2386                         go func(tr tracker.Client) {
2387                                 err := cl.announceTorrentSingleTracker(tr, req, t)
2388                                 oks <- err == nil
2389                         }(tr)
2390                 }
2391         }
2392         for outstanding > 0 {
2393                 ok := <-oks
2394                 outstanding--
2395                 if ok {
2396                         atLeastOne = true
2397                 }
2398         }
2399         return
2400 }
2401
2402 // Announce torrent to its trackers.
2403 func (cl *Client) announceTorrentTrackers(t *torrent) {
2404         req := tracker.AnnounceRequest{
2405                 Event:    tracker.Started,
2406                 NumWant:  -1,
2407                 Port:     uint16(cl.incomingPeerPort()),
2408                 PeerId:   cl.peerID,
2409                 InfoHash: t.InfoHash,
2410         }
2411         if !cl.waitWantPeers(t) {
2412                 return
2413         }
2414         cl.mu.RLock()
2415         req.Left = uint64(t.bytesLeft())
2416         trackers := t.Trackers
2417         cl.mu.RUnlock()
2418         if cl.announceTorrentTrackersFastStart(&req, trackers, t) {
2419                 req.Event = tracker.None
2420         }
2421 newAnnounce:
2422         for cl.waitWantPeers(t) {
2423                 cl.mu.RLock()
2424                 req.Left = uint64(t.bytesLeft())
2425                 trackers = t.Trackers
2426                 cl.mu.RUnlock()
2427                 numTrackersTried := 0
2428                 for _, tier := range trackers {
2429                         for trIndex, tr := range tier {
2430                                 numTrackersTried++
2431                                 err := cl.announceTorrentSingleTracker(tr, &req, t)
2432                                 if err != nil {
2433                                         continue
2434                                 }
2435                                 // Float the successful announce to the top of the tier. If
2436                                 // the trackers list has been changed, we'll be modifying an
2437                                 // old copy so it won't matter.
2438                                 cl.mu.Lock()
2439                                 tier[0], tier[trIndex] = tier[trIndex], tier[0]
2440                                 cl.mu.Unlock()
2441
2442                                 req.Event = tracker.None
2443                                 continue newAnnounce
2444                         }
2445                 }
2446                 if numTrackersTried != 0 {
2447                         log.Printf("%s: all trackers failed", t)
2448                 }
2449                 // TODO: Wait until trackers are added if there are none.
2450                 time.Sleep(10 * time.Second)
2451         }
2452 }
2453
2454 func (cl *Client) allTorrentsCompleted() bool {
2455         for _, t := range cl.torrents {
2456                 if !t.haveInfo() {
2457                         return false
2458                 }
2459                 if t.numPiecesCompleted() != t.numPieces() {
2460                         return false
2461                 }
2462         }
2463         return true
2464 }
2465
2466 // Returns true when all torrents are completely downloaded and false if the
2467 // client is stopped before that.
2468 func (me *Client) WaitAll() bool {
2469         me.mu.Lock()
2470         defer me.mu.Unlock()
2471         for !me.allTorrentsCompleted() {
2472                 if me.stopped() {
2473                         return false
2474                 }
2475                 me.event.Wait()
2476         }
2477         return true
2478 }
2479
2480 func (me *Client) fillRequests(t *torrent, c *connection) {
2481         if c.Interested {
2482                 if c.PeerChoked {
2483                         return
2484                 }
2485                 if len(c.Requests) > c.requestsLowWater {
2486                         return
2487                 }
2488         }
2489         addRequest := func(req request) (again bool) {
2490                 // TODO: Couldn't this check also be done *after* the request?
2491                 if len(c.Requests) >= 64 {
2492                         return false
2493                 }
2494                 return c.Request(req)
2495         }
2496         for req := range t.urgent {
2497                 if !addRequest(req) {
2498                         return
2499                 }
2500         }
2501         for e := c.pieceRequestOrder.First(); e != nil; e = e.Next() {
2502                 pieceIndex := e.Piece()
2503                 if !c.PeerHasPiece(pieceIndex) {
2504                         panic("piece in request order but peer doesn't have it")
2505                 }
2506                 if !t.wantPiece(pieceIndex) {
2507                         log.Printf("unwanted piece %d in connection request order\n%s", pieceIndex, c)
2508                         c.pieceRequestOrder.DeletePiece(pieceIndex)
2509                         continue
2510                 }
2511                 piece := &t.Pieces[pieceIndex]
2512                 for _, cs := range piece.shuffledPendingChunkSpecs(t, pieceIndex) {
2513                         r := request{pp.Integer(pieceIndex), cs}
2514                         if !addRequest(r) {
2515                                 return
2516                         }
2517                 }
2518         }
2519         return
2520 }
2521
2522 func (me *Client) replenishConnRequests(t *torrent, c *connection) {
2523         if !t.haveInfo() {
2524                 return
2525         }
2526         me.fillRequests(t, c)
2527         if len(c.Requests) == 0 && !c.PeerChoked {
2528                 // So we're not choked, but we don't want anything right now. We may
2529                 // have completed readahead, and the readahead window has not rolled
2530                 // over to the next piece. Better to stay interested in case we're
2531                 // going to want data in the near future.
2532                 c.SetInterested(!t.haveAllPieces())
2533         }
2534 }
2535
2536 // Handle a received chunk from a peer.
2537 func (me *Client) downloadedChunk(t *torrent, c *connection, msg *pp.Message) error {
2538         chunksReceived.Add(1)
2539
2540         req := newRequest(msg.Index, msg.Begin, pp.Integer(len(msg.Piece)))
2541
2542         // Request has been satisfied.
2543         if me.connDeleteRequest(t, c, req) {
2544                 defer me.replenishConnRequests(t, c)
2545         } else {
2546                 unexpectedChunksReceived.Add(1)
2547         }
2548
2549         index := int(req.Index)
2550         piece := &t.Pieces[index]
2551
2552         // Do we actually want this chunk?
2553         if !t.wantChunk(req) {
2554                 unwantedChunksReceived.Add(1)
2555                 c.UnwantedChunksReceived++
2556                 return nil
2557         }
2558
2559         c.UsefulChunksReceived++
2560         c.lastUsefulChunkReceived = time.Now()
2561
2562         me.upload(t, c)
2563
2564         piece.pendingWritesMutex.Lock()
2565         piece.pendingWrites++
2566         piece.pendingWritesMutex.Unlock()
2567         go func() {
2568                 defer func() {
2569                         piece.pendingWritesMutex.Lock()
2570                         piece.pendingWrites--
2571                         if piece.pendingWrites == 0 {
2572                                 piece.noPendingWrites.Broadcast()
2573                         }
2574                         piece.pendingWritesMutex.Unlock()
2575                 }()
2576                 // Write the chunk out.
2577                 tr := perf.NewTimer()
2578                 err := t.writeChunk(int(msg.Index), int64(msg.Begin), msg.Piece)
2579                 if err != nil {
2580                         log.Printf("error writing chunk: %s", err)
2581                         return
2582                 }
2583                 tr.Stop("write chunk")
2584                 me.mu.Lock()
2585                 if c.peerTouchedPieces == nil {
2586                         c.peerTouchedPieces = make(map[int]struct{})
2587                 }
2588                 c.peerTouchedPieces[index] = struct{}{}
2589                 me.mu.Unlock()
2590         }()
2591
2592         // log.Println("got chunk", req)
2593         me.event.Broadcast()
2594         defer t.publishPieceChange(int(req.Index))
2595         // Record that we have the chunk.
2596         piece.unpendChunkIndex(chunkIndex(req.chunkSpec, t.chunkSize))
2597         delete(t.urgent, req)
2598         // It's important that the piece is potentially queued before we check if
2599         // the piece is still wanted, because if it is queued, it won't be wanted.
2600         if t.pieceAllDirty(index) {
2601                 me.queuePieceCheck(t, int(req.Index))
2602         }
2603         if !t.wantPiece(int(req.Index)) {
2604                 for _, c := range t.Conns {
2605                         c.pieceRequestOrder.DeletePiece(int(req.Index))
2606                 }
2607         }
2608
2609         // Cancel pending requests for this chunk.
2610         for _, c := range t.Conns {
2611                 if me.connCancel(t, c, req) {
2612                         me.replenishConnRequests(t, c)
2613                 }
2614         }
2615
2616         return nil
2617 }
2618
2619 // Return the connections that touched a piece, and clear the entry while
2620 // doing it.
2621 func (me *Client) reapPieceTouches(t *torrent, piece int) (ret []*connection) {
2622         for _, c := range t.Conns {
2623                 if _, ok := c.peerTouchedPieces[piece]; ok {
2624                         ret = append(ret, c)
2625                         delete(c.peerTouchedPieces, piece)
2626                 }
2627         }
2628         return
2629 }
2630
2631 func (me *Client) pieceHashed(t *torrent, piece int, correct bool) {
2632         p := &t.Pieces[piece]
2633         if p.EverHashed {
2634                 // Don't score the first time a piece is hashed, it could be an
2635                 // initial check.
2636                 if correct {
2637                         pieceHashedCorrect.Add(1)
2638                 } else {
2639                         log.Printf("%s: piece %d failed hash", t, piece)
2640                         pieceHashedNotCorrect.Add(1)
2641                 }
2642         }
2643         p.EverHashed = true
2644         touchers := me.reapPieceTouches(t, int(piece))
2645         if correct {
2646                 err := t.data.PieceCompleted(int(piece))
2647                 if err != nil {
2648                         log.Printf("error completing piece: %s", err)
2649                         correct = false
2650                 }
2651         } else if len(touchers) != 0 {
2652                 log.Printf("dropping %d conns that touched piece", len(touchers))
2653                 for _, c := range touchers {
2654                         me.dropConnection(t, c)
2655                 }
2656         }
2657         me.pieceChanged(t, int(piece))
2658 }
2659
2660 func (me *Client) pieceChanged(t *torrent, piece int) {
2661         correct := t.pieceComplete(piece)
2662         p := &t.Pieces[piece]
2663         defer t.publishPieceChange(piece)
2664         defer me.event.Broadcast()
2665         if correct {
2666                 p.Priority = PiecePriorityNone
2667                 for req := range t.urgent {
2668                         if int(req.Index) == piece {
2669                                 delete(t.urgent, req)
2670                         }
2671                 }
2672         } else {
2673                 if t.pieceAllDirty(piece) {
2674                         t.pendAllChunkSpecs(piece)
2675                 }
2676                 if t.wantPiece(piece) {
2677                         me.openNewConns(t)
2678                 }
2679         }
2680         for _, conn := range t.Conns {
2681                 if correct {
2682                         conn.Have(piece)
2683                         for r := range conn.Requests {
2684                                 if int(r.Index) == piece {
2685                                         conn.Cancel(r)
2686                                 }
2687                         }
2688                         conn.pieceRequestOrder.DeletePiece(int(piece))
2689                         me.upload(t, conn)
2690                 } else if t.wantPiece(piece) && conn.PeerHasPiece(piece) {
2691                         t.connPendPiece(conn, int(piece))
2692                         me.replenishConnRequests(t, conn)
2693                 }
2694         }
2695         me.event.Broadcast()
2696 }
2697
2698 func (cl *Client) verifyPiece(t *torrent, piece int) {
2699         cl.mu.Lock()
2700         defer cl.mu.Unlock()
2701         p := &t.Pieces[piece]
2702         for p.Hashing || t.data == nil {
2703                 cl.event.Wait()
2704         }
2705         p.QueuedForHash = false
2706         if t.isClosed() || t.pieceComplete(piece) {
2707                 return
2708         }
2709         p.Hashing = true
2710         cl.mu.Unlock()
2711         sum := t.hashPiece(piece)
2712         cl.mu.Lock()
2713         select {
2714         case <-t.closing:
2715                 return
2716         default:
2717         }
2718         p.Hashing = false
2719         cl.pieceHashed(t, piece, sum == p.Hash)
2720 }
2721
2722 // Returns handles to all the torrents loaded in the Client.
2723 func (me *Client) Torrents() (ret []Torrent) {
2724         me.mu.Lock()
2725         for _, t := range me.torrents {
2726                 ret = append(ret, Torrent{me, t})
2727         }
2728         me.mu.Unlock()
2729         return
2730 }
2731
2732 func (me *Client) AddMagnet(uri string) (T Torrent, err error) {
2733         spec, err := TorrentSpecFromMagnetURI(uri)
2734         if err != nil {
2735                 return
2736         }
2737         T, _, err = me.AddTorrentSpec(spec)
2738         return
2739 }
2740
2741 func (me *Client) AddTorrent(mi *metainfo.MetaInfo) (T Torrent, err error) {
2742         T, _, err = me.AddTorrentSpec(TorrentSpecFromMetaInfo(mi))
2743         return
2744 }
2745
2746 func (me *Client) AddTorrentFromFile(filename string) (T Torrent, err error) {
2747         mi, err := metainfo.LoadFromFile(filename)
2748         if err != nil {
2749                 return
2750         }
2751         T, _, err = me.AddTorrentSpec(TorrentSpecFromMetaInfo(mi))
2752         return
2753 }
2754
2755 func (me *Client) DHT() *dht.Server {
2756         return me.dHT
2757 }