// Copyright 2014 The Chihaya Authors. All rights reserved. // Use of this source code is governed by the BSD 2-Clause license, // which can be found in the LICENSE file. // Package models implements the models for an abstraction over the // multiple data stores used by a BitTorrent tracker. package models import ( "errors" "net" "net/http" "strconv" "time" "github.com/chihaya/chihaya/config" "github.com/chihaya/chihaya/models/query" "github.com/julienschmidt/httprouter" ) var ( // ErrMalformedRequest is returned when an http.Request does no have the // required parameters to create a model. ErrMalformedRequest = errors.New("malformed request") ) // Peer is a participant in a swarm. type Peer struct { ID string `json:"id"` UserID uint64 `json:"user_id"` TorrentID uint64 `json:"torrent_id"` IP net.IP `json:"ip"` Port uint64 `json:"port"` Uploaded uint64 `json:"uploaded"` Downloaded uint64 `json:"downloaded"` Left uint64 `json:"left"` LastAnnounce int64 `json:"last_announce"` } // NewPeer returns the Peer representation of an Announce. When provided nil // for the announce parameter, it panics. When provided nil for the user or // torrent parameter, it returns a Peer{UserID: 0} or Peer{TorrentID: 0} // respectively. func NewPeer(a *Announce, u *User, t *Torrent) *Peer { if a == nil { panic("models: announce cannot equal nil") } var userID uint64 if u != nil { userID = u.ID } var torrentID uint64 if t != nil { torrentID = t.ID } return &Peer{ ID: a.PeerID, UserID: userID, TorrentID: torrentID, IP: a.IP, Port: a.Port, Uploaded: a.Uploaded, Downloaded: a.Downloaded, Left: a.Left, LastAnnounce: time.Now().Unix(), } } // Key returns the unique key used to look-up a peer in a swarm (i.e // Torrent.Seeders & Torrent.Leechers). func (p Peer) Key() string { return p.ID + ":" + strconv.FormatUint(p.UserID, 36) } // Torrent is a swarm for a given torrent file. type Torrent struct { ID uint64 `json:"id"` Infohash string `json:"infohash"` Active bool `json:"active"` Seeders map[string]Peer `json:"seeders"` Leechers map[string]Peer `json:"leechers"` Snatches uint64 `json:"snatches"` UpMultiplier float64 `json:"up_multiplier"` DownMultiplier float64 `json:"down_multiplier"` LastAction int64 `json:"last_action"` } // InSeederPool returns true if a peer is within a Torrent's pool of seeders. func (t *Torrent) InSeederPool(p *Peer) (exists bool) { _, exists = t.Seeders[p.Key()] return } // InLeecherPool returns true if a peer is within a Torrent's pool of leechers. func (t *Torrent) InLeecherPool(p *Peer) (exists bool) { _, exists = t.Leechers[p.Key()] return } // User is a registered user for private trackers. type User struct { ID uint64 `json:"id"` Passkey string `json:"passkey"` UpMultiplier float64 `json:"up_multiplier"` DownMultiplier float64 `json:"down_multiplier"` Snatches uint64 `json:"snatches"` } // Announce is an Announce by a Peer. type Announce struct { Config *config.Config `json:"config"` Request *http.Request `json:"request"` Compact bool `json:"compact"` Downloaded uint64 `json:"downloaded"` Event string `json:"event"` IP net.IP `json:"ip"` Infohash string `json:"infohash"` Left uint64 `json:"left"` NumWant int `json:"numwant"` Passkey string `json:"passkey"` PeerID string `json:"peer_id"` Port uint64 `json:"port"` Uploaded uint64 `json:"uploaded"` } // NewAnnounce parses an HTTP request and generates an Announce. func NewAnnounce(cfg *config.Config, r *http.Request, p httprouter.Params) (*Announce, error) { q, err := query.New(r.URL.RawQuery) if err != nil { return nil, err } compact := q.Params["compact"] != "0" event, _ := q.Params["event"] infohash, _ := q.Params["info_hash"] peerID, _ := q.Params["peer_id"] numWant := q.RequestedPeerCount(cfg.NumWantFallback) ip, ipErr := q.RequestedIP(r) port, portErr := q.Uint64("port") left, leftErr := q.Uint64("left") downloaded, downloadedErr := q.Uint64("downloaded") uploaded, uploadedErr := q.Uint64("uploaded") if downloadedErr != nil || infohash == "" || leftErr != nil || peerID == "" || portErr != nil || uploadedErr != nil || ipErr != nil { return nil, ErrMalformedRequest } return &Announce{ Config: cfg, Request: r, Compact: compact, Downloaded: downloaded, Event: event, IP: ip, Infohash: infohash, Left: left, NumWant: numWant, Passkey: p.ByName("passkey"), PeerID: peerID, Port: port, Uploaded: uploaded, }, nil } // ClientID returns the part of a PeerID that identifies a Peer's client // software. func (a Announce) ClientID() (clientID string) { length := len(a.PeerID) if length >= 6 { if a.PeerID[0] == '-' { if length >= 7 { clientID = a.PeerID[1:7] } } else { clientID = a.PeerID[0:6] } } return } // AnnounceDelta contains the changes to a Peer's state. These changes are // recorded by the backend driver. type AnnounceDelta struct { Peer *Peer Torrent *Torrent User *User // Created is true if this announce created a new peer or changed an existing // peer's address Created bool // Snatched is true if this announce completed the download Snatched bool // Uploaded contains the raw upload delta for this announce, in bytes Uploaded uint64 // Downloaded contains the raw download delta for this announce, in bytes Downloaded uint64 } // NewAnnounceDelta calculates a Peer's download and upload deltas between // Announces and generates an AnnounceDelta. func NewAnnounceDelta(a *Announce, p *Peer, u *User, t *Torrent, created, snatched bool) *AnnounceDelta { var ( rawDeltaUp = p.Uploaded - a.Uploaded rawDeltaDown uint64 ) if !a.Config.Freeleech { rawDeltaDown = p.Downloaded - a.Downloaded } // Restarting a torrent may cause a delta to be negative. if rawDeltaUp < 0 { rawDeltaUp = 0 } if rawDeltaDown < 0 { rawDeltaDown = 0 } return &AnnounceDelta{ Peer: p, Torrent: t, User: u, Created: created, Snatched: snatched, Uploaded: uint64(float64(rawDeltaUp) * u.UpMultiplier * t.UpMultiplier), Downloaded: uint64(float64(rawDeltaDown) * u.DownMultiplier * t.DownMultiplier), } } // Scrape is a Scrape by a Peer. type Scrape struct { Config *config.Config `json:"config"` Request *http.Request `json:"request"` Passkey string Infohashes []string } // NewScrape parses an HTTP request and generates a Scrape. func NewScrape(cfg *config.Config, r *http.Request, p httprouter.Params) (*Scrape, error) { q, err := query.New(r.URL.RawQuery) if err != nil { return nil, err } if q.Infohashes == nil { if _, exists := q.Params["infohash"]; !exists { // There aren't any infohashes. return nil, ErrMalformedRequest } q.Infohashes = []string{q.Params["infohash"]} } return &Scrape{ Config: cfg, Request: r, Passkey: p.ByName("passkey"), Infohashes: q.Infohashes, }, nil }