Data.Torrent

Torrent file contains metadata about files and folders but not content itself. The files are bencoded dictionaries. There is also other info which is used to help join the swarm.

This module provides torrent metainfo serialization and info hash extraction.

For more info see: http://www.bittorrent.org/beps/bep_0003.html#metainfo-files, https://wiki.theory.org/BitTorrentSpecification#Metainfo_File_Structure

Info dictionary

data InfoDict

Info part of the .torrent file contain info about each content file.

Constructors

InfoDict

Fields

idInfoHash :: !InfoHash

SHA1 hash of the (other) DictInfo fields.

idLayoutInfo :: !LayoutInfo

idPieceInfo :: !PieceInfo

idPrivate :: !Bool

If set the client MUST publish its presence to get other peers ONLY via the trackers explicity described in the metainfo file.

BEP 27: http://www.bittorrent.org/beps/bep_0027.html

Instances

Eq InfoDict

Read InfoDict

Show InfoDict

Typeable InfoDict

ToJSON InfoDict

FromJSON InfoDict

NFData InfoDict

Hashable.Hashable InfoDict

Pretty InfoDict

BEncode InfoDict

infoDictionary :: LayoutInfo -> PieceInfo -> Bool -> InfoDict

Smart constructor: add a info hash to info dictionary.

Lenses

infohash :: Lens' InfoDict InfoHash

layoutInfo :: Lens' InfoDict LayoutInfo

pieceInfo :: Lens' InfoDict PieceInfo

isPrivate :: Lens' InfoDict Bool

Torrent file

data Torrent

Metainfo about particular torrent.

Constructors

Torrent

Fields

tAnnounce :: !URI

The URL of the tracker.

tAnnounceList :: !(Maybe [[URI]])

Announce list add multiple tracker support.

BEP 12: http://www.bittorrent.org/beps/bep_0012.html

tComment :: !(Maybe Text)

Free-form comments of the author.

tCreatedBy :: !(Maybe Text)

Name and version of the program used to create the .torrent.

tCreationDate :: !(Maybe POSIXTime)

Creation time of the torrent, in standard UNIX epoch.

tEncoding :: !(Maybe Text)

String encoding format used to generate the pieces part of the info dictionary in the .torrent metafile.

tInfoDict :: !InfoDict

Info about each content file.

tPublisher :: !(Maybe URI)

Containing the RSA public key of the publisher of the torrent. Private counterpart of this key that has the authority to allow new peers onto the swarm.

tPublisherURL :: !(Maybe URI)

tSignature :: !(Maybe BS.ByteString)

The RSA signature of the info dictionary (specifically, the encrypted SHA-1 hash of the info dictionary).

Instances

Eq Torrent

Show Torrent

Typeable Torrent

ToJSON Torrent

FromJSON Torrent

NFData Torrent

Pretty Torrent

BEncode Torrent

Lenses

announce :: Lens' Torrent URI

announceList :: Lens' Torrent (Maybe [[URI]])

comment :: Lens' Torrent (Maybe Text)

createdBy :: Lens' Torrent (Maybe Text)

creationDate :: Lens' Torrent (Maybe POSIXTime)

encoding :: Lens' Torrent (Maybe Text)

infoDict :: Lens' Torrent InfoDict

publisher :: Lens' Torrent (Maybe URI)

publisherURL :: Lens' Torrent (Maybe URI)

signature :: Lens' Torrent (Maybe BS.ByteString)

Construction

nullTorrent :: URI -> InfoDict -> Torrent

A simple torrent contains only required fields.

Mime types

typeTorrent :: BS.ByteString

Mime type of torrent files.

File paths

torrentExt :: String

Extension usually used for torrent files.

isTorrentPath :: FilePath -> Bool

Test if this path has proper extension.

IO

fromFile :: FilePath -> IO Torrent

Read and decode a .torrent file.

toFile :: FilePath -> Torrent -> IO ()

Encode and write a .torrent file.