remove unnecessary devDependency

Fix infinite loop when dict value is int 0

.github/workflows/test.yml

@@ -0,0 +1,46 @@
+name: Test
+
+on:
+  push:
+    branches: [ '*' ]
+  pull_request:
+    branches: [ '*' ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        php-version: ['7.2', '7.3', '7.4']
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - uses: shivammathur/setup-php@v2
+      with:
+        php-version: ${{ matrix.php-version }}
+        tools: composer, pecl
+        coverage: pcov
+
+    - name: Validate composer.json and composer.lock
+      run: composer validate
+
+    - name: Cache Composer packages
+      id: composer-cache
+      uses: actions/cache@v2
+      with:
+        path: vendor
+        key: ${{ runner.os }}-${{ matrix.php-version }}-composer-${{ hashFiles('**/composer.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-${{ matrix.php-version }}-composer-
+          ${{ runner.os }}-composer-
+    - name: Install dependencies
+      if: steps.composer-cache.outputs.cache-hit != 'true'
+      run: composer install --prefer-dist --no-progress --no-suggest
+
+    - run: composer lint
+
+    - run: composer stan
+
+    - run: composer test

.gitignore

@@ -3,3 +3,4 @@ report/
 vendor/
 .DS_Store
 composer.lock
+.phpunit.result.cache

.travis.yml

@@ -1,19 +0,0 @@
-language: php
-sudo: true
-dist: trusty
-
-php:
-  - '7.0'
-  - '7.1'
-  - '7.2'
-
-cache:
-  directories:
-    - $HOME/.composer/cache
-
-install:
-  - composer install
-
-script:
-  - vendor/bin/phpunit
-  - vendor/bin/phpcs src -s

README.md

@@ -1,8 +1,25 @@
 BEncode Torrent
 ===============
 
-PHP library for encoding and decoding BitTorrent BEncode data, focused around 
-[Gazelle](https://github.com/ApolloRIP/Gazelle).
+[![Test](https://github.com/OPSnet/bencode-torrent/workflows/Test/badge.svg?branch=master&event=push)](https://github.com/OPSnet/bencode-torrent/actions?query=workflow%3ATest+branch%3Amaster+event%3Apush)
+[![Packagist](https://img.shields.io/packagist/v/orpheusnet/bencode-torrent.svg)](https://packagist.org/packages/orpheusnet/bencode-torrent)
+![Packagist PHP Version Support](https://img.shields.io/packagist/php-v/orpheusnet/bencode-torrent)
+
+PHP library for encoding and decoding BitTorrent BEncode data, focused around usage within
+[Gazelle](https://github.com/OPSnet/Gazelle).
+
+Usage
+-----
+`composer require orpheusnet/bencode-torrent`
+
+```php
+use OrpheusNET\BencodeTorrent;
+$bencode = new Bencode();
+$bencode->decodeFile('path/to/file.torrent');
+```
+
+Description
+-----------
 
 BEncode is the encoding used by BitTorrent to store and transmitting loosely structured data. It supports
 * byte strings
@@ -23,7 +40,7 @@ As such, this library will make some checks when loading data that these mandato
 raised. More information on these fields can be found at 
 [BitTorrentSpecification#Metainfo_File_Structure](https://wiki.theory.org/index.php/BitTorrentSpecification#Metainfo_File_Structure).
 
-Finally, this library is primarily aimed at being used within the [Gazelle](https://github.com/ApolloRIP/Gazelle) so
+Finally, this library is primarily aimed at being used within the [Gazelle](https://github.com/OPSnet/Gazelle) so
 we have some utility functions within the library that make sense there to accomplish the following things:
 * Ensuring torrent files are marked as 'private'
 * Setting a 'source' on torrents (to ensure unique info hash)
@@ -32,5 +49,5 @@ we have some utility functions within the library that make sense there to accom
 
 This is based (loosely) off the code in the two separate BEncode libraries within WCD's Gazelle 
 ([bencodetorrent.class.php](https://github.com/WhatCD/Gazelle/blob/master/classes/bencodetorrent.class.php) and 
-[torrent.class.php](https://github.com/WhatCD/Gazelle/blob/master/classes/torrent.class.php)), but without the
-necessary 32bit shims as well as make it a unified library used for both uploading and downloading the torrent files.
+[torrent.class.php](https://github.com/WhatCD/Gazelle/blob/master/classes/torrent.class.php)), but without the now
+unnecessary 32bit shims as well as making it a unified library used for both uploading and downloading the torrent files.

composer.json

@@ -1,24 +1,31 @@
 {
     "type": "library",
-    "name": "apollorip/bencode-torrent",
+    "name": "orpheusnet/bencode-torrent",
     "description": "PHP Library for decoding and encoding BitTorrent BEncoded data, built for Gazelle",
     "license": "Unlicense",
     "authors": [
         {
-            "name": "itismadness",
-            "email": "[email protected]"
+            "name": "Orpheus",
+            "email": "[email protected]"
         }
     ],
     "autoload": {
         "psr-4": {
-            "ApolloRIP\\BencodeTorrent\\": "src/"
+            "OrpheusNET\\BencodeTorrent\\": "src/"
         }
     },
-    "require": {},
+    "require": {
+        "php": "^7.2"
+    },
     "require-dev": {
-        "phpunit/phpunit": "^6",
+        "phpunit/phpunit": "^8",
         "squizlabs/php_codesniffer": "3.*",
-        "php": "^7",
-        "ext-mbstring": "^7"
+        "phpstan/phpstan": "^0.12.48"
+    },
+    "scripts": {
+        "test": "phpunit",
+        "lint": "phpcs",
+        "lint:fix": "phpcbf",
+        "stan": "phpstan analyse"
     }
 }

phpcs.xml

@@ -1,38 +1,7 @@
 <?xml version="1.0"?>
-<ruleset name="Gazelle Standard">
-    <description>The coding standard for the Gazelle project</description>
+<ruleset name="PSR12 Standard">
+    <file>src</file>
+    <file>tests</file>
 
-    <!-- Include the whole PSR-1 standard -->
-    <rule ref="PSR1"/>
-    <!-- Include the whole PSR-2 standard -->
-    <rule ref="PSR2">
-        <exclude name="PSR2.Classes.ClassDeclaration.OpenBraceNewLine"/>
-    </rule>
-
-    <!-- Do not allow trailing whitespace at the end of lines -->
-    <rule ref="Squiz.WhiteSpace.SuperfluousWhitespace" />
-    <rule ref="Squiz.Functions.MultiLineFunctionDeclaration.BraceOnSameLine">
-        <severity>0</severity>
-    </rule>
-    <rule ref="Squiz.ControlStructures.ControlSignature.SpaceAfterCloseBrace">
-        <severity>0</severity>
-    </rule>
-
-    <rule ref="Generic.Classes.OpeningBraceSameLine"/>
-    <rule ref="Generic.Functions.OpeningFunctionBraceKernighanRitchie"/>
-
-    <!-- Ensure that proper line endings are used -->
-    <rule ref="Generic.Files.LineEndings">
-        <properties>
-            <property name="eolChar" value="\n"/>
-        </properties>
-    </rule>
-
-    <!-- Increase PHPCS/PEAR limit of 85 chars per line to 100 -->
-    <rule ref="Generic.Files.LineLength">
-        <properties>
-            <property name="lineLimit" value="100"/>
-            <property name="absoluteLineLimit" value="0"/>
-        </properties>
-    </rule>
-</ruleset>
+    <rule ref="PSR12" />
+</ruleset>

phpstan.neon

@@ -0,0 +1,5 @@
+parameters:
+	level: 5
+	paths:
+		- src
+		- tests

src/Bencode.php

@@ -0,0 +1,180 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OrpheusNET\BencodeTorrent;
+
+class Bencode
+{
+    /** @var array */
+    protected $data;
+
+    /**
+     * Sets the internal data array
+     * @param mixed $data
+     */
+    public function setData($data)
+    {
+        $this->data = $data;
+    }
+
+    /**
+     * Given a BEncoded string and decode it
+     * @param string $data
+     * @throws \RuntimeException
+     */
+    public function decodeString(string $data)
+    {
+        $this->data = $this->decode($data);
+    }
+
+    /**
+     * Given a path to a file, decode the contents of it
+     *
+     * @param string $path
+     * @throws \RuntimeException
+     */
+    public function decodeFile(string $path)
+    {
+        $this->data = $this->decode(file_get_contents($path));
+    }
+
+    /**
+     * Decodes a BEncoded string to the following values:
+     * - Dictionary (starts with d, ends with e)
+     * - List (starts with l, ends with e
+     * - Integer (starts with i, ends with e
+     * - String (starts with number denoting number of characters followed by : and then the string)
+     *
+     * @see https://wiki.theory.org/index.php/BitTorrentSpecification
+     *
+     * @param string $data
+     * @param int    $pos
+     * @return mixed
+     */
+    protected function decode(string $data, int &$pos = 0)
+    {
+        $start_decode = $pos === 0;
+        if ($data[$pos] === 'd') {
+            $pos++;
+            $return = [];
+            while ($data[$pos] !== 'e') {
+                $key = $this->decode($data, $pos);
+                $value = $this->decode($data, $pos);
+                if ($key === null || $value === null) {
+                    break;
+                }
+                if (!is_string($key)) {
+                    throw new \RuntimeException('Invalid key type, must be string: ' . gettype($key));
+                }
+                $return[$key] = $value;
+            }
+            ksort($return);
+            $pos++;
+        } elseif ($data[$pos] === 'l') {
+            $pos++;
+            $return = [];
+            while ($data[$pos] !== 'e') {
+                $value = $this->decode($data, $pos);
+                $return[] = $value;
+            }
+            $pos++;
+        } elseif ($data[$pos] === 'i') {
+            $pos++;
+            $digits = strpos($data, 'e', $pos) - $pos;
+            $return = substr($data, $pos, $digits);
+            if ($return === '-0') {
+                throw new \RuntimeException('Cannot have integer value -0');
+            }
+            $multiplier = 1;
+            if ($return[0] === '-') {
+                $multiplier = -1;
+                $return = substr($return, 1);
+            }
+            if (!ctype_digit($return)) {
+                $msg = 'Cannot have non-digit values in integer number: ' . $return;
+                throw new \RuntimeException($msg);
+            }
+            $return = $multiplier * ((int) $return);
+            $pos += $digits + 1;
+        } else {
+            $digits = strpos($data, ':', $pos) - $pos;
+            $len = (int) substr($data, $pos, $digits);
+            $pos += ($digits + 1);
+            $return = substr($data, $pos, $len);
+            $pos += $len;
+        }
+        if ($start_decode) {
+            if ($pos !== strlen($data)) {
+                throw new \RuntimeException('Could not fully decode bencode string');
+            }
+        }
+        return $return;
+    }
+
+    /**
+     * Get the internal data array
+     * @return mixed
+     */
+    public function getData()
+    {
+        return $this->data;
+    }
+
+    /**
+     * @throws \RuntimeException
+     */
+    protected function hasData()
+    {
+        if ($this->data === null) {
+            throw new \RuntimeException('Must decode proper bencode string first');
+        }
+    }
+
+    /**
+     * @return string
+     */
+    public function getEncode(): string
+    {
+        $this->hasData();
+        return $this->encodeVal($this->data);
+    }
+
+    /**
+     * @param mixed $data
+     * @return string
+     */
+    protected function encodeVal($data): string
+    {
+        if (is_array($data)) {
+            $return = '';
+            $check = -1;
+            $list = true;
+            foreach ($data as $key => $value) {
+                if ($key !== ++$check) {
+                    $list = false;
+                    break;
+                }
+            }
+
+            if ($list) {
+                $return .= 'l';
+                foreach ($data as $value) {
+                    $return .= $this->encodeVal($value);
+                }
+            } else {
+                $return .= 'd';
+                foreach ($data as $key => $value) {
+                    $return .= $this->encodeVal(strval($key));
+                    $return .= $this->encodeVal($value);
+                }
+            }
+            $return .= 'e';
+        } elseif (is_integer($data)) {
+            $return = 'i' . $data . 'e';
+        } else {
+            $return = strlen($data) . ':' . $data;
+        }
+        return $return;
+    }
+}

src/BencodeTorrent.php

@@ -1,6 +1,8 @@
 <?php
 
-namespace ApolloRip\BencodeTorrent;
+declare(strict_types=1);
+
+namespace OrpheusNET\BencodeTorrent;
 
 /**
  * BEncode service that allows us to encode PHP objects into BEncode and decode
@@ -24,13 +26,14 @@ namespace ApolloRip\BencodeTorrent;
  * For Gazelle, this also acts as a unification of the two original BEncode implementations
  * which were both used in separate areas of the codebase.
  */
-class BencodeTorrent {
-    const FILELIST_DELIM = 0xF7;
+class BencodeTorrent extends Bencode
+{
+    public const FILELIST_DELIM = 0xF7;
+    /** @var string */
     private static $utf8_filelist_delim = null;
 
-    private $data;
-
-    public function __construct() {
+    public function __construct()
+    {
         $this->setDelim();
     }
 
@@ -39,151 +42,75 @@ class BencodeTorrent {
      * and char to set a class constant or variable, so we wait till the class is initialized
      * for the first time to set it.
      */
-    private function setDelim() {
+    private function setDelim(): void
+    {
         if (self::$utf8_filelist_delim === null) {
             self::$utf8_filelist_delim = utf8_encode(chr(self::FILELIST_DELIM));
         }
     }
 
     /**
+     * Sets the internal data array
      * @param array $data
-     * @throws \Exception
-     */
-    public function setData($data) {
-        $this->data = $data;
-        $this->validate();
-    }
-
-    /**
-     * @param string $data
-     * @throws \Exception
-     */
-    public function decodeData(string $data) {
-        $this->data = $this->decode($data);
-        $this->validate();
-    }
-
-    /**
-     * @param string $path
-     * @throws \Exception
-     */
-    public function decodeFile(string $path) {
-        $this->data = $this->decode(file_get_contents($path, FILE_BINARY));
-        $this->validate();
-    }
-
-    /**
-     * @param string $data
-     * @param int    $pos
-     * @return array|bool|float|string
-     */
-    private function decode(string $data, int &$pos = 0) {
-        if ($data[$pos] === 'd') {
-            $pos++;
-            $return = [];
-            while ($data[$pos] !== 'e') {
-                $key = $this->decode($data, $pos);
-                $value = $this->decode($data, $pos);
-                if (empty($key) || empty($value)) {
-                    break;
-                }
-                $return[$key] = $value;
-            }
-            $pos++;
-        }
-        elseif ($data[$pos] === 'l') {
-            $pos++;
-            $return = [];
-            while ($data[$pos] !== 'e') {
-                $value = $this->decode($data, $pos);
-                $return[] = $value;
-            }
-            $pos++;
-        }
-        elseif ($data[$pos] === 'i') {
-            $pos++;
-            $digits = strpos($data, 'e', $pos) - $pos;
-            $return = (int) substr($data, $pos, $digits);
-            $pos += $digits + 1;
-        }
-        else {
-            $digits = strpos($data, ':', $pos) - $pos;
-            $len = (int) substr($data, $pos, $digits);
-            $pos += ($digits + 1);
-            $return = substr($data, $pos, $len);
-            $pos += $len;
-        }
-        return $return;
-    }
-
-    public function getData() {
-        return $this->data;
-    }
-
-    /**
-     * @throws \Exception
-     */
-    public function validate() {
-        if (empty($this->data['info'])) {
-            throw new \Exception("Torrent dictionary doesn't have info key");
-        }
-    }
-
-    /**
      * @throws \RuntimeException
      */
-    private function hasData() {
-        if (empty($this->data) || !is_array($this->data)) {
-            throw new \RuntimeException('Must decode proper bencode string first');
-        }
+    public function setData($data): void
+    {
+        parent::setData($data);
+        $this->validate();
     }
 
     /**
-     * @return string
+     * Given a BEncoded string and decode it
+     * @param string $data
+     * @throws \RuntimeException
      */
-    public function getEncode() {
-        $this->hasData();
-        return $this->encodeVal($this->data);
+    public function decodeString(string $data): void
+    {
+        parent::decodeString($data);
+        $this->validate();
     }
 
     /**
-     * @param mixed $data
-     * @return string
+     * Given a path to a file, decode the contents of it
+     *
+     * @param string $path
+     * @throws \RuntimeException
      */
-    private function encodeVal($data) {
-        if (is_array($data)) {
-            $return = '';
-            $check = -1;
-            $list = true;
-            foreach ($data as $key => $value) {
-                if ($key !== ++$check) {
-                    $list = false;
-                    break;
-                }
-            }
+    public function decodeFile(string $path): void
+    {
+        parent::decodeFile($path);
+        $this->validate();
+    }
 
-            if ($list) {
-                $return .= 'l';
-                foreach ($data as $value) {
-                    $return .= $this->encodeVal($value);
+    /**
+     * Validates that the internal data array
+     * @throws \TypeError|\RuntimeException
+     */
+    public function validate(): void
+    {
+        if (!is_array($this->data)) {
+            throw new \TypeError('Data must be an array');
+        }
+        if (empty($this->data['info'])) {
+            throw new \RuntimeException("Torrent dictionary doesn't have info key");
+        }
+        if (isset($this->data['info']['files'])) {
+            foreach ($this->data['info']['files'] as $file) {
+                $path_key = isset($file['path.utf-8']) ? 'path.utf-8' : 'path';
+                if (isset($file[$path_key])) {
+                    $filter = array_filter(
+                        $file[$path_key],
+                        function ($element) {
+                            return strlen($element) === 0;
+                        }
+                    );
+                    if (count($filter) > 0) {
+                        throw new \RuntimeException('Cannot have empty path for a file');
+                    }
                 }
             }
-            else {
-                $return .= 'd';
-                foreach ($data as $key => $value) {
-                    $return .= $this->encodeVal(strval($key));
-                    $return .= $this->encodeVal($value);
-                }
-            }
-            $return .= 'e';
         }
-        elseif (is_integer($data)) {
-            $return = 'i'.$data.'e';
-        }
-        else {
-            $return = strlen($data) . ':' . $data;
-        }
-        return $return;
     }
 
     /**
@@ -194,7 +121,8 @@ class BencodeTorrent {
      *
      * @return bool flag to indicate if we altered the info dictionary
      */
-    public function clean() {
+    public function clean(): bool
+    {
         $this->cleanDataDictionary();
         return $this->cleanInfoDictionary();
     }
@@ -204,11 +132,12 @@ class BencodeTorrent {
      * overwritten dynamically on any downloaded torrent (like announce or comment), so that we
      * store the smallest encoded string within the database and cuts down on potential waste.
      */
-    public function cleanDataDictionary() {
+    public function cleanDataDictionary(): void
+    {
         $allowed_keys = array('encoding', 'info');
-        foreach ($this->data['info'] as $key => $value) {
+        foreach ($this->data as $key => $value) {
             if (!in_array($key, $allowed_keys)) {
-                unset($this->data['info'][$key]);
+                unset($this->data[$key]);
             }
         }
     }
@@ -227,7 +156,8 @@ class BencodeTorrent {
      *
      * @return bool
      */
-    public function cleanInfoDictionary() {
+    public function cleanInfoDictionary(): bool
+    {
         $cleaned = false;
         $allowed_keys = array('files', 'name', 'piece length', 'pieces', 'private', 'length',
                               'name.utf8', 'name.utf-8', 'md5sum', 'sha1', 'source',
@@ -247,7 +177,8 @@ class BencodeTorrent {
      *
      * @return bool
      */
-    public function isPrivate() {
+    public function isPrivate(): bool
+    {
         $this->hasData();
         return isset($this->data['info']['private']) && $this->data['info']['private'] === 1;
     }
@@ -261,7 +192,8 @@ class BencodeTorrent {
      *
      * @return bool
      */
-    public function makePrivate() {
+    public function makePrivate(): bool
+    {
         $this->hasData();
         if ($this->isPrivate()) {
             return false;
@@ -282,58 +214,56 @@ class BencodeTorrent {
      *
      * @return bool true if the source was set/changed, false if no change
      */
-    public function setSource(string $source) {
+    public function setSource(string $source): bool
+    {
         $this->hasData();
         if (isset($this->data['info']['source']) && $this->data['info']['source'] === $source) {
             return false;
         }
-        // Set we've set the source and will require a download, we might as well clean
+        // Since we've set the source and will require a re-download, we might as well clean
         // these out as well
         unset($this->data['info']['x_cross_seed']);
         unset($this->data['info']['unique']);
-        $this->data['info']['source'] = $source;
-        ksort($this->data['info']);
+        $this->setValue(['info.source' => $source]);
         return true;
     }
 
+    public function getSource(): ?string
+    {
+        $this->hasData();
+        return $this->data['info']['source'] ?? null;
+    }
+
     /**
-     * Function to allow you set any number of keys and values in the data dictionary.
+     * Function to allow you set any number of keys and values in the data dictionary. You can
+     * set the value in a dictionary by concatenating the keys into a string with a period
+     * separator (ex: info.name will set name field in the info dictionary) so that the rest
+     * of the dictionary is unaffected.
+     *
      * @param array $array
      */
-    public function set(array $array) {
+    public function setValue(array $array): void
+    {
         foreach ($array as $key => $value) {
-            $this->data[$key] = $value;
             if (is_array($value)) {
-                ksort($this->data[$key]);
+                ksort($value);
+            }
+            $keys = explode('.', $key);
+            $data = &$this->data;
+            for ($i = 0; $i < count($keys); $i++) {
+                $data = &$data[$keys[$i]];
+            }
+            $data = $value;
+            $data = &$this->data;
+            for ($i = 0; $i < count($keys); $i++) {
+                $data = &$data[$keys[$i]];
+                if (is_array($data)) {
+                    ksort($data);
+                }
             }
         }
         ksort($this->data);
-    }
-
-    /**
-     * Sets the announce URL for current data. This URL forms the base of the GET request that
-     * the torrent client will send to a tracker so that a client can get peer lists as well as
-     * tell the tracker the stats on the download. The announce URL should probably also end with
-     * /announce which allows for the more efficient scrape to happen on an initial handshake by
-     * the client and when getting just the peer list.
-     *
-     * @see https://wiki.theory.org/index.php/BitTorrentSpecification#Tracker_HTTP.2FHTTPS_Protocol
-     * @see https://wiki.theory.org/index.php/BitTorrentSpecification#Tracker_.27scrape.27_Convention
-     *
-     * @param string $announce_url
-     */
-    public function setAnnounceUrl(string $announce_url) {
-        $this->hasData();
-        $this->set(['announce' => $announce_url]);
-    }
-
-    /**
-     * Sets the comment string for the current data. This does not affect the info_hash.
-     * @param string $comment
-     */
-    public function setComment(string $comment) {
-        $this->hasData();
-        $this->set(['comment' => $comment]);
+        $this->validate();
     }
 
     /**
@@ -346,15 +276,20 @@ class BencodeTorrent {
      *
      * @return string
      */
-    public function getInfoHash() {
+    public function getInfoHash(): string
+    {
         $this->hasData();
         return sha1($this->encodeVal($this->data['info']));
     }
 
-    /**
-     * @return string
-     */
-    public function getName() {
+    public function getHexInfoHash(): string
+    {
+        return pack('H*', $this->getInfoHash());
+    }
+
+    public function getName(): string
+    {
+        $this->hasData();
         if (isset($this->data['info']['name.utf-8'])) {
             return $this->data['info']['name.utf-8'];
         }
@@ -365,15 +300,14 @@ class BencodeTorrent {
      * Get the total size in bytes of the files in the torrent. For a single file torrent, it'll
      * just be the 'length' key in the 'info' dictionary, else we iterate through the 'files' list
      * and add up the 'length' of each element.
-     *
-     * @return int
      */
-    public function getSize() {
+    public function getSize(): int
+    {
+        $this->hasData();
         $cur_size = 0;
         if (!isset($this->data['info']['files'])) {
             $cur_size = $this->data['info']['length'];
-        }
-        else {
+        } else {
             foreach ($this->data['info']['files'] as $file) {
                 $cur_size += $file['length'];
             }
@@ -390,7 +324,8 @@ class BencodeTorrent {
      *
      * @return array
      */
-    public function getFileList() {
+    public function getFileList(): array
+    {
         $files = [];
         if (!isset($this->data['info']['files'])) {
             // Single-file torrent
@@ -398,27 +333,32 @@ class BencodeTorrent {
                 $this->data['info']['name.utf-8'] :
                 $this->data['info']['name']);
             $size = $this->data['info']['length'];
-            $files[] = array('name' => $name, 'size' => $size);
-        }
-        else {
-            $path_key = isset($this->data['info']['files'][0]['path.utf-8']) ?
-                'path.utf-8' :
-                'path';
+            $files[] = ['path' => $name, 'size' => $size];
+        } else {
+            $size = 0;
             foreach ($this->data['info']['files'] as $file) {
-                $tmp_path = array();
-                foreach ($file[$path_key] as $sub_path) {
-                    $tmp_path[] = $sub_path;
-                }
-                $files[] = array('name' => implode('/', $tmp_path), 'size' => $file['length']);
+                $size += $file['length'];
+                $path_key = isset($file['path.utf-8']) ? 'path.utf-8' : 'path';
+                $files[] = ['path' => implode('/', $file[$path_key]), 'size' => $file['length']];
             }
-            uasort(
+            usort(
                 $files,
                 function ($a, $b) {
-                    return strnatcasecmp($a['name'], $b['name']);
+                    return strnatcasecmp($a['path'], $b['path']);
                 }
             );
         }
-        return $files;
+        return array('total_size' => $size, 'files' => $files);
+    }
+
+    public function hasFiles(): bool
+    {
+        return isset($this->data['info']['files']);
+    }
+
+    public function hasEncryptedFiles(): bool
+    {
+        return isset($this->data['encrypted_files']);
     }
 
     /**
@@ -431,17 +371,18 @@ class BencodeTorrent {
      *
      * @return array
      */
-    public function getGazelleFileList() {
+    public function getGazelleFileList(): array
+    {
         $files = [];
-        foreach ($this->getFileList() as $file) {
-            $name = $file['name'];
-            $size = $file['length'];
-            $name = self::makeUTF8(strtr($name, "\n\r\t", '   '));
-            $ext_pos = strrpos($name, '.');
+        foreach ($this->getFileList()['files'] as $file) {
+            $path = $file['path'];
+            $size = $file['size'];
+            $path = $this->makeUTF8(strtr($path, "\n\r\t", '   '));
+            $ext_pos = strrpos($path, '.');
             // Should not be $ExtPos !== false. Extension-less files that start with a .
             // should not get extensions
-            $ext = ($ext_pos ? trim(substr($name, $ext_pos + 1)) : '');
-            $files[] =  sprintf("%s s%ds %s %s", ".$ext", $size, $name, self::$utf8_filelist_delim);
+            $ext = ($ext_pos ? trim(substr($path, $ext_pos + 1)) : '');
+            $files[] =  sprintf("%s s%ds %s %s", ".$ext", $size, $path, self::$utf8_filelist_delim);
         }
         return $files;
     }
@@ -449,52 +390,28 @@ class BencodeTorrent {
     /**
      * Given a string, convert it to UTF-8 format, if it's not already in UTF-8.
      *
-     * @param string $Str input to convert to utf-8 format
+     * @param string $str input to convert to utf-8 format
      *
      * @return string
      */
-    private static function makeUTF8($Str) {
-        if ($Str != '') {
-            if (self::isUTF8($Str)) {
-                $Encoding = 'UTF-8';
-            }
-            if (empty($Encoding)) {
-                $Encoding = mb_detect_encoding($Str, 'UTF-8, ISO-8859-1');
-            }
-            if (empty($Encoding)) {
-                $Encoding = 'ISO-8859-1';
-            }
-            if ($Encoding == 'UTF-8') {
-                return $Str;
-            }
-            else {
-                return @mb_convert_encoding($Str, 'UTF-8', $Encoding);
-            }
+    private function makeUTF8(string $str): string
+    {
+        if (preg_match('//u', $str)) {
+            $encoding = 'UTF-8';
+        }
+        if (empty($encoding)) {
+            $encoding = mb_detect_encoding($str, 'UTF-8, ISO-8859-1');
+        }
+        // Legacy thing for Gazelle, leaving it in, but not going to bother testing
+        // @codeCoverageIgnoreStart
+        if (empty($encoding)) {
+            $encoding = 'ISO-8859-1';
+        }
+        // @codeCoverageIgnoreEnd
+        if ($encoding === 'UTF-8') {
+            return $str;
+        } else {
+            return @mb_convert_encoding($str, 'UTF-8', $encoding);
         }
-        return $Str;
-    }
-
-    /**
-     * Given a string, determine if that string is encoded in UTF-8 via regular expressions,
-     * so that we don't have to rely on mb_detect_encoding which isn't quite as accurate
-     *
-     * @param string $Str input to check encoding of
-     *
-     * @return false|int
-     */
-    private static function isUTF8($Str) {
-        return preg_match(
-            '%^(?:
-            [\x09\x0A\x0D\x20-\x7E]              // ASCII
-            | [\xC2-\xDF][\x80-\xBF]             // non-overlong 2-byte
-            | \xE0[\xA0-\xBF][\x80-\xBF]         // excluding overlongs
-            | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2}  // straight 3-byte
-            | \xED[\x80-\x9F][\x80-\xBF]         // excluding surrogates
-            | \xF0[\x90-\xBF][\x80-\xBF]{2}      // planes 1-3
-            | [\xF1-\xF3][\x80-\xBF]{3}          // planes 4-15
-            | \xF4[\x80-\x8F][\x80-\xBF]{2}      // plane 16
-            )*$%xs',
-            $Str
-        );
     }
 }

tests/BencodeTest.php

@@ -0,0 +1,72 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OrpheusNET\BencodeTorrent;
+
+class BencodeTest extends \PHPUnit\Framework\TestCase
+{
+    public function dataProvider(): array
+    {
+        return [
+            ['i0e', 0],
+            ['i-1e', -1],
+            ['i20e', 20],
+            ['le', []],
+            ['d4:item5:valuee', ['item' => 'value']],
+            ['0:', ''],
+            ['1:a', 'a'],
+            ['9:123456789', '123456789']
+        ];
+    }
+
+    /**
+     * @dataProvider dataProvider
+     * @param mixed  $expected
+     */
+    public function testDecodeEncode(string $bencoded_string, $expected): void
+    {
+        $bencode = new Bencode();
+        $bencode->decodeString($bencoded_string);
+        $this->assertEquals($expected, $bencode->getData());
+        $this->assertEquals($bencoded_string, $bencode->getEncode());
+    }
+
+    public function testEmptyDict(): void
+    {
+        $bencode = new Bencode();
+        $bencode->decodeString('de');
+        $this->assertEquals([], $bencode->getData());
+        $this->assertEquals('le', $bencode->getEncode());
+    }
+
+    public function testInvalidDictionaryKey(): void
+    {
+        $bencode = new Bencode();
+        $this->expectException(\RuntimeException::class);
+        $bencode->decodeString('di1e5:valuee');
+    }
+
+    public function invalidIntegers(): array
+    {
+        return [['-0'], ['a'], ['1.0']];
+    }
+
+    /**
+     * @param string $value
+     * @dataProvider invalidIntegers
+     */
+    public function testInvalidInteger(string $value): void
+    {
+        $bencode = new Bencode();
+        $this->expectException(\RuntimeException::class);
+        $bencode->decodeString("i{$value}e");
+    }
+
+    public function testInvalidString(): void
+    {
+        $bencode = new Bencode();
+        $this->expectException(\RuntimeException::class);
+        $bencode->decodeString('i1e0e');
+    }
+}

tests/BencodeTorrentTest.php

@@ -1,29 +1,36 @@
 <?php
 
-namespace ApolloRip\BencodeTorrent;
+declare(strict_types=1);
 
-use PHPUnit\Framework\TestCase;
+namespace OrpheusNET\BencodeTorrent;
 
-class BencodeTorrentTest extends TestCase {
-	public function testLoadTorrent() {
-		$bencode = new BencodeTorrent();
-		try {
-			$bencode->decodeFile(__DIR__.'/data/test_1.torrent');
-		}
-		catch (\Exception $exc) {
-			$this->fail('Decode should not have thrown exception');
-		}
-		$data = $bencode->getData();
-		$this->assertEquals('https://localhost:34000/4f9587fbcb06fe09165e4f84d35d0403/announce', $data['announce']);
-		$this->assertEquals('https://localhost:8080/torrents.php?id=2&torrentid=2', $data['comment']);
-		$this->assertEquals('uTorrent/3.4.2', $data['created by']);
-		$this->assertEquals(1425699508, $data['creation date']);
-		$this->assertEquals('UTF-8', $data['encoding']);
-		$this->assertArrayHasKey('info', $data);
-		$this->assertCount(11, $data['info']['files']);
-		$files = [
-		    [
-		        'length' => 12310347,
+class BencodeTorrentTest extends \PHPUnit\Framework\TestCase
+{
+    public function testLoadTorrent(): void
+    {
+        $bencode = new BencodeTorrent();
+        try {
+            $bencode->decodeFile(__DIR__ . '/data/test_1.torrent');
+        } catch (\Exception $exc) {
+            $this->fail('Decode should not have thrown exception');
+        }
+        $data = $bencode->getData();
+        $this->assertEquals(
+            'https://localhost:34000/4f9587fbcb06fe09165e4f84d35d0403/announce',
+            $data['announce']
+        );
+        $this->assertEquals(
+            'https://localhost:8080/torrents.php?id=2&torrentid=2',
+            $data['comment']
+        );
+        $this->assertEquals('uTorrent/3.4.2', $data['created by']);
+        $this->assertEquals(1425699508, $data['creation date']);
+        $this->assertEquals('UTF-8', $data['encoding']);
+        $this->assertArrayHasKey('info', $data);
+        $this->assertCount(11, $data['info']['files']);
+        $files = [
+            [
+                'length' => 12310347,
                 'path' => ['02 Should have known better.mp3']
             ],
             [
@@ -67,18 +74,82 @@ class BencodeTorrentTest extends TestCase {
                 'path' => ['05 Eugene.mp3']
             ]
         ];
-		$this->assertEquals($files, $data['info']['files']);
-		$this->assertEquals('Sufjan Stevens - Carrie & Lowell (2015) [MP3 320]', $data['info']['name']);
-		$this->assertEquals('Sufjan Stevens - Carrie & Lowell (2015) [MP3 320]', $bencode->getName());
-		$this->assertEquals(16020, strlen($data['info']['pieces']));
-		$this->assertEquals(1, $data['info']['private']);
-		$this->assertEquals('APL', $data['info']['source']);
-		$this->assertStringEqualsFile(__DIR__.'/data/test_1.torrent', $bencode->getEncode());
-	}
+        $this->assertEquals($files, $data['info']['files']);
+        $this->assertEquals(
+            'Sufjan Stevens - Carrie & Lowell (2015) [MP3 320]',
+            $data['info']['name']
+        );
+        $this->assertEquals(
+            'Sufjan Stevens - Carrie & Lowell (2015) [MP3 320]',
+            $bencode->getName()
+        );
+        $this->assertEquals(16020, strlen($data['info']['pieces']));
+        $this->assertEquals(1, $data['info']['private']);
+        $this->assertEquals('APL', $data['info']['source']);
+        $this->assertStringEqualsFile(__DIR__ . '/data/test_1.torrent', $bencode->getEncode());
+        $this->assertEquals(104916260, $bencode->getSize());
+        $this->assertTrue($bencode->isPrivate());
+        $bencode->decodeString($bencode->getEncode());
+        $this->assertStringEqualsFile(__DIR__ . '/data/test_1.torrent', $bencode->getEncode());
+        $this->assertEquals('1f830103427029a88dd5fde85be74e622ee07951', $bencode->getInfoHash());
+        $this->assertEquals($bencode->getInfoHash(), unpack('H*', $bencode->getHexInfoHash())[1]);
+        $this->assertFalse($bencode->hasEncryptedFiles());
+        $file_list = [
+            'total_size' => 104916260,
+            'files' => [
+                [
+                    'size' => 9584196,
+                    'path' => '01 Death with Dignity.mp3'
+                ],
+                [
+                    'size' => 12310347,
+                    'path' => '02 Should have known better.mp3'
+                ],
+                [
+                    'size' => 8871591,
+                    'path' => '03 All of me wants all of you.mp3'
+                ],
+                [
+                    'size' => 7942661,
+                    'path' => '04 Drawn to the Blood.mp3'
+                ],
+                [
+                    'size' => 5878964,
+                    'path' => '05 Eugene.mp3'
+                ],
+                [
+                    'size' => 11175567,
+                    'path' => '06 Fourth of July.mp3'
+                ],
+                [
+                    'size' => 11367829,
+                    'path' => '07 The Only Thing.mp3'
+                ],
+                [
+                    'size' => 7789055,
+                    'path' => '08 Carrie & Lowell.mp3'
+                ],
+                [
+                    'size' => 12197480,
+                    'path' => '09 John My Beloved.mp3'
+                ],
+                [
+                    'size' => 6438044,
+                    'path' => '10 No shade in the shadow of the cross.mp3'
+                ],
+                [
+                    'size' => 11360526,
+                    'path' => '11 Blue Bucket of Gold.mp3'
+                ]
+            ]
+        ];
+        $this->assertEquals($file_list, $bencode->getFileList());
+    }
 
-	public function testSetData() {
-	    $data = [
-	        'encoding' => 'UTF8',
+    public function testSetData(): void
+    {
+        $data = [
+            'encoding' => 'UTF8',
             'info' => [
                 'name' => 'test',
                 'length' => 1213134,
@@ -86,15 +157,331 @@ class BencodeTorrentTest extends TestCase {
             ]
         ];
 
-	    $bencode = new BencodeTorrent();
-	    try {
-            $bencode->setData($data);
-        }
-        catch (\Exception $exc) {
-	        $this->fail('Exception should not have been thrown');
-        }
+        $bencode = new BencodeTorrent();
+        $bencode->setData($data);
 
         $data = $bencode->getData();
-        $this->assertEquals('UTF8', $data['encoding']);
-	}
-}
+        $this->assertEquals($data, $bencode->getData());
+        $this->assertEquals('test', $bencode->getName());
+        $this->assertFalse($bencode->isPrivate());
+        $this->assertEquals(1213134, $bencode->getSize());
+        $this->assertEquals(
+            [
+                'total_size' => 1213134,
+                'files' => [
+                    [
+                        'path' => 'test',
+                        'size' => 1213134
+                    ]
+                ]
+            ],
+            $bencode->getFileList()
+        );
+    }
+
+    public function testEmptyDictionary(): void
+    {
+        $expected = [
+            'encoding' => 'UTF8',
+            'info' => [
+                'name' => 'test',
+                'length' => 1213134,
+                'pieces' => 'fake pieces string',
+            ],
+            'test' => ''
+        ];
+        $bencode = new BencodeTorrent();
+        $bencode->decodeString(
+            'd8:encoding4:UTF84:infod4:name4:test6:lengthi1213134e' .
+            '6:pieces18:fake pieces stringe4:test0:e'
+        );
+        $this->assertEquals($expected, $bencode->getData());
+    }
+
+    public function testClean(): void
+    {
+        $data = [
+            'encoding' => 'UTF8',
+            'info' => [
+                'file-duration' => '',
+                'file-media' => '',
+                'files' => [],
+                'name' => 'test',
+                'name.utf8' => 'test',
+                'name.utf-8' => 'test',
+                'length' => 12345,
+                'md5sum' => 12345,
+                'piece length' => 12345,
+                'pieces' => '',
+                'private' => 1,
+                'profiles' => '',
+                'sha1' => 1,
+                'source' => 'APL',
+                'unique' => 1,
+                'test' => 'delete me',
+                'x_cross_seed' => 1
+            ],
+            'test' => 'delete me'
+        ];
+
+        $bencode = new BencodeTorrent();
+        $bencode->setData($data);
+        $this->assertTrue($bencode->clean());
+        unset($data['test']);
+        unset($data['info']['test']);
+        $this->assertEquals($data, $bencode->getData());
+    }
+
+    public function testSetPrivate(): void
+    {
+        $data = [
+            'encoding' => 'UTF8',
+            'info' => [
+                'name' => 'test',
+                'length' => 1213134,
+                'pieces' => 'fake pieces string'
+            ]
+        ];
+        $bencode = new BencodeTorrent();
+        $bencode->setData($data);
+        $this->assertFalse($bencode->isPrivate());
+        $actual = $bencode->getData();
+        $this->assertNotContains('private', $actual['info']);
+        $this->assertTrue($bencode->makePrivate());
+        $this->assertTrue($bencode->isPrivate());
+        $actual = $bencode->getData();
+        $this->assertEquals(1, $actual['info']['private']);
+    }
+
+    public function testSetAlreadyPrivate(): void
+    {
+        $data = [
+            'encoding' => 'UTF8',
+            'info' => [
+                'name' => 'test',
+                'private' => 1
+            ]
+        ];
+        $bencode = new BencodeTorrent();
+        $bencode->setData($data);
+        $this->assertTrue($bencode->isPrivate());
+        $this->assertFalse($bencode->makePrivate());
+    }
+
+    public function testSetSource(): void
+    {
+        $data = [
+            'encoding' => 'UTF8',
+            'info' => [
+                'name' => 'test',
+                'private' => 1,
+                'unique' => 1,
+                'x_cross_seed' => 'true'
+            ]
+        ];
+        $bencode = new BencodeTorrent();
+        $bencode->setData($data);
+        $this->assertNull($bencode->getSource());
+        $this->assertTrue($bencode->setSource('APL'));
+        $actual = $bencode->getData();
+        $this->assertSame('APL', $bencode->getSource());
+        $this->assertFalse($bencode->setSource('APL'));
+        $this->assertNotContains('unique', $actual['info']);
+        $this->assertNotContains('x_cross_seed', $actual['info']);
+    }
+
+    public function testSetAlreadySourced(): void
+    {
+        $data = [
+            'encoding' => 'UTF8',
+            'info' => [
+                'name' => 'test',
+                'private' => 1,
+                'source' => 'APL',
+                'unique' => 1,
+                'x_cross_seed' => 'true'
+            ]
+        ];
+
+        $bencode = new BencodeTorrent();
+        $bencode->setData($data);
+        $this->assertFalse($bencode->setSource('APL'));
+        $this->assertEquals($data, $bencode->getData());
+    }
+
+    public function testSetDifferentSource(): void
+    {
+        $data = [
+            'encoding' => 'UTF8',
+            'info' => [
+                'name' => 'test',
+                'private' => 1,
+                'source' => 'RED',
+                'unique' => 1,
+                'x_cross_seed' => 'true'
+            ]
+        ];
+        $bencode = new BencodeTorrent();
+        $bencode->setData($data);
+        $this->assertTrue($bencode->setSource('APL'));
+        $actual = $bencode->getData();
+        $this->assertEquals('APL', $actual['info']['source']);
+        $this->assertNotContains('unique', $actual['info']);
+        $this->assertNotContains('x_cross_seed', $actual['info']);
+    }
+
+    public function testSetValue(): void
+    {
+        $data = [
+            'encoding' => 'UTF8',
+            'info' => [
+                'files' => [
+                    0 => [
+                        'length' => 1234,
+                        'path' => ['01 Test.mp3'],
+                        'path.utf-8' => ['01 Test??.mp3']
+                    ],
+                    1 => [
+                        'length' => 2345,
+                        'path' => ['03 Test!!.mp3'],
+                        'path.utf-8' => ['03 Test.mp3']
+                    ]
+                ],
+                'name' => 'test',
+                'private' => 1
+            ]
+        ];
+        $bencode = new BencodeTorrent();
+        $bencode->setData($data);
+        $set = ['announce' => 'http://localhost:8080/announce',
+                'info.name' => 'test2',
+                'info.private' => 0,
+                'info.files.0.path.0' => '02 Test.mp3',
+                'comment' => 'http://localhost:8080/torrents.php?id=1'];
+        $bencode->setValue($set);
+        $expected = [
+            'announce' => 'http://localhost:8080/announce',
+            'comment' => 'http://localhost:8080/torrents.php?id=1',
+            'encoding' => 'UTF8',
+            'info' => [
+                'files' => [
+                    0 => [
+                        'length' => 1234,
+                        'path' => ['02 Test.mp3'],
+                        'path.utf-8' => ['01 Test??.mp3']
+                    ],
+                    1 => [
+                        'length' => 2345,
+                        'path' => ['03 Test!!.mp3'],
+                        'path.utf-8' => ['03 Test.mp3']
+                    ]
+                ],
+                'name' => 'test2',
+                'private' => 0
+            ]
+        ];
+        $this->assertEquals($expected, $bencode->getData());
+        $this->assertEquals(
+            ['.mp3 s1234s 01 Test??.mp3 ÷', '.mp3 s2345s 03 Test.mp3 ÷'],
+            $bencode->getGazelleFileList()
+        );
+        $this->assertTrue($bencode->hasFiles());
+    }
+
+    public function testGetUtf8Name(): void
+    {
+        $data = [
+            'encoding' => 'UTF8',
+            'info' => [
+                'length' => 12345,
+                'name' => 'test',
+                'name.utf-8' => 'test!!',
+                'private' => 1
+            ]
+        ];
+        $bencode = new BencodeTorrent();
+        $bencode->setData($data);
+        $this->assertEquals('test!!', $bencode->getName());
+        $this->assertEquals(12345, $bencode->getSize());
+        $this->assertEquals(
+            [
+                'total_size' => 12345,
+                'files' => [
+                    [
+                        'path' => 'test!!',
+                        'size' => 12345
+                    ]
+                ]
+            ],
+            $bencode->getFileList()
+        );
+        $this->assertEquals(['. s12345s test!! ÷'], $bencode->getGazelleFileList());
+    }
+
+    public function testIso88591Name(): void
+    {
+        $data = [
+            'info' => [
+                'length' => 1234,
+                'name' => utf8_decode('(test.,!?)óÉ')
+            ]
+        ];
+        $bencode = new BencodeTorrent();
+        $bencode->setData($data);
+        $this->assertEquals(['.,!?)óÉ s1234s (test.,!?)óÉ ÷'], $bencode->getGazelleFileList());
+        $this->assertFalse($bencode->hasFiles());
+    }
+
+    public function testInvalidSet(): void
+    {
+        $data = ['encoding' => 'UTF8', 'announce' => 'http://localhost:8080/announce'];
+        $bencode = new BencodeTorrent();
+        $this->expectException(\RuntimeException::class);
+        $bencode->setData($data);
+    }
+
+    public function testInvalidSetValue(): void
+    {
+        $data = [
+            'encoding' => 'UTF8',
+            'info' => [
+                'name' => 'test',
+                'length' => 1213134,
+                'pieces' => 'fake pieces string'
+            ]
+        ];
+
+        $bencode = new BencodeTorrent();
+        $bencode->setData($data);
+        $this->expectException(\RuntimeException::class);
+        $bencode->setValue(['info' => []]);
+    }
+
+    public function testGetEncodeNoData(): void
+    {
+        $bencode = new BencodeTorrent();
+        $this->expectException(\RuntimeException::class);
+        $bencode->getEncode();
+    }
+
+    public function testInvalidPath(): void
+    {
+        $data = [
+            'encoding' => 'UTF8',
+            'info' => [
+                'files' => [
+                    0 => [
+                        'length' => 1234,
+                        'path' => ['']
+                    ]
+                ],
+                'name' => 'test',
+                'length' => 1213134,
+                'pieces' => 'fake pieces string'
+            ]
+        ];
+        $bencode = new BencodeTorrent();
+        $this->expectException(\RuntimeException::class);
+        $bencode->setData($data);
+    }
+}