odango/atama

The brain behind Odango.moe

頭 (Atama)

, _(*1)

Anime torrent title parsing and archiving, _(*2)

This package's only use is to parse anime torrent titles and archive them into TorrentSets, _(*3)

Install

composer require odango/atama

Metadata

The actual parsing of titles done with black magic, battle tested on the whole nyaa site. of course there may be some cases where it fails to parse correctly, please create an issue for those., _(*4)

$md = Metadata::createFromTitle("[HorribleSubs] Show By Rock!! S2 - 07 [720p].mkv");

echo $md["name"]; // Show By Rock!! S2
echo $md["group"]; // HorribleSubs
echo $md["type"]; // ep
echo $md["ep"]; // [7.0]
echo $md["resolution"]; // 720p

See metadate-title.json for more info., _(*5)

EP's are represented by an array with floats and/or letters (thank Re:Zero for that):, _(*6)

$md = Metadata::createFromTitle("[HorribleSubs] Re Zero kara Hajimeru Isekai Seikatsu - 01A [1080p].mkv");
$md["ep"]; // [1.0, "A"]
$md = Metadata::createFromTitle("[m.3.3.w] Hanasakeru Seishounen 12.5 (XviD) [89BACFB9].avi");
$md["ep"]; // [12.5]

The Metadata object is an ArrayObject and doesn't define any functions except it's constructors, _(*7)

Metadata::createFromTitle($title): Metadata

Create an Metadata object from a title by parsing all the info from the title, _(*8)

Metadata::createFromArray($array): Metadata

Create an Metadata object with the given array as properties, _(*9)

Archiver

Archives the torrents into the correct TorrentSet's can be done stateless (by using Archiver::archive) or with state, by creating the Archiver object, _(*10)

Archiver::archive(Torrent[] $torrents): TorrentSet[]

This function will archive given torrents in separate TorrentSet's and return those, as you would expect it., _(*11)

All HorribleSubs, Show By Rock!! S2, 720p will be in it's own set, while the 1080p torrents of those will be in a different set., _(*12)

Archiver->addTorrent(Torrent $torrent): bool

This will archive this torrent in the TorrentSet's currently in the archive., _(*13)

This will return true if it's added to a TorrentSet, false if a newer version or the same version already exists, _(*14)

Archiver->getSets(): TorrentSet[]

Get the TorrentSet's currently in the archive, _(*15)

TorrentSet

TorrentSet->addTorrent(Torrent $torrent): bool

This will try to add this torrent to this TorrentSet, _(*16)

This will return true if it's added to this TorrentSet, false if a newer version or the same version already exists, _(*17)

TorrentSet->getTorrents(): Torrent[]

Returns all the torrents in the TorrentSet, _(*18)

TorrentSet->getMetadata(): Metadata

Gets a Metadata object with the Metadata all torrents in the set have in common, _(*19)

Torrent

The Torrent object is pretty much made only to be extended and add more info about it, the current implementation just provides enough information to be used, _(*20)

Torrent->setTitle(string $title): void

Set the title of this torrent and update metadata accordingly, _(*21)

Torrent->getTitle(): string

Gets the title of this torrent, _(*22)

Torrent->getId(): string|int

Gets the id of this torrent, used as unique identifier in the hash for series, _(*23)

Torrent->getMetadata(): Metadata

Gets the metadata of this torrent parsed from the title, _(*24)

Torrent->getSeriesIdentifier(): string

Gets a unique string for in this series, e.g. for an series of EP's this would be the ep number. The id or a random number is used for specials, _(*25)

Torrent->getHash(): string

Gets a unique string for this torrent e.g. [HorribleSubs] Show By Rock!! S2 - 07 [720p].mkv would produce the hash Show By Rock!! S2/HorribleSubs/720p#7 be aware that different versions of torrents still produce the same hash e.g. [HorribleSubs] Show By Rock!! S2 - 07v2 [720p].mkv will also produce the hash Show By Rock!! S2/HorribleSubs/720p#7, _(*26)

Torrent->getSeriesHash(): string

Gets a unique string this torrent series e.g. [HorribleSubs] Show By Rock!! S2 - 07 [720p].mkv would produce the hash Show By Rock!! S2/HorribleSubs/720p, _(*27)