Fix case when key is subsequently commented out

Author: paulbalandan

system/Commands/Encryption/GenerateKey.php

@@ -163,18 +163,24 @@ protected function writeNewEncryptionKeyToFile(string $oldKey, string $newKey):
             copy($baseEnv, $envFile);
         }
 
-        $envFileContents = (string) file_get_contents($envFile);
+        $oldFileContents = (string) file_get_contents($envFile);
         $replacementKey  = "\nencryption.key = {$newKey}";
 
-        if (strpos($envFileContents, 'encryption.key') === false) {
+        if (strpos($oldFileContents, 'encryption.key') === false) {
             return file_put_contents($envFile, $replacementKey, FILE_APPEND) !== false;
         }
 
-        return file_put_contents($envFile, preg_replace(
-            $this->keyPattern($oldKey),
-            $replacementKey,
-            $envFileContents
-        )) !== false;
+        $newFileContents = preg_replace($this->keyPattern($oldKey), $replacementKey, $oldFileContents);
+
+        if ($newFileContents === $oldFileContents) {
+            $newFileContents = preg_replace(
+                '/^[#\s]*encryption.key[=\s]*(?:hex2bin\:[a-f0-9]{64}|base64\:(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?)$/m',
+                $replacementKey,
+                $oldFileContents
+            );
+        }
+
+        return file_put_contents($envFile, $newFileContents) !== false;
     }
 
     /**

tests/system/Commands/GenerateKeyTest.php

@@ -128,4 +128,40 @@ public function testKeyGenerateWhenKeyIsMissingInDotEnvFile()
         $this->assertStringContainsString('Application\'s new encryption key was successfully set.', $this->getBuffer());
         $this->assertSame("\nencryption.key = " . env('encryption.key'), file_get_contents($this->envPath));
     }
+
+    public function testKeyGenerateWhenNewHexKeyIsSubsequentlyCommentedOut()
+    {
+        command('key:generate');
+        $key = env('encryption.key', '');
+        file_put_contents($this->envPath, str_replace(
+            'encryption.key = ' . $key,
+            '# encryption.key = ' . $key,
+            file_get_contents($this->envPath),
+            $count
+        ));
+        $this->assertSame(1, $count, 'Failed commenting out the previously set application key.');
+
+        CITestStreamFilter::$buffer = '';
+        command('key:generate --force');
+        $this->assertStringContainsString('was successfully set.', $this->getBuffer());
+        $this->assertNotSame($key, env('encryption.key', $key), 'Failed replacing the commented out key.');
+    }
+
+    public function testKeyGenerateWhenNewBase64KeyIsSubsequentlyCommentedOut()
+    {
+        command('key:generate --prefix base64');
+        $key = env('encryption.key', '');
+        file_put_contents($this->envPath, str_replace(
+            'encryption.key = ' . $key,
+            '# encryption.key = ' . $key,
+            file_get_contents($this->envPath),
+            $count
+        ));
+        $this->assertSame(1, $count, 'Failed commenting out the previously set application key.');
+
+        CITestStreamFilter::$buffer = '';
+        command('key:generate --force');
+        $this->assertStringContainsString('was successfully set.', $this->getBuffer());
+        $this->assertNotSame($key, env('encryption.key', $key), 'Failed replacing the commented out key.');
+    }
 }