metainfo/metainfo.go

   1 package metainfo
   2
   3 import (
   4         "io"
   5         "net/url"
   6         "os"
   7         "time"
   8
   9         "github.com/anacrolix/torrent/bencode"
  10 )
  11
  12 type MetaInfo struct {
  13         InfoBytes    bencode.Bytes `bencode:"info,omitempty"`          // BEP 3
  14         Announce     string        `bencode:"announce,omitempty"`      // BEP 3
  15         AnnounceList AnnounceList  `bencode:"announce-list,omitempty"` // BEP 12
  16         Nodes        []Node        `bencode:"nodes,omitempty"`         // BEP 5
  17         // Where's this specified? Mentioned at
  18         // https://wiki.theory.org/index.php/BitTorrentSpecification: (optional) the creation time of
  19         // the torrent, in standard UNIX epoch format (integer, seconds since 1-Jan-1970 00:00:00 UTC)
  20         CreationDate int64   `bencode:"creation date,omitempty,ignore_unmarshal_type_error"`
  21         Comment      string  `bencode:"comment,omitempty"`
  22         CreatedBy    string  `bencode:"created by,omitempty"`
  23         Encoding     string  `bencode:"encoding,omitempty"`
  24         UrlList      UrlList `bencode:"url-list,omitempty"` // BEP 19 WebSeeds
  25 }
  26
  27 // Load a MetaInfo from an io.Reader. Returns a non-nil error in case of
  28 // failure.
  29 func Load(r io.Reader) (*MetaInfo, error) {
  30         var mi MetaInfo
  31         d := bencode.NewDecoder(r)
  32         err := d.Decode(&mi)
  33         if err != nil {
  34                 return nil, err
  35         }
  36         return &mi, nil
  37 }
  38
  39 // Convenience function for loading a MetaInfo from a file.
  40 func LoadFromFile(filename string) (*MetaInfo, error) {
  41         f, err := os.Open(filename)
  42         if err != nil {
  43                 return nil, err
  44         }
  45         defer f.Close()
  46         return Load(f)
  47 }
  48
  49 func (mi MetaInfo) UnmarshalInfo() (info Info, err error) {
  50         err = bencode.Unmarshal(mi.InfoBytes, &info)
  51         return
  52 }
  53
  54 func (mi MetaInfo) HashInfoBytes() (infoHash Hash) {
  55         return HashBytes(mi.InfoBytes)
  56 }
  57
  58 // Encode to bencoded form.
  59 func (mi MetaInfo) Write(w io.Writer) error {
  60         return bencode.NewEncoder(w).Encode(mi)
  61 }
  62
  63 // Set good default values in preparation for creating a new MetaInfo file.
  64 func (mi *MetaInfo) SetDefaults() {
  65         mi.CreatedBy = "github.com/anacrolix/torrent"
  66         mi.CreationDate = time.Now().Unix()
  67 }
  68
  69 // Creates a Magnet from a MetaInfo. Optional infohash and parsed info can be provided.
  70 func (mi MetaInfo) Magnet(infoHash *Hash, info *Info) (m Magnet) {
  71         m.Trackers = append(m.Trackers, mi.UpvertedAnnounceList().DistinctValues()...)
  72         if info != nil {
  73                 m.DisplayName = info.BestName()
  74         }
  75         if infoHash != nil {
  76                 m.InfoHash = *infoHash
  77         } else {
  78                 m.InfoHash = mi.HashInfoBytes()
  79         }
  80         m.Params = make(url.Values)
  81         m.Params["ws"] = mi.UrlList
  82         return
  83 }
  84
  85 // Returns the announce list converted from the old single announce field if
  86 // necessary.
  87 func (mi *MetaInfo) UpvertedAnnounceList() AnnounceList {
  88         if mi.AnnounceList.OverridesAnnounce(mi.Announce) {
  89                 return mi.AnnounceList
  90         }
  91         if mi.Announce != "" {
  92                 return [][]string{{mi.Announce}}
  93         }
  94         return nil
  95 }