pkp#7131 Refactor file service to use Laravel container

api/v1/submissions/PKPSubmissionFileHandler.inc.php

@@ -14,6 +14,8 @@
  *
  */
 
+use Illuminate\Support\Facades\App;
+use PKP\core\FileServiceProvider;
 use PKP\file\FileManager;
 use PKP\handler\APIHandler;
 use PKP\security\authorization\ContextAccessPolicy;
@@ -27,6 +29,8 @@
 
 class PKPSubmissionFileHandler extends APIHandler
 {
+    protected FileServiceProvider $fileService;
+
     /**
      * Constructor
      */
@@ -69,6 +73,8 @@ public function __construct()
             ],
         ];
         parent::__construct();
+
+        $this->fileService = App::make(FileServiceProvider::class);
     }
 
     //
@@ -267,7 +273,7 @@ public function add($slimRequest, $response, $args)
         $extension = $fileManager->parseFileExtension($_FILES['file']['name']);
 
         $submissionDir = Services::get('submissionFile')->getSubmissionDir($request->getContext()->getId(), $submission->getId());
-        $fileId = Services::get('file')->add(
+        $fileId = $this->fileService->add(
             $_FILES['file']['tmp_name'],
             $submissionDir . '/' . uniqid() . '.' . $extension
         );
@@ -389,7 +395,7 @@ public function edit($slimRequest, $response, $args)
             $fileManager = new FileManager();
             $extension = $fileManager->parseFileExtension($_FILES['file']['name']);
             $submissionDir = Services::get('submissionFile')->getSubmissionDir($request->getContext()->getId(), $submission->getId());
-            $fileId = Services::get('file')->add(
+            $fileId = $this->fileService->add(
                 $_FILES['file']['tmp_name'],
                 $submissionDir . '/' . uniqid() . '.' . $extension
             );

classes/core/AppServiceProvider.inc.php

@@ -19,7 +19,11 @@
 use APP\core\Application;
 use APP\core\Services;
 use Illuminate\Support\ServiceProvider;
+use League\Flysystem\Adapter\Local;
+use League\Flysystem\Filesystem;
+use PKP\config\Config;
 use PKP\context\Context;
+use PKP\file\FileManager;
 use PKP\services\PKPSchemaService;
 
 class AppServiceProvider extends ServiceProvider
@@ -48,5 +52,34 @@ public function register()
         $this->app->bind(Context::class, function ($app) {
             return Application::get()->getRequest()->getContext();
         });
+
+        // Register the file service with a local file system adaptor
+        $this->app->singleton(FileServiceProvider::class, function ($app) {
+            return new FileServiceProvider(
+                $app->make(Filesystem::class)
+            );
+        });
+        $this->app->singleton(Filesystem::class, function ($app) {
+            return new Filesystem(
+                $app->make(Local::class)
+            );
+        });
+        $this->app->singleton(Local::class, function ($app) {
+            return new Local(
+                Config::getVar('files', 'files_dir'),
+                LOCK_EX,
+                Local::DISALLOW_LINKS,
+                [
+                    'file' => [
+                        'public' => FileManager::FILE_MODE_MASK,
+                        'private' => FileManager::FILE_MODE_MASK,
+                    ],
+                    'dir' => [
+                        'public' => FileManager::DIRECTORY_MODE_MASK,
+                        'private' => FileManager::DIRECTORY_MODE_MASK,
+                    ]
+                ]
+            );
+        });
     }
 }

classes/services/PKPFileService.inc.php → classes/core/FileServiceProvider.inc.php

@@ -1,69 +1,45 @@
 <?php
 /**
- * @file classes/services/PKPFileService.php
+ * @file classes/core/FileServiceProvider.php
  *
  * Copyright (c) 2014-2021 Simon Fraser University
  * Copyright (c) 2000-2021 John Willinsky
  * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
  *
- * @class PKPFileService
- * @ingroup services
+ * @class FileServiceProvider
+ * @ingroup core
  *
- * @brief Helper class that encapsulates business logic for publications
+ * @brief Provides methods to read and write to file storage. Uses Flysystem
+ * to support storage adaptors for local and remote file systems.
+ *
+ * @see AppServiceProvider::register
+ * @see https://flysystem.thephpleague.com
  */
 
-namespace PKP\services;
+namespace PKP\core;
 
 use APP\core\Application;
 use Exception;
 use Illuminate\Support\Facades\DB;
 
-use League\Flysystem\Adapter\Local;
-
 use League\Flysystem\Filesystem;
-use PKP\config\Config;
 use PKP\file\FileManager;
 use PKP\plugins\HookRegistry;
+use stdClass;
 
-class PKPFileService
+class FileServiceProvider
 {
-    /** @var Filesystem */
-    public $fs;
+    public FileSystem $fs;
 
-    /**
-     * Initialize and configure flysystem
-     */
-    public function __construct()
+    public function __construct(FileSystem $fs)
     {
-        $adapter = new Local(
-            Config::getVar('files', 'files_dir'),
-            LOCK_EX,
-            Local::DISALLOW_LINKS,
-            [
-                'file' => [
-                    'public' => FileManager::FILE_MODE_MASK,
-                    'private' => FileManager::FILE_MODE_MASK,
-                ],
-                'dir' => [
-                    'public' => DIRECTORY_MODE_MASK,
-                    'private' => DIRECTORY_MODE_MASK,
-                ]
-            ]
-        );
-
-        HookRegistry::call('File::adapter', [&$adapter, $this]);
-
-        $this->fs = new Filesystem($adapter);
+        $this->fs = $fs;
     }
 
     /**
      * Get a file by its id
-     *
-     * @param int $id
-     *
-     * @return stdObject
      */
-    public function get($id)
+    public function get(int $id): stdClass
     {
         $file = DB::table('files')
             ->where('file_id', '=', $id)
@@ -78,9 +54,9 @@ public function get($id)
      * @param string $from absolute path to file
      * @param string $to relative path in file dir
      *
-     * @return int file id
+     * @return int The new file id
      */
-    public function add($from, $to)
+    public function add(string $from, string $to): int
     {
         $stream = fopen($from, 'r+');
         if (!$stream) {
@@ -110,12 +86,8 @@ public function add($from, $to)
 
     /**
      * Delete an uploaded file
-     *
-     * @param int $id
-     *
-     * @return File
      */
-    public function delete($id)
+    public function delete(int $id)
     {
         $file = $this->get($id);
         if (!$file) {
@@ -140,7 +112,7 @@ public function delete($id)
      * @param string $filename Filename to give to the downloaded file
      * @param boolean $inline Whether to stream the file to the browser
      */
-    public function download($fileId, $filename, $inline = false)
+    public function download(int $fileId, string $filename, $inline = false)
     {
         $file = $this->get($fileId);
         $dispatcher = Application::get()->getRequest()->getDispatcher();
@@ -164,7 +136,7 @@ public function download($fileId, $filename, $inline = false)
         header("Content-Type: ${mimetype}");
         header("Content-Length: ${filesize}");
         header('Accept-Ranges: none');
-        header('Content-Disposition: ' . ($inline ? 'inline' : 'attachment') . ";filename=\"$encodedFilename\";filename*=UTF-8''\"$encodedFilename\"");
+        header('Content-Disposition: ' . ($inline ? 'inline' : 'attachment') . ";filename=\"${encodedFilename}\";filename*=UTF-8''\"${encodedFilename}\"");
         header('Cache-Control: private'); // Workarounds for IE weirdness
         header('Pragma: public');
 
@@ -177,10 +149,8 @@ public function download($fileId, $filename, $inline = false)
      *
      * @param string $path Path to the file
      * @param string $filename Source filename to sanitize
-     *
-     * @return string
      */
-    public function formatFilename($path, $filename)
+    public function formatFilename(string $path, string $filename): string
     {
         $extension = strtolower(pathinfo($path, PATHINFO_EXTENSION));
         $newFilename = $filename;
@@ -196,11 +166,9 @@ public function formatFilename($path, $filename)
     /**
      * Get document type based on the mimetype
      *
-     * @param string $mimetype
-     *
      * @return string One of the FileManager::DOCUMENT_TYPE_ constants
      */
-    public function getDocumentType($mimetype)
+    public function getDocumentType(string $mimetype): string
     {
         switch ($mimetype) {
             case 'application/pdf':
@@ -260,13 +228,11 @@ public function getDocumentType($mimetype)
     /**
      * Get a pretty file size string
      *
-     * Examples: 82B, 12KB, 2MB, 2GB
-     *
      * @param integer $size File size in bytes
      *
-     * @return string
+     * @return string Examples: 82B, 12KB, 2MB, 2GB
      */
-    public function getNiceFileSize($size)
+    public function getNiceFileSize(int $size): string
     {
         $niceFileSizeUnits = ['B', 'KB', 'MB', 'GB'];
         for ($i = 0; $i < 4 && $size > 1024; $i++) {

classes/file/PKPFile.inc.php

@@ -15,7 +15,8 @@
 
 namespace PKP\file;
 
-use APP\core\Services;
+use Illuminate\Support\Facades\App;
+use PKP\core\FileServiceProvider;
 
 class PKPFile extends \PKP\core\DataObject
 {
@@ -124,10 +125,12 @@ public function setFileSize($fileSize)
      * Return pretty file size string (in B, KB, MB, or GB units).
      *
      * @return string
+     *
+     * @deprecated 3.4
      */
     public function getNiceFileSize()
     {
-        return Services::get('file')->getNiceFileSize($this->getFileSize());
+        return App::make(FileServiceProvider::class)->getNiceFileSize($this->getFileSize());
     }
 
 

classes/install/Installer.inc.php

@@ -20,11 +20,13 @@
 use APP\i18n\AppLocale;
 
 use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\App;
 use Illuminate\Support\Facades\DB;
 use Illuminate\Support\Facades\Schema;
 use PKP\cache\CacheManager;
 use PKP\config\Config;
 use PKP\core\Core;
+use PKP\core\FileServiceProvider;
 use PKP\core\PKPApplication;
 use PKP\db\DAORegistry;
 use PKP\db\DBDataXMLParser;
@@ -100,6 +102,8 @@ class Installer
     /** @var array List of migrations executed already */
     public $migrations = [];
 
+    protected FileServiceProvider $fileService;
+
     /**
      * Constructor.
      *
@@ -123,6 +127,7 @@ public function __construct($descriptor, $params = [], $isPlugin = false)
             $this->sql = [];
             $this->notes = [];
             $this->wroteConfig = true;
+            $this->fileService = App::make(FileServiceProvider::class);
         }
     }
 

classes/migration/upgrade/PKPv3_3_0UpgradeMigration.inc.php

@@ -17,13 +17,14 @@
 use APP\core\Services;
 use Illuminate\Database\Migrations\Migration;
 use Illuminate\Database\Schema\Blueprint;
-
+use Illuminate\Support\Facades\App;
 use Illuminate\Support\Facades\DB;
 use Illuminate\Support\Facades\Schema;
 use PKP\config\Config;
+use PKP\core\FileServiceProvider;
 use PKP\db\DAORegistry;
-use PKP\db\XMLDAO;
 
+use PKP\db\XMLDAO;
 use PKP\file\FileManager;
 use PKP\submission\SubmissionFile;
 
@@ -357,7 +358,6 @@ private function _migrateSubmissionFiles()
                 'date_uploaded',
                 'original_file_name'
             ]);
-        $fileService = Services::get('file');
         $submissionFileService = Services::get('submissionFile');
         foreach ($rows as $row) {
             // Reproduces the removed method SubmissionFile::_generateFileName()
@@ -378,6 +378,7 @@ private function _migrateSubmissionFiles()
                 $this->_fileStageToPath($row->file_stage),
                 $filename
             );
+            $fileService = App::make(FileServiceProvider::class);
             if (!$fileService->fs->has($path)) {
                 error_log("A submission file was expected but not found at ${path}.");
             }

classes/services/PKPSubmissionFileService.inc.php

@@ -19,6 +19,7 @@
 use APP\facades\Repo;
 use APP\notification\NotificationManager;
 use PKP\core\Core;
+use PKP\core\FileServiceProvider;
 use PKP\db\DAORegistry;
 use PKP\db\DAOResultFactory;
 use PKP\log\SubmissionEmailLogEntry;
@@ -39,6 +40,13 @@
 
 class PKPSubmissionFileService implements EntityPropertyInterface, EntityReadInterface, EntityWriteInterface
 {
+    protected FileServiceProvider $fileService;
+
+    public function __construct(FileServiceProvider $fileService)
+    {
+        $this->fileService = $fileService;
+    }
+
     /**
      * @copydoc \PKP\services\interfaces\EntityReadInterface::get()
      */
@@ -168,7 +176,7 @@ public function getProperties($submissionFile, $props, $args = null)
                     $values[$prop] = $dependentFiles;
                     break;
                 case 'documentType':
-                    $values[$prop] = Services::get('file')->getDocumentType($submissionFile->getData('mimetype'));
+                    $values[$prop] = $this->fileService->getDocumentType($submissionFile->getData('mimetype'));
                     break;
                 case 'revisions':
                     $files = [];
@@ -178,7 +186,7 @@ public function getProperties($submissionFile, $props, $args = null)
                             continue;
                         }
                         $files[] = [
-                            'documentType' => Services::get('file')->getDocumentType($revision->mimetype),
+                            'documentType' => $this->fileService->getDocumentType($revision->mimetype),
                             'fileId' => $revision->fileId,
                             'mimetype' => $revision->mimetype,
                             'path' => $revision->path,
@@ -600,7 +608,7 @@ public function delete($submissionFile)
                 'includeDependentFiles' => true,
             ]);
             if (!$countFileShares) {
-                Services::get('file')->delete($revision->fileId);
+                $this->fileService->delete($revision->fileId);
             }
         }