Separated full and headless instances of Factorio to keep both as they come.

Refactored the download process of the Factorio game.

Author: BluePsyduck

composer.json

@@ -73,8 +73,7 @@
     "test-unit": "phpunit --testsuite unit-test --colors=always --coverage-html=test/coverage --coverage-clover=test/coverage/clover.xml",
     "test-serialize": "phpunit --testsuite serializer-test --colors=always",
     "post-autoload-dump": [
-      "mkdir -p data/cache data/factorio data/log data/mods data/temp data/instances",
-      "chmod 0777 data/cache data/factorio data/log data/mods data/temp data/instances"
+      "mkdir -m a=rwx -p data/cache data/factorio data/factorio/full data/factorio/headless data/log data/mods data/temp data/instances"
     ],
     "test": [
       "@composer validate --strict",

composer.lock

@@ -40,8 +40,6 @@
             Command\ProcessStep\RenderIconsStep::class => AutoWireFactory::class,
             Command\ProcessStep\UploadStep::class => AutoWireFactory::class,
 
-            Factorio\FactorioDownloader::class => AutoWireFactory::class,
-
             Helper\HashCalculator::class => AutoWireFactory::class,
             Helper\ZipArchiveExtractor::class => AutoWireFactory::class,
 
@@ -82,6 +80,7 @@
             Serializer\Handler\ConstructorHandler::class => AutoWireFactory::class,
             Serializer\Handler\RawHandler::class => AutoWireFactory::class,
 
+            Service\FactorioDownloadService::class => AutoWireFactory::class,
             Service\FactorioExecutionService::class => AutoWireFactory::class,
             Service\ModDownloadService::class => AutoWireFactory::class,
             Service\ModFileService::class => AutoWireFactory::class,
@@ -104,9 +103,11 @@
             'int $numberOfParallelDownloads' => readConfig(ConfigKey::MAIN, ConfigKey::PARALLEL_DOWNLOADS),
             'int $numberOfParallelRenderProcesses' => readConfig(ConfigKey::MAIN, ConfigKey::PARALLEL_RENDERS),
 
+            'string $factorioApiToken' => readConfig(ModConfigKey::MAIN, ModConfigKey::OPTIONS, ModConfigKey::OPTION_TOKEN),
+            'string $factorioApiUsername' => readConfig(ModConfigKey::MAIN, ModConfigKey::OPTIONS, ModConfigKey::OPTION_USERNAME),
+            'string $fullFactorioDirectory' => readConfig(ConfigKey::MAIN, ConfigKey::DIRECTORIES, ConfigKey::DIRECTORY_FACTORIO_FULL),
             'string $factorioDirectory' => readConfig(ConfigKey::MAIN, ConfigKey::DIRECTORIES, ConfigKey::DIRECTORY_FACTORIO),
-            'string $factorioDownloadToken' => readConfig(ModConfigKey::MAIN, ModConfigKey::OPTIONS, ModConfigKey::OPTION_TOKEN),
-            'string $factorioDownloadUsername' => readConfig(ModConfigKey::MAIN, ModConfigKey::OPTIONS, ModConfigKey::OPTION_USERNAME),
+            'string $headlessFactorioDirectory' => readConfig(ConfigKey::MAIN, ConfigKey::DIRECTORIES, ConfigKey::DIRECTORY_FACTORIO_HEADLESS),
             'string $instancesDirectory' => readConfig(ConfigKey::MAIN, ConfigKey::DIRECTORIES, ConfigKey::DIRECTORY_INSTANCES),
             'string $logsDirectory' => readConfig(ConfigKey::MAIN, ConfigKey::DIRECTORIES, ConfigKey::DIRECTORY_LOGS),
             'string $modsDirectory' => readConfig(ConfigKey::MAIN, ConfigKey::DIRECTORIES, ConfigKey::DIRECTORY_MODS),

config/autoload/dependencies.global.php

@@ -17,7 +17,8 @@
     ConfigKey::MAIN => [
         ConfigKey::DIRECTORIES => [
 //            ConfigKey::DIRECTORY_CACHE => 'data/cache',
-            ConfigKey::DIRECTORY_FACTORIO => 'data/factorio',
+            ConfigKey::DIRECTORY_FACTORIO_FULL => 'data/factorio/full',
+            ConfigKey::DIRECTORY_FACTORIO_HEADLESS => 'data/factorio/headless',
             ConfigKey::DIRECTORY_INSTANCES => 'data/instances',
             ConfigKey::DIRECTORY_LOGS => 'data/log',
             ConfigKey::DIRECTORY_MODS => 'data/mods',

config/autoload/development/export.local.php

@@ -5,11 +5,13 @@
 namespace FactorioItemBrowser\Export\Command;
 
 use FactorioItemBrowser\Export\Constant\CommandName;
-use FactorioItemBrowser\Export\Factorio\FactorioDownloader;
+use FactorioItemBrowser\Export\Output\Console;
+use FactorioItemBrowser\Export\Service\FactorioDownloadService;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Filesystem\Filesystem;
 
 /**
  * The process for downloading the Factorio game itself.
@@ -19,13 +21,31 @@
  */
 class DownloadFactorioCommand extends Command
 {
-    protected FactorioDownloader $factorioDownloader;
+    protected Console $console;
+    protected FactorioDownloadService $factorioDownloadService;
+    protected Filesystem $fileSystem;
 
-    public function __construct(FactorioDownloader $factorioDownloader)
-    {
+    protected string $fullFactorioDirectory;
+    protected string $headlessFactorioDirectory;
+    protected string $tempDirectory;
+
+    public function __construct(
+        Console $console,
+        FactorioDownloadService $factorioDownloadService,
+        Filesystem $fileSystem,
+        string $fullFactorioDirectory,
+        string $headlessFactorioDirectory,
+        string $tempDirectory,
+    ) {
         parent::__construct();
 
-        $this->factorioDownloader = $factorioDownloader;
+        $this->console = $console;
+        $this->factorioDownloadService = $factorioDownloadService;
+        $this->fileSystem = $fileSystem;
+
+        $this->fullFactorioDirectory = (string) realpath($fullFactorioDirectory);
+        $this->headlessFactorioDirectory = (string) realpath($headlessFactorioDirectory);
+        $this->tempDirectory = (string) realpath($tempDirectory);
     }
 
     protected function configure(): void
@@ -41,8 +61,39 @@ protected function configure(): void
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $version = strval($input->getArgument('version'));
+        $archiveFileFull = $this->tempDirectory . "/factorio_${version}_full.tar.xz";
+        $archiveFileHeadless = $this->tempDirectory . "/factorio_${version}_headless.tar.xz";
+
+        $this->console->writeHeadline("Downloading and installing Factorio version {$version}");
+
+        $this->console->writeAction('Downloading full variant of Factorio');
+        $fullProcess = $this->factorioDownloadService->createFactorioDownloadProcess(
+            FactorioDownloadService::VARIANT_FULL,
+            $version,
+            $archiveFileFull,
+        );
+        $fullProcess->start();
+
+        $this->console->writeAction('Downloading headless variant of Factorio');
+        $headlessProcess = $this->factorioDownloadService->createFactorioDownloadProcess(
+            FactorioDownloadService::VARIANT_HEADLESS,
+            $version,
+            $archiveFileHeadless,
+        );
+        $headlessProcess->run();
+
+        $this->console->writeAction('Extracting headless variant of Factorio');
+        $this->factorioDownloadService->extractFactorio($archiveFileHeadless, $this->headlessFactorioDirectory);
+
+        $fullProcess->wait();
+        $this->console->writeAction('Extracting full variant of Factorio');
+        $this->factorioDownloadService->extractFactorio($archiveFileFull, $this->fullFactorioDirectory);
+
+        $this->console->writeAction('Cleaning up');
+        $this->fileSystem->remove($archiveFileHeadless);
+        $this->fileSystem->remove($archiveFileFull);
 
-        $this->factorioDownloader->download($version);
+        $this->console->writeMessage('Done.');
         return 0;
     }
 }

src/Command/DownloadFactorioCommand.php

@@ -32,6 +32,16 @@ interface ConfigKey
      */
     public const DIRECTORY_FACTORIO = 'factorio';
 
+    /**
+     * The key holding the directory of the installed full Factorio game.
+     */
+    public const DIRECTORY_FACTORIO_FULL = 'factorio-full';
+
+    /**
+     * The key holding the directory of the installed headless Factorio game.
+     */
+    public const DIRECTORY_FACTORIO_HEADLESS = 'factorio-headless';
+
     /**
      * The key holding the instances directory.
      */

src/Constant/ConfigKey.php

@@ -32,6 +32,7 @@ public function __construct(ConsoleSectionOutput $output)
     public function addLine(string $line): self
     {
         $height = min($this->terminal->getHeight() - 6, self::NUMBER_OF_LINES);
+        /** @var positive-int $width */
         $width = $this->terminal->getWidth();
 
         $this->lines = array_slice(array_merge($this->lines, str_split($line, $width)), -$height);