pkp/pkp-lib#7131 Refactor file service to use Laravel container

NateWr · Jun 15, 2021 · f830454 · f830454
1 parent 52960f0
commit f830454
Show file tree

Hide file tree

Showing 6 changed files with 39 additions and 31 deletions.
diff --git a/classes/install/Upgrade.inc.php b/classes/install/Upgrade.inc.php
@@ -26,12 +26,8 @@
 use PKP\file\FileManager;
 use PKP\identity\Identity;
 use PKP\install\Installer;
-use PKP\db\DAORegistry;
 use PKP\security\Role;
 
-use APP\file\PublicFileManager;
-use APP\core\Application;
-use APP\template\TemplateManager;
 use PKP\submission\SubmissionFile;
 
 class Upgrade extends Installer
@@ -475,10 +471,10 @@ public function moveReviewerFiles()
                 );
                 $wrongFilePath = $submissionDir . '/' . $this->_fileStageToPath($revisionRow->file_stage) . '/' . $wrongFilename;
                 $newFilePath = $submissionDir . '/' . $this->_fileStageToPath(SubmissionFile::SUBMISSION_FILE_REVIEW_ATTACHMENT) . '/' . $newFilename;
-                if (Services::get('file')->fs->has($newFilePath)) {
+                if ($this->fileService->fs->has($newFilePath)) {
                     continue;
                 }
-                if (!Services::get('file')->fs->rename($wrongFilePath, $newFilePath)) {
+                if (!$this->fileService->fs->rename($wrongFilePath, $newFilePath)) {
                     error_log("Unable to move \"${wrongFilePath}\" to \"${newFilePath}\".");
                 }
             }
@@ -706,10 +702,10 @@ public function fixGenreIdInFileNames()
                         $timestamp = date('Ymd', strtotime($row->date_uploaded));
                         $wrongFileName = $submissionId . '-' . '1' . '-' . $row->file_id . '-' . $row->revision . '-' . $row->file_stage . '-' . $timestamp . '.' . strtolower_codesafe($fileManager->parseFileExtension($row->original_file_name));
                         $sourceFilename = $submissionDir . '/' . $this->_fileStageToPath($row->file_stage) . '/' . $wrongFileName;
-                        if (Services::get('file')->fs->has($targetFilename)) {
+                        if ($this->fileService->fs->has($targetFilename)) {
                             continue;
                         }
-                        if (!Services::get('file')->fs->rename($sourceFilename, $targetFilename)) {
+                        if (!$this->fileService->fs->rename($sourceFilename, $targetFilename)) {
                             error_log("Unable to move \"${sourceFilename}\" to \"${targetFilename}\".");
                         }
                     }
@@ -755,7 +751,7 @@ public function moveCSSFiles()
                 $submissionDir = Services::get('submissionFile')->getSubmissionDir($journal->getId(), $row->submission_id);
                 $sourceFilename = $submissionDir . '/public' . '/' . $wrongServerName;
                 $targetFilename = $submissionDir . '/submission/proof' . '/' . $newServerName;
-                if (!Services::get('file')->fs->rename($sourceFilename, $targetFilename)) {
+                if (!$this->fileService->fs->rename($sourceFilename, $targetFilename)) {
                     error_log("Unable to move \"${sourceFilename}\" to \"${targetFilename}\".");
                 }
             }
@@ -805,7 +801,7 @@ public function repairSuppFilesFilestage()
             );
             $oldFileName = $submissionDir . '/' . $submissionFileRevision->_fileStageToPath($submissionFileRevision->getFileStage()) . '/' . $generatedOldFilename;
             $newFileName = $submissionDir . '/' . $submissionFileRevision->_fileStageToPath($submissionFileRevision->getFileStage()) . '/' . $generatedNewFilename;
-            if (!Services::get('file')->fs->rename($oldFileName, $newFileName)) {
+            if (!$this->fileService->fs->rename($oldFileName, $newFileName)) {
                 error_log("Unable to move \"${oldFileName}\" to \"${newFileName}\".");
             }
             DB::table('submission_files')

diff --git a/classes/services/OJSServiceProvider.inc.php b/classes/services/OJSServiceProvider.inc.php
@@ -15,11 +15,12 @@
 
 namespace APP\services;
 
+use Illuminate\Support\Facades\App;
 use Pimple\Container;
 
+use PKP\core\FileServiceProvider;
 use PKP\services\PKPAuthorService;
 use PKP\services\PKPEmailTemplateService;
-use PKP\services\PKPFileService;
 use PKP\services\PKPSchemaService;
 use PKP\services\PKPSiteService;
 use PKP\services\PKPUserService;
@@ -38,11 +39,6 @@ public function register(Container $pimple)
             return new PKPAuthorService();
         };
 
-        // File service
-        $pimple['file'] = function () {
-            return new PKPFileService();
-        };
-
         // Issue service
         $pimple['issue'] = function () {
             return new IssueService();
@@ -80,7 +76,9 @@ public function register(Container $pimple)
 
         // Submission file service
         $pimple['submissionFile'] = function () {
-            return new SubmissionFileService();
+            return new SubmissionFileService(
+                App::make(FileServiceProvider::class)
+            );
         };
 
         // Email Templates service

diff --git a/classes/services/SubmissionFileService.inc.php b/classes/services/SubmissionFileService.inc.php
@@ -16,18 +16,20 @@
 namespace APP\services;
 
 use APP\core\Application;
+use PKP\core\FileServiceProvider;
 use PKP\db\DAORegistry;
-use PKP\plugins\HookRegistry;
 
+use PKP\plugins\HookRegistry;
 use PKP\search\SubmissionSearch;
 
 class SubmissionFileService extends \PKP\services\PKPSubmissionFileService
 {
     /**
      * Initialize hooks for extending PKPSubmissionFileService
      */
-    public function __construct()
+    public function __construct(FileServiceProvider $fileService)
     {
+        parent::__construct($fileService);
         HookRegistry::register('SubmissionFile::delete::before', [$this, 'deleteSubmissionFile']);
     }
 

diff --git a/pages/article/ArticleHandler.inc.php b/pages/article/ArticleHandler.inc.php
@@ -22,6 +22,8 @@
 use APP\submission\Submission;
 use APP\template\TemplateManager;
 use Firebase\JWT\JWT;
+use Illuminate\Support\Facades\App;
+use PKP\core\FileServiceProvider;
 use PKP\security\authorization\ContextRequiredPolicy;
 use PKP\submission\PKPSubmission;
 
@@ -456,16 +458,17 @@ public function download($args, $request)
 
             if (!HookRegistry::call('ArticleHandler::download', [$this->article, &$this->galley, &$this->fileId])) {
                 $submissionFile = Services::get('submissionFile')->get($this->fileId);
+                $fileService = App::make(FileServiceProvider::class);
 
-                if (!Services::get('file')->fs->has($submissionFile->getData('path'))) {
+                if (!$fileService->fs->has($submissionFile->getData('path'))) {
                     $request->getDispatcher()->handle404();
                 }
 
-                $filename = Services::get('file')->formatFilename($submissionFile->getData('path'), $submissionFile->getLocalizedData('name'));
+                $filename = $fileService->formatFilename($submissionFile->getData('path'), $submissionFile->getLocalizedData('name'));
 
                 $returner = true;
                 HookRegistry::call('FileManager::downloadFileFinished', [&$returner]);
-                Services::get('file')->download($submissionFile->getData('fileId'), $filename);
+                $fileService->download($submissionFile->getData('fileId'), $filename);
             }
         } else {
             header('HTTP/1.0 403 Forbidden');

diff --git a/plugins/generic/htmlArticleGalley/HtmlArticleGalleyPlugin.inc.php b/plugins/generic/htmlArticleGalley/HtmlArticleGalleyPlugin.inc.php
@@ -13,14 +13,17 @@
  * @brief Class for HtmlArticleGalley plugin
  */
 
-use PKP\submission\SubmissionFile;
-use PKP\plugins\HookRegistry;
-import('lib.pkp.classes.plugins.GenericPlugin');
-
 use APP\facades\Repo;
 use APP\file\PublicFileManager;
 
+import('lib.pkp.classes.plugins.GenericPlugin');
+
 use APP\template\TemplateManager;
+use Illuminate\Support\Facades\App;
+
+use PKP\core\FileServiceProvider;
+use PKP\plugins\HookRegistry;
+use PKP\submission\SubmissionFile;
 
 class HtmlArticleGalleyPlugin extends \PKP\plugins\GenericPlugin
 {
@@ -153,7 +156,8 @@ protected function _getHTMLContents($request, $galley)
     {
         $submissionFile = $galley->getFile();
         $submissionId = $submissionFile->getData('submissionId');
-        $contents = Services::get('file')->fs->read($submissionFile->getData('path'));
+        $fileService = App::make(FileServiceProvider::class);
+        $contents = $fileService->fs->read($submissionFile->getData('path'));
 
         // Replace media file references
         $embeddableFilesIterator = Services::get('submissionFile')->getMany([

diff --git a/plugins/importexport/datacite/filter/DataciteXmlFilter.inc.php b/plugins/importexport/datacite/filter/DataciteXmlFilter.inc.php
@@ -13,11 +13,13 @@
  * @brief Class that converts an Issue to a DataCite XML document.
  */
 
+use APP\article\ArticleGalley;
 use APP\facades\Repo;
+use APP\issue\Issue;
 use APP\submission\Submission;
 use APP\workflow\EditorDecisionActionsManager;
-use APP\issue\Issue;
-use APP\article\ArticleGalley;
+use Illuminate\Support\Facades\App;
+use PKP\core\FileServiceProvider;
 
 // Title types
 define('DATACITE_TITLETYPE_TRANSLATED', 'TranslatedTitle');
@@ -54,6 +56,8 @@
 
 class DataciteXmlFilter extends NativeExportFilter
 {
+    protected FileServiceProvider $fileService;
+
     /**
      * Constructor
      *
@@ -63,6 +67,7 @@ public function __construct($filterGroup)
     {
         $this->setDisplayName('DataCite XML export');
         parent::__construct($filterGroup);
+        $this->fileService = App::make(FileServiceProvider::class);
     }
 
     //
@@ -635,8 +640,8 @@ public function createSizesNode($doc, $issue, $article, $publication, $galley, $
                 // The galley represents the article.
                 $pages = $publication->getData('pages');
                 $path = $galleyFile->getData('path');
-                $size = Services::get('file')->fs->getSize($path);
-                $sizes[] = Services::get('file')->getNiceFileSize($size);
+                $size = $this->fileService->fs->getSize($path);
+                $sizes[] = $this->fileService->getNiceFileSize($size);
                 break;
             case isset($article):
                 $pages = $publication->getData('pages');