Merge pull request #21 from factorio-item-browser/bugfix/mod-extract

bugfix/mod-extract

Author: BluePsyduck

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 2.0.7 - 2020-05-23
+
+### Fixed
+
+- Failing to correctly detect the directory within the mod files for certain mods.
+
 ## 2.0.6 - 2020-05-15
 
 ### Fixed

composer.lock

@@ -17,5 +17,5 @@
     ConfigAggregator::ENABLE_CACHE => true,
     'debug' => false,
     'name' => 'Factorio Item Browser - Export',
-    'version' => '2.0.6',
+    'version' => '2.0.7',
 ];

config/autoload/base.global.php

@@ -259,7 +259,7 @@ protected function handleProcessFinish(ModDownloadProcess $process): void
         }
 
         $this->console->writeAction(sprintf('Extracting %s', $process->getMod()->getName()));
-        $this->modFileManager->extractModZip($process->getDestinationFile());
+        $this->modFileManager->extractModZip($process->getMod()->getName(), $process->getDestinationFile());
         unlink($process->getDestinationFile());
     }
 }

src/Mod/ModDownloader.php

@@ -27,11 +27,6 @@ class ModFileManager
      */
     protected const FILENAME_INFO = 'info.json';
 
-    /**
-     * The regular expression used to match the mod directory.
-     */
-    protected const REGEXP_MOD_DIRECTORY = '#^(.*)_\d+\.\d+\.\d+/#';
-
     /**
      * The serializer.
      * @var SerializerInterface
@@ -65,10 +60,11 @@ public function __construct(SerializerInterface $exportSerializer, string $facto
 
     /**
      * Extracts the zip file into the working directory of the mods.
+     * @param string $modName
      * @param string $modZipPath
-     * @throws ExportException
+     * @throws InvalidModFileException
      */
-    public function extractModZip(string $modZipPath): void
+    public function extractModZip(string $modName, string $modZipPath): void
     {
         $zipArchive = new ZipArchive();
         $success = $zipArchive->open($modZipPath);
@@ -77,26 +73,20 @@ public function extractModZip(string $modZipPath): void
         }
 
         try {
-            $firstStat = $zipArchive->statIndex(0);
-            if ($firstStat === false || preg_match(self::REGEXP_MOD_DIRECTORY, $firstStat['name'], $match) !== 1) {
-                throw new InvalidModFileException($modZipPath, 'Unable to determine mod directory.');
-            }
-            $modDirectory = $match[0];
-            $modDirectoryLength = strlen($modDirectory);
-            $modName = $match[1];
-
             $this->removeModDirectory($modName);
 
             $targetDirectory = $this->getLocalDirectory($modName);
             mkdir($targetDirectory, 0777, true);
             for ($i = 0; $i < $zipArchive->numFiles; ++$i) {
                 $stat = $zipArchive->statIndex($i);
+
                 if (
                     $stat !== false
                     && substr($stat['name'], -1) !== '/' // Ignore directories
-                    && substr($stat['name'], 0, $modDirectoryLength) === $modDirectory
+                    && strpos($stat['name'], '/') !== false
                 ) {
-                    $fileName = $targetDirectory . '/' . substr($stat['name'], $modDirectoryLength);
+                    $fileName = $targetDirectory . substr($stat['name'], strpos($stat['name'], '/'));
+
                     if (!is_dir(dirname($fileName))) {
                         mkdir(dirname($fileName), 0777, true);
                     }

src/Mod/ModFileManager.php

@@ -584,7 +584,7 @@ public function testHandleProcessFinish(): void
 
         $this->modFileManager->expects($this->once())
                              ->method('extractModZip')
-                             ->with($this->identicalTo($destinationFile));
+                             ->with($this->identicalTo($modName), $this->identicalTo($destinationFile));
 
         $this->assertTrue($directory->hasChild('test.zip'));
 

test/asset/mod/invalidDirectory.zip

@@ -86,7 +86,7 @@ public function testExtractModZip(): void
                 ->with($this->identicalTo($expectedModName))
                 ->willReturn($targetDirectory);
 
-        $manager->extractModZip(__DIR__ . '/../../asset/mod/valid.zip');
+        $manager->extractModZip('foo', __DIR__ . '/../../asset/mod/valid.zip');
 
         $this->assertSame('abc', file_get_contents(vfsStream::url('root/foo/abc')));
         $this->assertSame('def', file_get_contents(vfsStream::url('root/foo/def')));
@@ -105,7 +105,7 @@ public function testExtractModZipWithInvalidZip(): void
         $this->expectException(InvalidModFileException::class);
 
         $manager = new ModFileManager($this->serializer, 'foo', 'bar');
-        $manager->extractModZip(__DIR__ . '/../../asset/mod/invalid.zip');
+        $manager->extractModZip('foo', __DIR__ . '/../../asset/mod/invalid.zip');
     }
 
     /**
@@ -118,7 +118,7 @@ public function testExtractModZipWithInvalidModDirectory(): void
         $this->expectException(InvalidModFileException::class);
 
         $manager = new ModFileManager($this->serializer, 'foo', 'bar');
-        $manager->extractModZip(__DIR__ . '/../../asset/mod/invalidDirectory.zip');
+        $manager->extractModZip('foo', __DIR__ . '/../../asset/mod/invalidDirectory.zip');
     }
 
     /**