Skip to content

Latest commit

 

History

History
426 lines (273 loc) · 11 KB

CHANGELOG.md

File metadata and controls

426 lines (273 loc) · 11 KB
Raw

Changelog

5.x

5.3.1

Jul 29, 2024

  • Exception rework:
    • Invalid file creation options now throw DomainException
    • Setters throw UnexpectedValueException for invalid input
    • Invalid operations on infohash data now throw BadMethodCallException

5.3.0

Jul 20, 2024

  • Added createdBy and creationDate directly to the file creation
  • Removed useless dependency on psr/clock
    • Small BC break: if you used $clock param intended only for the development, it's now gone, please use $creationDate

5.2.2

Jan 31, 2024

  • Handle hexadecimal sha1 sums in V1 files [gl#5]

5.2.1

Dec 17, 2023

  • Fix: remove @internal mark from TorrentFile

5.2.0

Dec 17, 2023

  • Torrent signing (BEP-0035)
  • Update URL (BEP-0039)
  • Hidden attribute for files

5.1.0

Nov 10, 2023

  • Force multifile is now default for v1 torrent creation
  • Methods to "unhybridize" hybrid torrents (Note: infohash changes in this process)
    • TorrentFile::removeMetadata(MetaVersion)
    • TorrentFile::keepOnlyMetadata(MetaVersion)

5.0.3

Oct 22, 2023

  • Fix symlink handling in v2 torrents
  • Allow Symfony 7
  • nikic/iter dependency was bumped to 2.2 (the lowest with PHP 8.1 support)

5.0.2

Jul 14, 2023

  • No longer depends on league/uri-components

5.0.1

Jul 14, 2023

  • Creation timestamp is now tested by injecting psr/clock
  • Allow league/uri-components v7

5.0.0

Mar 1, 2023

Branched from 4.1.0

  • File listings for both versions 1 and 2 via version objects: $torrent->v1() and $torrent->v2()
    • getInfoHash() and isDirectory() moved to version objects
  • hasMetadata() to check what metadata versions are present
  • MetaVersion::HybridV1V2 is no longer a separate case but an alias for an array [MetaVersion::V1, MetaVersion::V2]

4.x

4.1.1

Dec 7, 2023

  • Backported magnet link code from 5.x to fix problem with invalid magnet links with latest version of league/uri-components
    • Dependency on league/uri-components dropped entirely
  • Symfony 7 is allowed

4.1.0

Feb 23, 2023

  • Adds forceMultifile option for v1 creation
  • Fixes probable v1/v2 compatibility issue in case name was edited by always creating v1 data in forceMultifile mode
    • Hybrid torrents will be generated with different infohashes for same paths

4.0.1

Dec 30, 2022

  • The library no longer provides sandfoxme/torrent-file

4.0.0

Dec 30, 2022

Branched from 3.2.0

  • New internal structure makes library more stable on malformed but valid-ish torrent files
    • In general both Bencode and Torrent File libs aim at save(load(file)) === file compatibility
  • Default constructor parameters on the data structures now accept variadic lists of elements instead of iterables
    • Default constructors are not recommended because their signatures are not considered stable. Named constructors should be used instead as explained in the documentation
  • Getters on Node and FileDataProgressEvent were removed
  • getRawData() now returns immutable ArrayAccess&Countable&Traversable objects instead of arrays
    • If you need a real array, use getRawData()->toArray()

3.x

3.3.1

Dec 7, 2023

  • Backported magnet link code from 5.x to fix problem with invalid magnet links with latest version of league/uri-components
    • Dependency on league/uri-components dropped entirely
  • Symfony 7 is allowed

3.3.0

Feb 23, 2023

  • Adds forceMultifile option for v1 creation
  • Fixes probable v1/v2 compatibility issue in case name was edited by always creating v1 data in forceMultifile mode
    • Hybrid torrents will be generated with different infohashes for same paths

3.2.0

Dec 30, 2022

  • The package was renamed to arokettu/torrent-file
  • The namespace was changed to Arokettu\Torrent\
    • Aliased all classes in Arokettu\Torrent\* to SandFox\Torrent\* for backward compatibility
    • Added aliases.php so the changes can be indexed by the IDEs
  • Old package sandfoxme/torrent-file is now provided by the new package
  • Deprecated getters on Node and FileDataProgressEvent

3.1.1

Dec 14, 2022

  • sandfoxme/bencode -> arokettu/bencode

3.1.0

Dec 2, 2021

  • Added version option
    • Creation of V2 torrents is now allowed (BEP-52)
  • New and changed methods to get info hash:
    • getInfoHash() will return V2 info hash if V2 metadata is present
    • New method getInfoHashV1() to get V1 hash explicitly
    • New method getInfoHashV2() to get V2 hash explicitly
    • New method getInfoHashes() to get all metadata hashes as array
  • Fixed detectExec option not having any effect

3.0.1

Dec 1, 2021

  • Node: getters were replaced with readonly properties. Getters are kept for now, but they will be deprecated in 3.2.
  • FileDataProgressEvent: getters were returned for smoother upgrade. They will be deprecated in 3.2.

3.0.0

Nov 30, 2021

branched from 2.2.0

  • PHP 8.1 is now required
  • In TorrentFile::forPath() options array is removed and replaced with named parameters
  • getCreationDate() now returns an instance of DateTimeImmutable
    • getCreationDateAsDateTime() and getCreationDateAsTimestamp() now trigger silent deprecations
  • getAnnounceList() now returns an instance of AnnounceList
    • getAnnounceListAsArray() and getAnnounceListAsObject() now trigger silent deprecations
  • FileDataProgressEvent: getters were replaced with readonly properties

2.x

2.5.2

Oct 21, 2023

  • Backported magnet link code from 5.x to fix problem with invalid magnet links with latest version of league/uri-components
    • Dependency on league/uri-components dropped entirely
  • Symfony 7 is allowed
    • This is the last purely dependency related update in the 2.x branch

2.5.1

Jul 14, 2023

  • Allow league/uri-components v7

2.5.0

Feb 23, 2023

  • Adds forceMultifile option for v1 creation
  • Fixes probable v1/v2 compatibility issue in case name was edited by always creating v1 data in forceMultifile mode
    • Hybrid torrents will be generated with different infohashes for same paths
  • Fixes deprecation warning in PHP 8.1+

2.4.0

Dec 30, 2022

  • Alias all classes in SandFox\Torrent\* to Arokettu\Torrent\* in preparation for 4.0
  • Old package sandfoxme/torrent-file is now provided by the new package

2.3.1

Dec 14, 2022

  • sandfoxme/bencode -> arokettu/bencode

2.3.0

Dec 2, 2021

  • Added version option
    • Creation of V2 torrents is now allowed (BEP-52)
  • New and changed methods to get info hash:
    • getInfoHash() will return V2 info hash if V2 metadata is present
    • New method getInfoHashV1() to get V1 hash explicitly
    • New method getInfoHashV2() to get V2 hash explicitly
    • New method getInfoHashes() to get all metadata hashes as array
  • Fixed detectExec option not having any effect

2.2.0

Nov 30, 2021

  • Fixed possible announce list corruption if deduplication of trackers happened
  • Fixed null handling on announce and created by
  • getRawData() now always returns the representation as it would appear in the saved file
  • TorrentFile now serializes in cross version compatible manner
  • Added 2 temporary methods: getCreationDateAsDateTime() and getCreationDateAsTimestamp() to simplify future migration to 3.x. In 3.x getCreationDate() will return DateTimeImmutable instead of int
  • Added 2 temporary methods: getAnnounceListAsArray() and getAnnounceListAsObject() to simplify future migration to 3.x. In 3.x getAnnounceList() will return AnnounceList instead of string[][]
  • Added support for nodes field (BEP-5)
  • Added support for httpseeds field (BEP-17)
  • Added support for url-list field (BEP-19)
  • Added setName() and getName()
  • Added isDirectory()
  • sortFiles option is deprecated and no longer has any effect. Files are always sorted now (BEP-52 compatibility)
  • pieceLength option is validated to be pow of 2 and at least 16 KiB (BEP-52 compatibility)
  • md5sum option is deprecated and no longer has any effect
  • sha1 sums for all files are now generated (BEP-47)
  • The library now detects executable files and sets the attribute (BEP-47)
    • Enabled by default. Set the new option detectExec to false to disable it
  • The library now detects symlinks (BEP-47)
    • Disabled by default. Set the new option detectSymlinks to true to enable it
  • The library now allows aligning files to piece boundaries (BEP-47)
    • Disabled by default. Set the new option pieceAlign to true or minimum bytes value to enable it

2.1.2

Sep 25, 2021

  • Allow bencode 3.0, bump requirements to bencode 1.7+/2.7+/3.0+

2.1.1

Feb 25, 2021

  • Fixed deprecated behavior not removed in 2.0.0: TorrentFile::__construct() is now private

2.1.0

Feb 19, 2021

  • Add Stream API from Bencode 1.5/2.5
  • Add big integer support from Bencode 1.6/2.6

2.0.0

Nov 17, 2020

Branched from 1.3.1

  • Bump PHP requirement to PHP 7.4
  • Replace FileDataProgress with Event Dispatcher (PSR-14) + FileDataProgressEvent
  • 100% test coverage

1.x

1.4.2

Dec 7, 2023

  • Drop dependency on league/uri-components entirely
  • Allow Symfony 7
  • Allow PHP 7.1 again

1.4.1

Feb 23, 2023

  • Drops PHP 7.1
  • Drops dependency on arokettu/query-string-proxy

1.4.0

Dec 30, 2022

  • Alias all classes in SandFox\Torrent\* to Arokettu\Torrent\* in preparation for 4.0
  • Old package sandfoxme/torrent-file is now provided by the new package

1.3.2

Dec 14, 2022

  • sandfoxme/bencode -> arokettu/bencode

1.3.1

Nov 9, 2020

  • Use saner url encoder for getMagnetLink()
  • Bump PHP requirement from 7.1.0 to 7.1.3 to match dependencies

1.3.0

Nov 9, 2020

  • Add getDisplayName()
  • Add getFileName()
  • Add getMagnetLink()
  • Filter announce list from duplicates

1.2.0

Oct 29, 2020

  • Add saving and loading torrent from bencoded string
  • Deprecate direct use of TorrentFile constructor
  • Clean up internal data structure to avoid potentially invalid torrent file
  • Make library work in PHP strict mode
  • Allow unsetting comment
  • Fix Announce List behavior so it allows an arbitrary composition for groups

1.1.1

Oct 29, 2020

1.1.0

Oct 6, 2020

  • Expose options array to fromFile() call
  • Fix getAnnounceList() is broken after setAnnounceList() is used

1.0.2

Oct 6, 2020

  • Fix torrent creation
  • Fix info hash calculation

1.0.1

Jul 21, 2020

  • Allow bencode v2 and Symfony v5

1.0.0

Apr 19, 2019

  • Force announce list to be List
  • Remove encoding field
  • Release as 1.0.0 because it is quite stable

0.x

0.1.1

Nov 6, 2017

  • Update Symfony dependencies to allow Symfony 4

0.1.0

Mar 30, 2017

Initial release

  • Basic work with torrent files