Add config option to disable mod API

TechnicPack · Aug 25, 2022 · 0d7c3c4 · 0d7c3c4
1 parent 5f20c06
commit 0d7c3c4
Show file tree

Hide file tree

Showing 3 changed files with 55 additions and 4 deletions.
diff --git a/app/Http/Controllers/ApiController.php b/app/Http/Controllers/ApiController.php
@@ -101,6 +101,10 @@ public function getModpackBuild($modpackSlug, $buildName)
 
     public function getMod($modSlug = null, $version = null)
     {
+        if (config('solder.disable_mod_api')) {
+            return response()->json(['error' => 'Mod API has been disabled'], 404);
+        }
+
         if (empty($modSlug)) {
             $mods = Cache::remember('mods', now()->addMinutes(5), function () {
                 return Mod::pluck('pretty_name', 'name');

diff --git a/config/solder.php b/config/solder.php
@@ -40,4 +40,12 @@
      **/
     'md5_file_timeout' => intval(env('SOLDER_MD5_FILE_TIMEOUT', '30')),
 
+    /**
+     * Disable mod API functionality?
+     *
+     * Setting this to true will disable the /mod endpoints in the API responses. You usually don't need to
+     * mess with this, but you might want to disable the mod API functionalities for privacy reasons.
+     */
+    'disable_mod_api' => filter_var(env('SOLDER_DISABLE_MOD_API', 'false'), FILTER_VALIDATE_BOOLEAN),
+
 ];
diff --git a/tests/Unit/ApiTest.php b/tests/Unit/ApiTest.php
@@ -38,9 +38,15 @@ public function test_modpack()
 
     public function test_mod()
     {
+        config()->set('solder.disable_mod_api', false);
         $response = $this->get('api/mod');
         $response->assertOk();
         $response->assertJsonStructure(['mods']);
+
+        config()->set('solder.disable_mod_api', true);
+        $response = $this->get('api/mod');
+        $response->assertNotFound();
+        $response->assertJson(['error' => 'Mod API has been disabled']);
     }
 
     public function test_invalid_modpack()
@@ -74,14 +80,22 @@ public function test_modpack_slug()
 
     public function test_invalid_mod()
     {
+        config()->set('solder.disable_mod_api', false);
         $response = $this->get('api/mod/bob');
         $response->assertNotFound();
         $response->assertJson(['error' => 'Mod does not exist']);
+
+        config()->set('solder.disable_mod_api', true);
+        $response = $this->get('api/mod/bob');
+        $response->assertNotFound();
+        $response->assertJson(['error' => 'Mod API has been disabled']);
     }
 
     public function test_mod_slug()
     {
         $mod = Mod::find(1);
+
+        config()->set('solder.disable_mod_api', false);
         $response = $this->get('api/mod/'.$mod->name);
         $response->assertOk();
         $response->assertJsonStructure([
@@ -92,6 +106,11 @@ public function test_mod_slug()
             'link',
             'versions',
         ]);
+
+        config()->set('solder.disable_mod_api', true);
+        $response = $this->get('api/mod/'.$mod->name);
+        $response->assertNotFound();
+        $response->assertJson(['error' => 'Mod API has been disabled']);
     }
 
     public function test_modpack_build()
@@ -113,27 +132,47 @@ public function test_mod_version()
     {
         $mod = Mod::find(1);
         $modversion = $mod->versions->first();
+
+        config()->set('solder.disable_mod_api', false);
         $response = $this->get('api/mod/'.$mod->name.'/'.$modversion->version);
         $response->assertOk();
-        $response->assertJsonStructure([
-            'md5',
-            'filesize',
-            'url',
+        $response->assertJson([
+            'md5' => $modversion->md5,
+            'filesize' => $modversion->filesize,
+            'url' => $modversion->url,
         ]);
+
+        config()->set('solder.disable_mod_api', true);
+        $response = $this->get('api/mod/'.$mod->name.'/'.$modversion->version);
+        $response->assertNotFound();
+        $response->assertJson(['error' => 'Mod API has been disabled']);
     }
 
     public function test_modversion_with_invalid_mod()
     {
+        config()->set('solder.disable_mod_api', false);
         $response = $this->get('api/mod/foo/bar');
         $response->assertNotFound();
         $response->assertJson(['error' => 'Mod does not exist']);
+
+        config()->set('solder.disable_mod_api', true);
+        $response = $this->get('api/mod/foo/bar');
+        $response->assertNotFound();
+        $response->assertJson(['error' => 'Mod API has been disabled']);
     }
 
     public function test_invalid_modversion()
     {
         $mod = Mod::find(1);
+
+        config()->set('solder.disable_mod_api', false);
         $response = $this->get('api/mod/'.$mod->name.'/invalid');
         $response->assertNotFound();
         $response->assertJson(['error' => 'Mod version does not exist']);
+
+        config()->set('solder.disable_mod_api', true);
+        $response = $this->get('api/mod/'.$mod->name.'/invalid');
+        $response->assertNotFound();
+        $response->assertJson(['error' => 'Mod API has been disabled']);
     }
 }