Merge pull request #128 from aternosorg/code-of-conduct-folder-missing-problem

Add `CodeOfConductFolderMissingProblem` and `FolderCreateSolution`

Author: pavog

lang/en.json

@@ -41,6 +41,7 @@
   "plugin-remove-solution": "Remove the plugin '{{plugin-name}}'.",
   "file-delete-solution": "Delete the file '{{file-path}}'.",
   "file-edit-solution": "Edit the file '{{file-path}}'.",
+  "folder-create-solution": "Create the folder '{{folder-path}}'.",
   "mod-install-different-version-solution": "Install a different version of the mod '{{mod-name}}'.",
   "mod-install-solution": "Install the mod '{{mod-name}}'.",
   "mod-install-solution-with-version": "Install the mod '{{mod-name}}' with version {{mod-version}}.",
@@ -59,6 +60,7 @@
   "forge-install-different-version-solution": "Install a different Forge version.",
   "malformed-encoding-problem": "Something (probably the MOTD) contains malformed formatting codes.",
   "change-motd-solution": "Change the server MOTD.",
+  "code-of-conduct-folder-missing-problem": "The Code of Conduct folder does not exist.",
   "bedrock-authentication-whitelist-problem": "Using a whitelist without online authentication is not allowed.",
   "bedrock-authentication-allowlist-problem": "Using an allowlist without online authentication is not allowed.",
   "disable-whitelist-solution": "Disable the whitelist.",

src/Analyser/VanillaAnalyser.php

@@ -5,6 +5,7 @@
 use Aternos\Codex\Minecraft\Analysis\Information\Vanilla\VanillaVersionInformation;
 use Aternos\Codex\Minecraft\Analysis\Problem\Vanilla\AquaticWorldOnOlderVersionProblem;
 use Aternos\Codex\Minecraft\Analysis\Problem\Vanilla\AuthServerProblem;
+use Aternos\Codex\Minecraft\Analysis\Problem\Vanilla\CodeOfConductFolderMissingProblem;
 use Aternos\Codex\Minecraft\Analysis\Problem\Vanilla\MalformedEncodingProblem;
 use Aternos\Codex\Minecraft\Analysis\Problem\Vanilla\OldPlayerDirectoryProblem;
 use Aternos\Codex\Minecraft\Analysis\Problem\Vanilla\OverworldSettingsMissingProblem;
@@ -14,13 +15,13 @@ class VanillaAnalyser extends MinecraftAnalyser
 {
     public function __construct()
     {
-        $this->addPossibleInsightClass(VanillaVersionInformation::class);
-
-        $this->addPossibleInsightClass(OldPlayerDirectoryProblem::class);
         $this->addPossibleInsightClass(AquaticWorldOnOlderVersionProblem::class);
-        $this->addPossibleInsightClass(TickingBlockEntityProblem::class);
-        $this->addPossibleInsightClass(MalformedEncodingProblem::class);
         $this->addPossibleInsightClass(AuthServerProblem::class);
+        $this->addPossibleInsightClass(CodeOfConductFolderMissingProblem::class);
+        $this->addPossibleInsightClass(MalformedEncodingProblem::class);
+        $this->addPossibleInsightClass(OldPlayerDirectoryProblem::class);
         $this->addPossibleInsightClass(OverworldSettingsMissingProblem::class);
+        $this->addPossibleInsightClass(TickingBlockEntityProblem::class);
+        $this->addPossibleInsightClass(VanillaVersionInformation::class);
     }
-}
+}

src/Analysis/Problem/Fabric/FabricDuplicateModProblem.php

@@ -35,4 +35,4 @@ public function setMatches(array $matches, mixed $patternKey): void
         $this->setModName($matches[3]);
         $this->addSolution(new FileDeleteSolution($matches[4], FilePathType::ABSOLUTE));
     }
-}
+}

src/Analysis/Problem/Vanilla/CodeOfConductFolderMissingProblem.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace Aternos\Codex\Minecraft\Analysis\Problem\Vanilla;
+
+use Aternos\Codex\Minecraft\Analysis\Solution\Folder\FolderCreateSolution;
+use Aternos\Codex\Minecraft\Translator\Translator;
+
+class CodeOfConductFolderMissingProblem extends VanillaProblem
+{
+    /**
+     * @inheritDoc
+     */
+    public function getMessage(): string
+    {
+        return Translator::getInstance()->getTranslation("code-of-conduct-folder-missing-problem");
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public static function getPatterns(): array
+    {
+        return [
+            '/Failed to start the minecraft server\njava\.lang\.IllegalArgumentException\: Code of Conduct folder does not exist: (.*)/'
+        ];
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function setMatches(array $matches, mixed $patternKey): void
+    {
+        // usually "codeofconduct"
+        $folder = $matches[1];
+        $this->addSolution(new FolderCreateSolution($folder));
+    }
+}

src/Analysis/Solution/Bukkit/Plugin/AuthMeShutdownSolution.php

@@ -25,4 +25,4 @@ public function getMessage(): string
     {
         return parent::getMessage() . " " . Translator::getInstance()->getTranslation("authme-shutdown-solution");
     }
-}
+}

src/Analysis/Solution/File/FileEditSolution.php

@@ -79,4 +79,4 @@ public function processEdit(string $fileContent): ?string
     {
         return preg_replace($this->getPattern(), $this->getReplacement(), $fileContent);
     }
-}
+}

src/Analysis/Solution/File/FilePathType.php

@@ -6,4 +6,4 @@ enum FilePathType
 {
     case RELATIVE;
     case ABSOLUTE;
-}
+}

src/Analysis/Solution/File/FileSolution.php

@@ -86,4 +86,4 @@ public function isAbsolutePath(): bool
     {
         return $this->getType() === FilePathType::ABSOLUTE;
     }
-}
+}

src/Analysis/Solution/Folder/FolderCreateSolution.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Aternos\Codex\Minecraft\Analysis\Solution\Folder;
+
+use Aternos\Codex\Analysis\AutomatableSolutionInterface;
+use Aternos\Codex\Minecraft\Translator\Translator;
+
+class FolderCreateSolution extends FolderSolution implements AutomatableSolutionInterface
+{
+    /**
+     * @inheritDoc
+     */
+    public function getMessage(): string
+    {
+        return Translator::getInstance()->getTranslation("folder-create-solution", ["folder-path" => $this->getPath()]);
+    }
+}

src/Analysis/Solution/Folder/FolderSolution.php

@@ -0,0 +1,90 @@
+<?php
+
+namespace Aternos\Codex\Minecraft\Analysis\Solution\Folder;
+
+use Aternos\Codex\Minecraft\Analysis\Solution\File\FilePathType;
+use Aternos\Codex\Minecraft\Analysis\Solution\MinecraftSolution;
+
+abstract class FolderSolution extends MinecraftSolution
+{
+    /**
+     * @param string $path The relative path (without a starting slash) or absolute path to the folder.
+     *                     If the path is relative, it will be treated as relative to the Minecraft server root directory.
+     * @param FilePathType $type Is the path relative or absolute?
+     */
+    public function __construct(
+        protected string   $path,
+        protected FilePathType $type = FilePathType::RELATIVE
+    )
+    {
+    }
+
+    /**
+     * Set the relative path
+     * The path is relative to the Minecraft server root directory without a starting slash
+     *
+     * @param string $path
+     * @return $this
+     */
+    public function setRelativePath(string $path): static
+    {
+        $this->path = $path;
+        $this->type = FilePathType::RELATIVE;
+        return $this;
+    }
+
+    /**
+     * Set the absolute path
+     *
+     * @param string $path
+     * @return $this
+     */
+    public function setAbsolutePath(string $path): static
+    {
+        $this->path = $path;
+        $this->type = FilePathType::ABSOLUTE;
+        return $this;
+    }
+
+    /**
+     * Get the path
+     * If isRelative() the path is relative to the Minecraft server root directory without a starting slash
+     *
+     * @return string
+     */
+    public function getPath(): string
+    {
+        return $this->path;
+    }
+
+    /**
+     * Get the type of the path (absolute or relative)
+     *
+     * @return FilePathType
+     */
+    public function getType(): FilePathType
+    {
+        return $this->type;
+    }
+
+    /**
+     * Check if the path is relative
+     * The path is relative to the Minecraft server root directory without a starting slash
+     *
+     * @return bool
+     */
+    public function isRelative(): bool
+    {
+        return $this->getType() === FilePathType::RELATIVE;
+    }
+
+    /**
+     * Check if the path is absolute
+     *
+     * @return bool
+     */
+    public function isAbsolutePath(): bool
+    {
+        return $this->getType() === FilePathType::ABSOLUTE;
+    }
+}