replaced version comparison function with composer/semvar

Author: s3inlc

Dockerfile

@@ -1,12 +1,12 @@
-FROM alpine/git as preprocess
+FROM alpine/git AS preprocess
 
 COPY .gi[t] /.git
 
 RUN cd / && git rev-parse --short HEAD > /HEAD; exit 0
 
 # BASE image
 # ----BEGIN----
-FROM php:8-apache as hashtopolis-server-base
+FROM php:8-apache AS hashtopolis-server-base
 
 # Enable possible build args for injecting user commands
 ARG CONTAINER_USER_CMD_PRE
@@ -96,7 +96,7 @@ ENTRYPOINT [ "docker-entrypoint.sh" ]
 
 # DEVELOPMENT Image
 # ----BEGIN----
-FROM hashtopolis-server-base as hashtopolis-server-dev
+FROM hashtopolis-server-base AS hashtopolis-server-dev
 
 # Setting up development requirements, install xdebug
 RUN yes | pecl install xdebug-3.4.0beta1 && docker-php-ext-enable xdebug \
@@ -143,10 +143,13 @@ USER vscode
 
 # PRODUCTION Image
 # ----BEGIN----
-FROM hashtopolis-server-base as hashtopolis-server-prod
+FROM hashtopolis-server-base AS hashtopolis-server-prod
 
 COPY --chown=www-data:www-data ./src/ $HASHTOPOLIS_DOCUMENT_ROOT
 
+# protect install/update directory
+RUN echo "Order deny,allow\nDeny from all" > "${HASHTOPOLIS_DOCUMENT_ROOT}/install/.htaccess"
+
 RUN mv "$PHP_INI_DIR/php.ini-production" "$PHP_INI_DIR/php.ini" \
     && touch "/usr/local/etc/php/conf.d/custom.ini" \
     && echo "memory_limit = 256m" >> /usr/local/etc/php/conf.d/custom.ini \

ci/HashtopolisTestFramework.class.php

@@ -1,6 +1,7 @@
 <?php
 
 use DBA\Factory;
+use Composer\Semver\Comparator;
 
 class HashtopolisTestFramework {
   const REQUEST_CLIENT = 0;
@@ -104,11 +105,11 @@ private function isTestIncluded($instance, $version, $testNames, $runType, $upgr
   if (!empty($testNames) && !in_array(get_class($instance), $testNames)) {
     return false;
   }
-  if (!$upgrade && $version != 'master' && (Util::versionComparison($version, $instance->getMinVersion()) > 0 || $instance->getMinVersion() == 'master')) {
+  if (!$upgrade && $version != 'master' && (Comparator::lessThan($version, $instance->getMinVersion()) > 0 || $instance->getMinVersion() == 'master')) {
     echo "Ignoring " . $instance->getTestName() . ": minimum " . $instance->getMinVersion() . " required, but testing $version...\n";
     return false;
   }
-  if ($instance->getMaxVersion() != 'master' && (Util::versionComparison($version, $instance->getMaxVersion()) < 0 || $version == 'master')) { 
+  if ($instance->getMaxVersion() != 'master' && (Comparator::lessThan($version, $instance->getMaxVersion()) < 0 || $version == 'master')) { 
     echo "Ignoring " . $instance->getTestName() . ": maximum " . $instance->getMaxVersion() . " required, but testing $version...\n";
     return false;
   }

composer.json

@@ -28,7 +28,8 @@
         "slim/psr7": "^1.5",
         "slim/slim": "^4.10",
         "tuupola/slim-basic-auth": "^3.3",
-        "tuupola/slim-jwt-auth": "^3.6"
+        "tuupola/slim-jwt-auth": "^3.6",
+        "composer/semver": "^3.4"
     },
     "require-dev": {
         "jangregor/phpstan-prophecy": "^1.0.0",

src/inc/Util.class.php

@@ -27,6 +27,7 @@
 use DBA\FileDelete;
 use DBA\Factory;
 use DBA\Speed;
+use Composer\Semver\Comparator;
 
 /**
  *
@@ -198,7 +199,7 @@ public static function checkAgentVersion($type, $version, $silent = false) {
     }
     $binary = Factory::getAgentBinaryFactory()->filter([Factory::FILTER => $qF], true);
     if ($binary != null) {
-      if (Util::versionComparison($binary->getVersion(), $version) == 1) {
+      if (Comparator::lessThan($binary->getVersion(), $version) == 1) {
         if (!$silent) {
           echo "update $type version... ";
         }
@@ -941,35 +942,7 @@ public static function getStaticArray($val, $id) {
    * @return int
    */
   public static function versionComparisonBinary($binary1, $binary2) {
-    return Util::versionComparison($binary1->getVersion(), $binary2->getVersion());
-  }
-  
-  /**
-   * @param string $version1
-   * @param string $version2
-   * @return int 1 if version2 is newer, 0 if equal and -1 if version1 is newer
-   */
-  public static function versionComparison($version1, $version2) {
-    $version1 = explode(".", $version1);
-    $version2 = explode(".", $version2);
-    
-    for ($i = 0; $i < sizeof($version1) && $i < sizeof($version2); $i++) {
-      $num1 = (int)$version1[$i];
-      $num2 = (int)$version2[$i];
-      if ($num1 > $num2) {
-        return -1;
-      }
-      else if ($num1 < $num2) {
-        return 1;
-      }
-    }
-    if (sizeof($version1) > sizeof($version2)) {
-      return -1;
-    }
-    else if (sizeof($version1) < sizeof($version2)) {
-      return 1;
-    }
-    return 0;
+    return Comparator::lessThan($binary1->getVersion(), $binary2->getVersion());
   }
 
   /**
@@ -984,7 +957,7 @@ public static function updateVersionComparison($versionString1, $versionString2)
     $version1 = substr($versionString1, 8, strpos($versionString1, "_", 7) - 8);
     $version2 = substr($versionString2, 8, strpos($versionString2, "_", 7) - 8);
 
-    return Util::versionComparison($version2, $version1);
+    return Comparator::lessThan($version2, $version1);
   }
 
   /**

src/inc/api/APICheckClientVersion.class.php

@@ -3,6 +3,7 @@
 use DBA\AgentBinary;
 use DBA\QueryFilter;
 use DBA\Factory;
+use Composer\Semver\Comparator;
 
 class APICheckClientVersion extends APIBasic {
   public function execute($QUERY = array()) {
@@ -23,7 +24,7 @@ public function execute($QUERY = array()) {
     }
 
     $this->updateAgent(PActions::CHECK_CLIENT_VERSION);
-    if (Util::versionComparison($result->getVersion(), $version) == -1) {
+    if (Comparator::lessThan($result->getVersion(), $version) == -1) {
       DServerLog::log(DServerLog::DEBUG, "Agent " . $this->agent->getId() . " got notified about client update");
       $this->sendResponse(array(
           PResponseClientUpdate::ACTION => PActions::CHECK_CLIENT_VERSION,
@@ -42,4 +43,4 @@ public function execute($QUERY = array()) {
       );
     }
   }
-}
+}

src/inc/load.php

@@ -12,6 +12,8 @@
 
 session_start();
 
+require_once(dirname(__FILE__) . "/../../vendor/autoload.php");
+
 require_once(dirname(__FILE__) . "/info.php");
 
 include(dirname(__FILE__) . "/confv2.php");

src/inc/utils/AgentBinaryUtils.class.php

@@ -4,8 +4,10 @@
 use DBA\QueryFilter;
 use DBA\User;
 use DBA\Factory;
+use Composer\Semver\Comparator;
+
+require_once(__DIR__ . "/../apiv2/common/ErrorHandler.class.php");
 
-require_once __DIR__ . '/../apiv2/common/ErrorHandler.class.php';
 class AgentBinaryUtils {
   /**
    * @param string $type
@@ -226,9 +228,9 @@ public static function getAgentUpdate($agent, $track) {
     if (strlen($latest) == 0) {
       throw new HTException("Failed to retrieve latest version!");
     }
-    if (Util::versionComparison($agent->getVersion(), $latest) > 0) {
+    if (Comparator::lessThan($agent->getVersion(), $latest) > 0) {
       return $latest;
     }
     return false;
   }
-}
+}

src/inc/utils/CrackerBinaryUtils.class.php

@@ -3,6 +3,7 @@
 use DBA\CrackerBinary;
 use DBA\QueryFilter;
 use DBA\Factory;
+use Composer\Semver\Comparator;
 
 class CrackerBinaryUtils {
   /**
@@ -16,7 +17,7 @@ public static function getNewestVersion($crackerBinaryTypeId) {
     /** @var $newest CrackerBinary */
     $newest = null;
     foreach ($binaries as $binary) {
-      if ($newest == null || Util::versionComparison($binary->getVersion(), $newest->getVersion()) < 0) {
+      if ($newest == null || Comparator::lessThan($binary->getVersion(), $newest->getVersion()) < 0) {
         $newest = $binary;
       }
     }
@@ -25,4 +26,4 @@ public static function getNewestVersion($crackerBinaryTypeId) {
     }
     return $newest;
   }
-}
+}

src/install/updates/update.php

@@ -3,6 +3,7 @@
 use DBA\LikeFilterInsensitive;
 use DBA\StoredValue;
 use DBA\Factory;
+use Composer\Semver\Comparator;
 
 /*
  * This script should automatically determine the current base function and go through
@@ -46,10 +47,9 @@
   usort($allFiles, array("Util", "updateVersionComparison"));
   foreach ($allFiles as $file) {
     if (Util::startsWith($file, "update_v")) {
-      // check version
-      $minor = Util::getMinorVersion(substr($file, 8, strpos($file, "_", 7) - 8));
-      if (Util::versionComparison($minor, Util::getMinorVersion($storedVersion->getVal())) < 1) {
-        // script needs to be checked
+      $startVersion = substr($file, 8, strpos($file, "_", 7) - 8);
+      if (Comparator::greaterThanOrEqualTo($startVersion, $storedVersion->getVal())) {
+        // script needs to be executed
         include(dirname(__FILE__) . "/" . $file);
       }
     }

src/install/updates/update_v0.14.4_v0.14.5.php

@@ -10,6 +10,13 @@
   $EXECUTED["v0.14.4_agentBinaries"] = true;
 }
 
+if (!isset($PRESENT["v0.14.4_update_agent_binary"])) {
+  if (Util::databaseColumnExists("AgentBinary", "type")) {
+    Factory::getAgentFactory()->getDB()->query("ALTER TABLE `AgentBinary` RENAME COLUMN `type` to `binaryType`;");
+    $EXECUTED["v0.14.4_update_agent_binary"] = true;
+  }
+}
+
 if (!isset($PRESENT["v0.14.4_update_hashtypes"])){
   $hashTypes = [
     new HashType( 1310, "sha224($pass.$salt)", 1, 0),