From bf2851f324bdc1a8ee54c033b93bd6d956ecfc31 Mon Sep 17 00:00:00 2001
From: "Dylan K. Taylor" <odigiman@gmail.com>
Date: Fri, 12 Apr 2019 19:45:41 +0100
Subject: [PATCH] Move API checking to its own class so it can be unit-tested

---
 src/pocketmine/plugin/ApiVersion.php    | 65 +++++++++++++++++++++++++
 src/pocketmine/plugin/PluginManager.php |  2 +-
 tests/phpunit/plugin/ApiVersionTest.php | 55 +++++++++++++++++++++
 3 files changed, 121 insertions(+), 1 deletion(-)
 create mode 100644 src/pocketmine/plugin/ApiVersion.php
 create mode 100644 tests/phpunit/plugin/ApiVersionTest.php

diff --git a/src/pocketmine/plugin/ApiVersion.php b/src/pocketmine/plugin/ApiVersion.php
new file mode 100644
index 000000000..2dc83dc8b
--- /dev/null
+++ b/src/pocketmine/plugin/ApiVersion.php
@@ -0,0 +1,65 @@
+<?php
+
+/*
+ *
+ *  ____            _        _   __  __ _                  __  __ ____
+ * |  _ \ ___   ___| | _____| |_|  \/  (_)_ __   ___      |  \/  |  _ \
+ * | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
+ * |  __/ (_) | (__|   <  __/ |_| |  | | | | | |  __/_____| |  | |  __/
+ * |_|   \___/ \___|_|\_\___|\__|_|  |_|_|_| |_|\___|     |_|  |_|_|
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * @author PocketMine Team
+ * @link http://www.pocketmine.net/
+ *
+ *
+*/
+
+declare(strict_types=1);
+
+namespace pocketmine\plugin;
+
+use pocketmine\utils\VersionString;
+
+final class ApiVersion{
+
+	private function __construct(){
+		//NOOP
+	}
+
+	/**
+	 * @param string   $myVersionStr
+	 * @param string[] $wantVersionsStr
+	 *
+	 * @return bool
+	 */
+	public static function isCompatible(string $myVersionStr, array $wantVersionsStr) : bool{
+		$myVersion = new VersionString($myVersionStr);
+		foreach($wantVersionsStr as $versionStr){
+			$version = new VersionString($versionStr);
+			//Format: majorVersion.minorVersion.patch (3.0.0)
+			//    or: majorVersion.minorVersion.patch-devBuild (3.0.0-alpha1)
+			if($version->getBaseVersion() !== $myVersion->getBaseVersion()){
+				if($version->getMajor() !== $myVersion->getMajor() or $version->getSuffix() !== $myVersion->getSuffix()){
+					continue;
+				}
+
+				if($version->getMinor() > $myVersion->getMinor()){ //If the plugin requires new API features, being backwards compatible
+					continue;
+				}
+
+				if($version->getMinor() === $myVersion->getMinor() and $version->getPatch() > $myVersion->getPatch()){ //If the plugin requires bug fixes in patches, being backwards compatible
+					continue;
+				}
+			}
+
+			return true;
+		}
+
+		return false;
+	}
+}
diff --git a/src/pocketmine/plugin/PluginManager.php b/src/pocketmine/plugin/PluginManager.php
index 6bf056400..4d48bbe26 100644
--- a/src/pocketmine/plugin/PluginManager.php
+++ b/src/pocketmine/plugin/PluginManager.php
@@ -251,7 +251,7 @@ class PluginManager{
 					continue;
 				}
 
-				if(!$this->isCompatibleApi(...$description->getCompatibleApis())){
+				if(!ApiVersion::isCompatible($this->server->getApiVersion(), $description->getCompatibleApis())){
 					$this->server->getLogger()->error($this->server->getLanguage()->translateString("pocketmine.plugin.loadError", [
 						$name,
 						$this->server->getLanguage()->translateString("%pocketmine.plugin.incompatibleAPI", [implode(", ", $description->getCompatibleApis())])
diff --git a/tests/phpunit/plugin/ApiVersionTest.php b/tests/phpunit/plugin/ApiVersionTest.php
new file mode 100644
index 000000000..7c347a339
--- /dev/null
+++ b/tests/phpunit/plugin/ApiVersionTest.php
@@ -0,0 +1,55 @@
+<?php
+
+/*
+ *
+ *  ____            _        _   __  __ _                  __  __ ____
+ * |  _ \ ___   ___| | _____| |_|  \/  (_)_ __   ___      |  \/  |  _ \
+ * | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
+ * |  __/ (_) | (__|   <  __/ |_| |  | | | | | |  __/_____| |  | |  __/
+ * |_|   \___/ \___|_|\_\___|\__|_|  |_|_|_| |_|\___|     |_|  |_|_|
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * @author PocketMine Team
+ * @link http://www.pocketmine.net/
+ *
+ *
+*/
+
+declare(strict_types=1);
+
+namespace pocketmine\plugin;
+
+use PHPUnit\Framework\TestCase;
+
+class ApiVersionTest extends TestCase{
+
+	public function compatibleApiProvider() : \Generator{
+		yield ["3.0.0", "3.0.0", true];
+		yield ["3.1.0", "3.0.0", true];
+		yield ["3.0.0", "3.1.0", false];
+		yield ["3.1.0", "3.0.1", true]; //old bug where minor wasn't respected when comparing patches
+		yield ["3.0.0", "4.0.0", false];
+		yield ["4.0.0", "3.0.0", false];
+		yield ["3.0.0", "3.0.1", false]; //bug fix patch required
+		yield ["3.0.1", "3.0.0", true];
+		yield ["3.0.0-ALPHA1", "3.0.0-ALPHA2", false];
+		yield ["3.0.0-ALPHA2", "3.0.0-ALPHA1", false];
+		yield ["3.0.0-ALPHA1", "3.0.0-ALPHA1", true];
+		yield ["3.0.0-ALPHA1", "4.0.0-ALPHA1", false];
+	}
+
+	/**
+	 * @dataProvider compatibleApiProvider
+	 *
+	 * @param string $myVersion
+	 * @param string $wantVersion
+	 * @param bool   $expected
+	 */
+	public function testCompatibleApi(string $myVersion, string $wantVersion, bool $expected) : void{
+		self::assertSame($expected, ApiVersion::isCompatible($myVersion, [$wantVersion]), "my version: $myVersion, their version: $wantVersion, expect " . ($expected ? "yes" : "no"));
+	}
+}