Add configuration option to configure permissions of local temporary directory (and files)

CHANGELOG.md

@@ -14,9 +14,11 @@ All notable changes to this project will be documented in this file.
 - Fix output of `WithFormatData` in combination with `SkipsEmptyRows` (#3760)
 
 ### Changed
-
+- Cast empty headings to indexed integer
+- Adds `isEmptyWhen` to customize is row empty logic.
 - Cast empty headings to indexed integer (#3646)
 - Adds `isEmptyWhen` to customize is row empty logic. (#3645)
+- Support temporary file and directory rights configuration (#3766)
 
 ### Fixed
 

config/excel.php

@@ -292,9 +292,26 @@
         |
         | When exporting and importing files, we use a temporary file, before
         | storing reading or downloading. Here you can customize that path.
+        | permissions is an array with the permission flags for the directory (dir)
+        | and the create file (file).
         |
         */
-        'local_path'          => storage_path('framework/cache/laravel-excel'),
+        'local_path'        => storage_path('framework/cache/laravel-excel'),
+
+        /*
+        |--------------------------------------------------------------------------
+        | Local Temporary Path Permissions
+        |--------------------------------------------------------------------------
+        |
+        | Permissions is an array with the permission flags for the directory (dir)
+        | and the create file (file).
+        | If omitted the default permissions of the filesystem will be used.
+        |
+        */
+        'local_permissions' => [
+            // 'dir'  => 0770,
+            // 'file' => 0640,
+        ],
 
         /*
         |--------------------------------------------------------------------------
@@ -310,8 +327,8 @@
         | in conjunction with queued imports and exports.
         |
         */
-        'remote_disk'         => null,
-        'remote_prefix'       => null,
+        'remote_disk'   => null,
+        'remote_prefix' => null,
 
         /*
         |--------------------------------------------------------------------------

src/Files/LocalTemporaryFile.php

@@ -15,6 +15,9 @@ class LocalTemporaryFile extends TemporaryFile
     public function __construct(string $filePath)
     {
         touch($filePath);
+        if (($rights = config('excel.temporary_files.local_permissions.file', null)) !== null) {
+            chmod($filePath, $rights);
+        }
 
         $this->filePath = realpath($filePath);
     }

src/Files/TemporaryFileFactory.php

@@ -46,7 +46,7 @@ public function make(string $fileExtension = null): TemporaryFile
      */
     public function makeLocal(string $fileName = null, string $fileExtension = null): LocalTemporaryFile
     {
-        if (!file_exists($this->temporaryPath) && !mkdir($concurrentDirectory = $this->temporaryPath) && !is_dir($concurrentDirectory)) {
+        if (!file_exists($this->temporaryPath) && !mkdir($concurrentDirectory = $this->temporaryPath, config('excel.temporary_files.local_permissions.dir', 0777)) && !is_dir($concurrentDirectory)) {
             throw new \RuntimeException(sprintf('Directory "%s" was not created', $concurrentDirectory));
         }
 

tests/Helpers/FileHelper.php

@@ -8,4 +8,20 @@ public static function absolutePath($fileName, $diskName)
     {
         return config('filesystems.disks.' . $diskName . '.root') . DIRECTORY_SEPARATOR . $fileName;
     }
+
+    public static function recursiveDelete($fileName)
+    {
+        if (is_file($fileName)) {
+            return @unlink($fileName);
+        }
+
+        if (is_dir($fileName)) {
+            $scan = glob(rtrim($fileName, '/') . '/*');
+            foreach ($scan as $path) {
+                self::recursiveDelete($path);
+            }
+
+            return @rmdir($fileName);
+        }
+    }
 }

tests/TemporaryFileTest.php

@@ -0,0 +1,93 @@
+<?php
+
+namespace Maatwebsite\Excel\Tests;
+
+use Maatwebsite\Excel\Files\TemporaryFileFactory;
+use Maatwebsite\Excel\Tests\Helpers\FileHelper;
+
+class TemporaryFileTest extends TestCase
+{
+    private $defaultDirectoryPermissions;
+    private $defaultFilePermissions;
+
+    /**
+     * Setup the test environment.
+     */
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $path = FileHelper::absolutePath('rights-test-permissions', 'local');
+        mkdir($path);
+        $this->defaultDirectoryPermissions = substr(sprintf('%o', fileperms($path)), -4);
+
+        $filePath = $path . DIRECTORY_SEPARATOR . 'file-permissions';
+        touch($filePath);
+        $this->defaultFilePermissions = substr(sprintf('%o', fileperms($filePath)), -4);
+
+        @unlink($filePath);
+        @rmdir($path);
+    }
+
+    /**
+     * @test
+     */
+    public function can_use_default_rights()
+    {
+        $path = FileHelper::absolutePath('rights-test', 'local');
+        FileHelper::recursiveDelete($path);
+
+        config()->set('excel.temporary_files.local_path', $path);
+
+        $temporaryFileFactory = app(TemporaryFileFactory::class);
+
+        $temporaryFile = $temporaryFileFactory->makeLocal(null, 'txt');
+        $temporaryFile->put('data-set');
+
+        $this->assertFileExists($temporaryFile->getLocalPath());
+        $this->assertEquals($this->defaultDirectoryPermissions, substr(sprintf('%o', fileperms(dirname($temporaryFile->getLocalPath()))), -4));
+        $this->assertEquals($this->defaultFilePermissions, substr(sprintf('%o', fileperms($temporaryFile->getLocalPath())), -4));
+    }
+
+    /**
+     * @test
+     */
+    public function can_use_dir_rights()
+    {
+        $path = FileHelper::absolutePath('rights-test', 'local');
+        FileHelper::recursiveDelete($path);
+
+        config()->set('excel.temporary_files.local_path', $path);
+        config()->set('excel.temporary_files.local_permissions.dir', 0700);
+
+        $temporaryFileFactory = app(TemporaryFileFactory::class);
+
+        $temporaryFile = $temporaryFileFactory->makeLocal(null, 'txt');
+        $temporaryFile->put('data-set');
+
+        $this->assertFileExists($temporaryFile->getLocalPath());
+        $this->assertEquals('0700', substr(sprintf('%o', fileperms(dirname($temporaryFile->getLocalPath()))), -4));
+        $this->assertEquals($this->defaultFilePermissions, substr(sprintf('%o', fileperms($temporaryFile->getLocalPath())), -4));
+    }
+
+    /**
+     * @test
+     */
+    public function can_use_file_rights()
+    {
+        $path = FileHelper::absolutePath('rights-test', 'local');
+        FileHelper::recursiveDelete($path);
+
+        config()->set('excel.temporary_files.local_path', $path);
+        config()->set('excel.temporary_files.local_permissions.file', 0600);
+
+        $temporaryFileFactory = app(TemporaryFileFactory::class);
+
+        $temporaryFile = $temporaryFileFactory->makeLocal(null, 'txt');
+        $temporaryFile->put('data-set');
+
+        $this->assertFileExists($temporaryFile->getLocalPath());
+        $this->assertEquals($this->defaultDirectoryPermissions, substr(sprintf('%o', fileperms(dirname($temporaryFile->getLocalPath()))), -4));
+        $this->assertEquals('0600', substr(sprintf('%o', fileperms($temporaryFile->getLocalPath())), -4));
+    }
+}