From 18cbfa1d540428bc2e5f14e7ab69cf73a9c9e6fc Mon Sep 17 00:00:00 2001
From: Rhilip <rhilipruan@gmail.com>
Date: Thu, 23 Jan 2020 10:44:27 +0800
Subject: [PATCH] style(Bencode): Separate Bencode library to `Rhilip/Bencode`

---
 application/Controllers/TrackerController.php |   3 +-
 application/Libraries/Bencode/Bencode.php     | 149 ------------------
 .../Libraries/Bencode/ParseErrorException.php |  13 --
 application/Middleware/AuthMiddleware.php     |   8 +-
 .../Models/Form/Torrent/DownloadForm.php      |   3 +-
 .../Models/Form/Torrent/StructureForm.php     |   3 +-
 .../Models/Form/Torrent/UploadForm.php        |   5 +-
 composer.json                                 |   3 +-
 composer.lock                                 |  46 +++++-
 templates/torrent/structure.php               |   2 +-
 10 files changed, 61 insertions(+), 174 deletions(-)
 delete mode 100644 application/Libraries/Bencode/Bencode.php
 delete mode 100644 application/Libraries/Bencode/ParseErrorException.php

diff --git a/application/Controllers/TrackerController.php b/application/Controllers/TrackerController.php
index 45aa600..3ff628a 100644
--- a/application/Controllers/TrackerController.php
+++ b/application/Controllers/TrackerController.php
@@ -10,11 +10,12 @@
 
 use App\Libraries\Constant;
 use App\Repository\User\UserRole;
-use App\Libraries\Bencode\Bencode;
 use App\Exceptions\TrackerException;
 
 use Rid\Utils\IpUtils;
 
+use Rhilip\Bencode\Bencode;
+
 /** @noinspection PhpUnused */
 class TrackerController
 {
diff --git a/application/Libraries/Bencode/Bencode.php b/application/Libraries/Bencode/Bencode.php
deleted file mode 100644
index 8bdee13..0000000
--- a/application/Libraries/Bencode/Bencode.php
+++ /dev/null
@@ -1,149 +0,0 @@
-<?php
-/**
- *
- * Rewrite from : https://github.com/OPSnet/bencode-torrent/blob/master/src/Bencode.php
- *
- * Created by PhpStorm.
- * User: Rhilip
- * Date: 2019/2/2
- * Time: 20:00
- */
-
-namespace App\Libraries\Bencode;
-
-class Bencode
-{
-    /**
-     * 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
-     */
-    public static function decode(string $data, int &$pos = 0)
-    {
-        $start_decode = ($pos === 0);
-        if ($data[$pos] === 'd') {
-            $pos++;
-            $return = [];
-            while ($data[$pos] !== 'e') {
-                $key = self::decode($data, $pos);
-                $value = self::decode($data, $pos);
-                if ($key === null || $value === null) {
-                    break;
-                }
-                if (!is_string($key)) {
-                    throw new ParseErrorException('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 = self::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 ParseErrorException('Cannot have integer value -0');
-            }
-            $multiplier = 1;
-            if ($return[0] === '-') {
-                $multiplier = -1;
-                $return = substr($return, 1);
-            }
-            if (!ctype_digit($return)) {
-                throw new ParseErrorException('Cannot have non-digit values in integer number: ' . $return);
-            }
-            $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 ParseErrorException('Could not fully decode bencode string');
-            }
-        }
-        return $return;
-    }
-
-    /**
-     * @param mixed $data
-     * @return string
-     */
-    public static function encode($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 .= self::encode($value);
-                }
-            } else {
-                $return .= 'd';
-                ksort($data, SORT_STRING);
-                foreach ($data as $key => $value) {
-                    $return .= self::encode(strval($key));
-                    $return .= self::encode($value);
-                }
-            }
-            $return .= 'e';
-        } elseif (is_integer($data)) {
-            $return = 'i' . $data . 'e';
-        } else {
-            $return = strlen($data) . ':' . $data;
-        }
-        return $return;
-    }
-
-    /**
-     * Given a path to a file, decode the contents of it
-     *
-     * @param string $path
-     * @return mixed
-     * @throws ParseErrorException
-     */
-    public static function load(string $path)
-    {
-        return self::decode(file_get_contents($path, FILE_BINARY));
-    }
-
-    /**
-     * Given a path for a file, encode the contents of it
-     *
-     * @param string $path
-     * @param $data
-     * @return mixed
-     */
-    public static function dump(string $path, $data)
-    {
-        return file_put_contents($path, self::encode($data));
-    }
-}
diff --git a/application/Libraries/Bencode/ParseErrorException.php b/application/Libraries/Bencode/ParseErrorException.php
deleted file mode 100644
index b46f2d7..0000000
--- a/application/Libraries/Bencode/ParseErrorException.php
+++ /dev/null
@@ -1,13 +0,0 @@
-<?php
-/**
- * Created by PhpStorm.
- * User: Rhilip
- * Date: 2019/2/2
- * Time: 20:27
- */
-
-namespace App\Libraries\Bencode;
-
-class ParseErrorException extends \RuntimeException
-{
-}
diff --git a/application/Middleware/AuthMiddleware.php b/application/Middleware/AuthMiddleware.php
index 14d0c48..6e74376 100644
--- a/application/Middleware/AuthMiddleware.php
+++ b/application/Middleware/AuthMiddleware.php
@@ -85,10 +85,10 @@ public function handle($callable, \Closure $next)
          */
         $route = strtolower(
             str_replace(
-            ['App\\Controllers\\', 'Controller', 'action'],
-            '',
-            $controllerName . '_' . $action
-        )
+                ['App\\Controllers\\', 'Controller', 'action'],
+                '',
+                $controllerName . '_' . $action
+            )
         );
 
         $required_class = config('route.' . $route) ?: 1;
diff --git a/application/Models/Form/Torrent/DownloadForm.php b/application/Models/Form/Torrent/DownloadForm.php
index 5b0f1df..841f2e0 100644
--- a/application/Models/Form/Torrent/DownloadForm.php
+++ b/application/Models/Form/Torrent/DownloadForm.php
@@ -9,7 +9,8 @@
 namespace App\Models\Form\Torrent;
 
 use App\Models\Form\Traits\FileSentTrait;
-use App\Libraries\Bencode\Bencode;
+
+use Rhilip\Bencode\Bencode;
 
 class DownloadForm extends StructureForm
 {
diff --git a/application/Models/Form/Torrent/StructureForm.php b/application/Models/Form/Torrent/StructureForm.php
index d030428..da2f19a 100644
--- a/application/Models/Form/Torrent/StructureForm.php
+++ b/application/Models/Form/Torrent/StructureForm.php
@@ -9,7 +9,8 @@
 namespace App\Models\Form\Torrent;
 
 use App\Libraries\Constant;
-use App\Libraries\Bencode\Bencode;
+
+use Rhilip\Bencode\Bencode;
 
 class StructureForm extends DetailsForm
 {
diff --git a/application/Models/Form/Torrent/UploadForm.php b/application/Models/Form/Torrent/UploadForm.php
index 6c09eab..18d596f 100644
--- a/application/Models/Form/Torrent/UploadForm.php
+++ b/application/Models/Form/Torrent/UploadForm.php
@@ -11,11 +11,12 @@
 use App\Libraries\Constant;
 use App\Repository\Torrent\TorrentStatus;
 use App\Repository\Torrent\TorrentType;
-use App\Libraries\Bencode\Bencode;
-use App\Libraries\Bencode\ParseErrorException;
 
 use Rid\Http\UploadFile;
 
+use Rhilip\Bencode\Bencode;
+use Rhilip\Bencode\ParseErrorException;
+
 class UploadForm extends EditForm
 {
 
diff --git a/composer.json b/composer.json
index 45ce5da..b54096e 100644
--- a/composer.json
+++ b/composer.json
@@ -39,7 +39,8 @@
     "siriusphp/validation": "^2.3",
     "mjohnson/decoda": "^6.12",
     "symfony/translation": "^4.3",
-    "symfony/config": "^4.3"
+    "symfony/config": "^4.3",
+    "rhilip/bencode": "^1.0"
   },
   "require-dev": {
     "eaglewu/swoole-ide-helper": "dev-master"
diff --git a/composer.lock b/composer.lock
index d08940e..e9bcb19 100644
--- a/composer.lock
+++ b/composer.lock
@@ -4,7 +4,7 @@
         "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
         "This file is @generated automatically"
     ],
-    "content-hash": "b21bc34532e02a7faae7628d5344d4c3",
+    "content-hash": "67e558427ab92603bc9e8b88518ea3da",
     "packages": [
         {
             "name": "adhocore/cli",
@@ -381,6 +381,50 @@
             ],
             "time": "2019-11-01T11:05:21+00:00"
         },
+        {
+            "name": "rhilip/bencode",
+            "version": "v1.0.0",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/Rhilip/Bencode.git",
+                "reference": "a37460e530d0d1edf429e4f915ff5bce46efd3d4"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/Rhilip/Bencode/zipball/a37460e530d0d1edf429e4f915ff5bce46efd3d4",
+                "reference": "a37460e530d0d1edf429e4f915ff5bce46efd3d4",
+                "shasum": ""
+            },
+            "require": {
+                "php": "^5.6|^7.0|^8.0"
+            },
+            "suggest": {
+                "php-64bit": "Running 64 bit is recommended to prevent integer overflow"
+            },
+            "type": "library",
+            "autoload": {
+                "psr-4": {
+                    "Rhilip\\Bencode\\": "src"
+                }
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "authors": [
+                {
+                    "name": "Rhilip",
+                    "email": "rhilipruan@gmail.com"
+                }
+            ],
+            "description": "A pure and simple PHP library for encoding and decoding Bencode data",
+            "keywords": [
+                "bencode",
+                "bittorrent",
+                "torrent"
+            ],
+            "time": "2020-01-22T15:27:41+00:00"
+        },
         {
             "name": "siriusphp/validation",
             "version": "2.3.0",
diff --git a/templates/torrent/structure.php b/templates/torrent/structure.php
index ef8ff45..f87acab 100644
--- a/templates/torrent/structure.php
+++ b/templates/torrent/structure.php
@@ -9,7 +9,7 @@
  * @var \App\Models\Form\Torrent\StructureForm $structure
  */
 
-use App\Libraries\Bencode\Bencode;
+use Rhilip\Bencode\Bencode;
 
 if (!function_exists('torrent_structure_builder')) {
     function torrent_structure_builder($array, $parent = "")