metainfo/metainfo.go

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