Allow specifying file visibility when creating variants

plank · Dec 11, 2021 · d708b89 · d708b89
1 parent 8bc6efb
commit d708b89
Show file tree

Hide file tree

Showing 5 changed files with 142 additions and 10 deletions.
diff --git a/docs/source/variants.rst b/docs/source/variants.rst
@@ -102,27 +102,39 @@ Output Destination
 
 By default, variants will be created in the same disk and directory as the original file, with a filename that includes the variant name as as suffix. You can choose to customize the output disk, directory and filename.
 
-..
+::
 
     <?php
-    $manipulator->toDisk('uploads');
-    $manipulator->toDirectory('files/variants');
+    $manipulation->toDisk('uploads');
+    $manipulation->toDirectory('files/variants');
 
     // shorthand for the above
-    $manipulator->toDestination('uploads', 'files/variants');
+    $manipulation->toDestination('uploads', 'files/variants');
 
-    $manipulator->useFilename('my-custom-filename');
-    $manipulator->useHashForFilename();
-    $manipulator->useOriginalFilename(); //restore default behaviour
+    $manipulation->useFilename('my-custom-filename');
+    $manipulation->useHashForFilename();
+    $manipulation->useOriginalFilename(); //restore default behaviour
 
 If another file exists at the output destination, the ImageManipulator will attempt to find a unique filename by appending an incrementing number. This can be configured to throw an exception instead if a conflict is discovered.
 
 ::
 
     <?php
-    $manipulator->onDuplicateIncrement(); // default behaviour
-    $manipulator->onDuplicateError();
+    $manipulation->onDuplicateIncrement(); // default behaviour
+    $manipulation->onDuplicateError();
+
+File Visibility
+^^^^^^^^^^^^^^^
+
+By default, newly created variants will use the default filesystem visibility of the destination filesystem disk. To modify this, you may use one of the following methods.
 
+::
+
+    <?php
+    $manipulation->makePrivate();
+    $manipulation->makePublic();
+    // to copy the visibility of the original media file
+    $manipulation->matchOriginalVisibility();
 
 Before Save Callback
 ^^^^^^^^^^^^^^^^^^^^

diff --git a/src/ImageManipulation.php b/src/ImageManipulation.php
@@ -58,6 +58,9 @@ class ImageManipulation
     /** @var string */
     private $onDuplicateBehaviour = self::ON_DUPLICATE_INCREMENT;
 
+    /** @var string|null */
+    private $visibility;
+
     /** @var callable|null */
     private $beforeSave;
 
@@ -322,6 +325,35 @@ public function getOnDuplicateBehaviour(): string
         return $this->onDuplicateBehaviour;
     }
 
+    public function makePrivate(): self
+    {
+        $this->visibility = 'private';
+        return $this;
+    }
+
+    public function makePublic(): self
+    {
+        $this->visibility = 'public';
+        return $this;
+    }
+
+    public function matchOriginalVisibility(): self
+    {
+        $this->visibility = 'match';
+        return $this;
+    }
+
+    public function setVisibility(?string $visibility): self
+    {
+        $this->visibility = $visibility;
+        return $this;
+    }
+
+    public function getVisibility(): ?string
+    {
+        return $this->visibility;
+    }
+
     /**
      * @param callable $beforeSave
      * @return $this

diff --git a/src/ImageManipulator.php b/src/ImageManipulator.php
@@ -134,8 +134,21 @@ public function createImageVariant(
                 ->delete($originalVariant->getDiskPath());
         }
 
+        $visibility = $manipulation->getVisibility();
+        if ($visibility == 'match') {
+            $visibility = ($media->isVisible() ? 'public' : 'private');
+        }
+        $options = [];
+        if ($visibility) {
+            $options = ['visibility' => $visibility];
+        }
+
         $this->filesystem->disk($variant->disk)
-            ->writeStream($variant->getDiskPath(), $outputStream->detach());
+            ->writeStream(
+                $variant->getDiskPath(),
+                $outputStream->detach(),
+                $options
+            );
 
         $variant->save();
 

diff --git a/tests/Integration/ImageManipulationTest.php b/tests/Integration/ImageManipulationTest.php
@@ -106,4 +106,31 @@ public function test_get_duplicate_behaviours()
             $manipulation->getOnDuplicateBehaviour()
         );
     }
+
+    public function test_visibility()
+    {
+        $manipulation = new ImageManipulation($this->getMockCallable());
+        $this->assertNull($manipulation->getVisibility());
+
+        $manipulation->makePublic();
+        $this->assertEquals('public', $manipulation->getVisibility());
+
+        $manipulation->makePrivate();
+        $this->assertEquals('private', $manipulation->getVisibility());
+
+        $manipulation->matchOriginalVisibility();
+        $this->assertEquals('match', $manipulation->getVisibility());
+
+        $manipulation->setVisibility('public');
+        $this->assertEquals('public', $manipulation->getVisibility());
+
+        $manipulation->setVisibility('private');
+        $this->assertEquals('private', $manipulation->getVisibility());
+
+        $manipulation->setVisibility('match');
+        $this->assertEquals('match', $manipulation->getVisibility());
+
+        $manipulation->setVisibility(null);
+        $this->assertNull($manipulation->getVisibility());
+    }
 }
diff --git a/tests/Integration/ImageManipulatorTest.php b/tests/Integration/ImageManipulatorTest.php
@@ -580,6 +580,54 @@ function (Image $image) {
         $this->assertFalse($previousVariant->fileExists());
     }
 
+    public function visibilityProvider()
+    {
+        return [
+            ['uploads', 'public', null, true],
+            ['uploads', 'private', null, true],
+            ['tmp', 'public', null, false],
+            ['tmp', 'private', null, false],
+            ['tmp', 'public', 'match', true],
+            ['tmp', 'private', 'match', false],
+            ['tmp', 'public', 'private', false],
+            ['tmp', 'private', 'public', true]
+        ];
+    }
+
+    /** @dataProvider visibilityProvider */
+    public function test_variant_created_with_visibility(
+        string $disk,
+        string $originalVisibility,
+        ?string $manipulationVisibility,
+        bool $expectedVisibility
+    ) {
+        $this->useFilesystem($disk);
+        $this->useDatabase();
+
+        $media = $this->makeMedia(
+            [
+                'disk' => $disk,
+                'directory' => 'foo',
+                'filename' => 'bar',
+                'extension' => 'png',
+                'mime_type' => 'image/png',
+                'aggregate_type' => 'image'
+            ]
+        );
+        $this->seedFileForMedia($media, $this->sampleFile());
+        $originalVisibility == 'public' ? $media->makePublic() : $media->makePrivate();
+
+        $manipulation = ImageManipulation::make($this->getMockCallable())
+            ->setVisibility($manipulationVisibility)
+            ->toDisk($disk);
+
+        $imageManipulator = $this->getManipulator();
+        $imageManipulator->defineVariant('test', $manipulation);
+
+        $result = $imageManipulator->createImageVariant($media, 'test', true);
+        $this->assertSame($expectedVisibility, $result->isVisible());
+    }
+
     public function getManipulator(): ImageManipulator
     {
         return new ImageManipulator(