#8933 Refactor event log to restore revised submission file

pkp · May 19, 2023 · 5383bf9 · 5383bf9
1 parent 5599093
commit 5383bf9
Show file tree

Hide file tree

Showing 54 changed files with 1,751 additions and 854 deletions.
diff --git a/api/v1/submissions/PKPSubmissionHandler.php b/api/v1/submissions/PKPSubmissionHandler.php
@@ -31,11 +31,12 @@
 use Illuminate\Support\Facades\Mail;
 use PKP\core\APIResponse;
 use PKP\core\Core;
+use PKP\core\PKPApplication;
 use PKP\db\DAORegistry;
 use PKP\decision\DecisionType;
 use PKP\facades\Locale;
 use PKP\handler\APIHandler;
-use PKP\log\SubmissionLog;
+use PKP\log\event\PKPSubmissionEventLogEntry;
 use PKP\mail\mailables\PublicationVersionNotify;
 use PKP\mail\mailables\SubmissionSavedForLater;
 use PKP\notification\NotificationSubscriptionSettingsDAO;
@@ -48,6 +49,7 @@
 use PKP\security\authorization\SubmissionAccessPolicy;
 use PKP\security\authorization\UserRolesRequiredPolicy;
 use PKP\security\Role;
+use PKP\security\Validation;
 use PKP\services\PKPSchemaService;
 use PKP\stageAssignment\StageAssignmentDAO;
 use PKP\submission\PKPSubmission;
@@ -708,17 +710,21 @@ public function submit(SlimRequest $slimRequest, APIResponse $response, array $a
         $submission = Repo::submission()->get($submission->getId());
 
         if ($slimRequest->getParsedBodyParam('confirmCopyright')) {
-            SubmissionLog::logEvent(
-                Application::get()->getRequest(),
-                $submission,
-                SubmissionEventLogEntry::SUBMISSION_LOG_COPYRIGHT_AGREED,
-                'submission.event.copyrightAgreed',
-                [
-                    'username' => $request->getUser()->getUsername(),
-                    'name' => $request->getUser()->getFullName(true, false, Locale::getLocale()),
-                    'copyrightNotice' => $context->getLocalizedData('copyrightNotice', Locale::getLocale()),
-                ]
-            );
+            $user = $request->getUser();
+            $eventLog = Repo::eventLog()->newDataObject([
+                'assocType' => PKPApplication::ASSOC_TYPE_SUBMISSION,
+                'assocId' => $submission->getId(),
+                'eventType' => PKPSubmissionEventLogEntry::SUBMISSION_LOG_COPYRIGHT_AGREED,
+                'userId' => Validation::loggedInAs() ?? $user->getId(),
+                'message' => 'submission.event.copyrightAgreed',
+                'isTranslated' => 0,
+                'dateLogged' => Core::getCurrentDate(),
+                'username' => $user->getUsername(),
+                'userFullName' => $user->getFullName(true, false, Locale::getLocale()),
+                'copyrightNotice' => $context->getData('copyrightNotice'),
+            ]);
+
+            Repo::eventLog()->add($eventLog);
         }
 
         $userGroups = Repo::userGroup()

diff --git a/classes/category/Repository.php b/classes/category/Repository.php
@@ -108,9 +108,9 @@ public function getSchemaMap(): maps\Schema
     }
 
     /**
-     * Validate properties for an announcement
+     * Validate properties for a category
      *
-     * Perform validation checks on data used to add or edit an announcement.
+     * Perform validation checks on data used to add or edit a category.
      *
      * @param array $props A key/value array with the new data to validate
      * @param array $allowedLocales The context's supported locales

diff --git a/classes/controllers/grid/users/reviewer/PKPReviewerGridHandler.php b/classes/controllers/grid/users/reviewer/PKPReviewerGridHandler.php
@@ -45,6 +45,7 @@
 use PKP\facades\Locale;
 use PKP\linkAction\LinkAction;
 use PKP\linkAction\request\AjaxModal;
+use PKP\log\event\PKPSubmissionEventLogEntry;
 use PKP\log\SubmissionLog;
 use PKP\mail\Mailable;
 use PKP\mail\mailables\ReviewerReinstate;
@@ -57,6 +58,7 @@
 use PKP\security\authorization\internal\ReviewRoundRequiredPolicy;
 use PKP\security\authorization\WorkflowStageAccessPolicy;
 use PKP\security\Role;
+use PKP\security\Validation;
 use PKP\submission\reviewAssignment\ReviewAssignment;
 use PKP\submission\reviewAssignment\ReviewAssignmentDAO;
 use PKP\submission\reviewRound\ReviewRound;
@@ -675,17 +677,19 @@ public function unconsiderReview($args, $request)
         $reviewAssignmentDao->updateObject($reviewAssignment);
 
         // log the unconsider.
-        SubmissionLog::logEvent(
-            $request,
-            $submission,
-            SubmissionEventLogEntry::SUBMISSION_LOG_REVIEW_UNCONSIDERED,
-            'log.review.reviewUnconsidered',
-            [
-                'editorName' => $user->getFullName(),
-                'submissionId' => $submission->getId(),
-                'round' => $reviewAssignment->getRound(),
-            ]
-        );
+        $eventLog = Repo::eventLog()->newDataObject([
+            'assocType' => PKPApplication::ASSOC_TYPE_SUBMISSION,
+            'assocId' => $submission->getId(),
+            'eventType' => PKPSubmissionEventLogEntry::SUBMISSION_LOG_REVIEW_UNCONSIDERED,
+            'userId' => Validation::loggedInAs() ?? $user->getId(),
+            'message' => 'log.review.reviewUnconsidered',
+            'isTranslated' => 0,
+            'dateLogged' => Core::getCurrentDate(),
+            'editorName' => $user->getFullName(),
+            'submissionId' => $submission->getId(),
+            'round' => $reviewAssignment->getRound(),
+        ]);
+        Repo::eventLog()->add($eventLog);
 
         return \PKP\db\DAO::getDataChangedEvent($reviewAssignment->getId());
     }
@@ -738,17 +742,19 @@ public function reviewRead($args, $request)
             $submissionId = $reviewAssignment->getSubmissionId();
             $submission = Repo::submission()->get($submissionId);
 
-            SubmissionLog::logEvent(
-                $request,
-                $submission,
-                SubmissionEventLogEntry::SUBMISSION_LOG_REVIEW_CONFIRMED,
-                'log.review.reviewConfirmed',
-                [
-                    'userName' => $user->getFullName(),
-                    'submissionId' => $reviewAssignment->getSubmissionId(),
-                    'round' => $reviewAssignment->getRound()
-                ]
-            );
+            $eventLog = Repo::eventLog()->newDataObject([
+                'assocType' => PKPApplication::ASSOC_TYPE_SUBMISSION,
+                'assocId' => $submission->getId(),
+                'eventType' => PKPSubmissionEventLogEntry::SUBMISSION_LOG_REVIEW_CONFIRMED,
+                'userId' => Validation::loggedInAs() ?? $user->getId(),
+                'message' => 'log.review.reviewConfirmed',
+                'isTranslated' => 0,
+                'dateLogged' => Core::getCurrentDate(),
+                'editorName' => $user->getFullName(),
+                'submissionId' => $reviewAssignment->getSubmissionId(),
+                'round' => $reviewAssignment->getRound()
+            ]);
+            Repo::eventLog()->add($eventLog);
         }
         // Remove the reviewer task.
         $notificationDao = DAORegistry::getDAO('NotificationDAO'); /** @var NotificationDAO $notificationDao */

diff --git a/classes/core/PKPApplication.php b/classes/core/PKPApplication.php
@@ -506,8 +506,6 @@ public function getDAOMap()
             'SubmissionDisciplineDAO' => 'PKP\submission\SubmissionDisciplineDAO',
             'SubmissionDisciplineEntryDAO' => 'PKP\submission\SubmissionDisciplineEntryDAO',
             'SubmissionEmailLogDAO' => 'PKP\log\SubmissionEmailLogDAO',
-            'SubmissionEventLogDAO' => 'PKP\log\SubmissionEventLogDAO',
-            'SubmissionFileEventLogDAO' => 'PKP\log\SubmissionFileEventLogDAO',
             'QueryDAO' => 'PKP\query\QueryDAO',
             'SubmissionLanguageDAO' => 'PKP\submission\SubmissionLanguageDAO',
             'SubmissionLanguageEntryDAO' => 'PKP\submission\SubmissionLanguageEntryDAO',

diff --git a/classes/db/DBDataXMLParser.php b/classes/db/DBDataXMLParser.php
@@ -99,7 +99,7 @@ public function parseData($file)
                                 if ($column) {
                                     $this->sql = array_merge($this->sql, array_column(DB::pretend(function () use ($table, $column) {
                                         Schema::table($table, function (Blueprint $table) use ($column) {
-                                            $table->dropColumn('column');
+                                            $table->dropColumn($column);
                                         });
                                     }), 'query'));
                                 } else {

diff --git a/classes/decision/Repository.php b/classes/decision/Repository.php
@@ -26,12 +26,14 @@
 use Illuminate\Support\Facades\App;
 use PKP\context\Context;
 use PKP\core\Core;
+use PKP\core\PKPApplication;
 use PKP\db\DAORegistry;
-use PKP\log\PKPSubmissionEventLogEntry;
+use PKP\log\event\PKPSubmissionEventLogEntry;
 use PKP\log\SubmissionLog;
 use PKP\observers\events\DecisionAdded;
 use PKP\plugins\Hook;
 use PKP\security\Role;
+use PKP\security\Validation;
 use PKP\services\PKPSchemaService;
 use PKP\submission\reviewRound\ReviewRoundDAO;
 use PKP\submissionFile\SubmissionFile;
@@ -226,20 +228,18 @@ public function add(Decision $decision): int
         }
 
         // Log the decision
-        SubmissionLog::logEvent(
-            $this->request,
-            $submission,
-            $this->isRecommendation($decisionType->getDecision())
+        $eventLog = Repo::eventLog()->newDataObject([
+            'assocType' => PKPApplication::ASSOC_TYPE_SUBMISSION,
+            'assocId' => $submission->getId(),
+            'eventType' => $this->isRecommendation($decisionType->getDecision())
                 ? PKPSubmissionEventLogEntry::SUBMISSION_LOG_EDITOR_RECOMMENDATION
                 : PKPSubmissionEventLogEntry::SUBMISSION_LOG_EDITOR_DECISION,
-            $decisionType->getLog(),
-            [
-                'editorId' => $editor->getId(),
-                'editorName' => $editor->getFullName(),
-                'submissionId' => $decision->getData('submissionId'),
-                'decision' => $decisionType->getDecision(),
-            ]
-        );
+            'userId' => Validation::loggedInAs() ?? $this->request->getUser()?->getId(),
+            'message' => $decisionType->getLog(),
+            'isTranslated' => 0,
+            'dateLogged' => Core::getCurrentDate()
+        ]);
+        Repo::eventLog()->add($eventLog);
 
         // Allow the decision type to perform additional actions
         $decisionType->runAdditionalActions($decision, $submission, $editor, $context, $actions);

diff --git a/classes/decision/types/traits/NotifyReviewers.php b/classes/decision/types/traits/NotifyReviewers.php
@@ -20,11 +20,14 @@
 use Illuminate\Support\Facades\Mail;
 use Illuminate\Validation\Validator;
 use PKP\core\Core;
+use PKP\core\PKPApplication;
 use PKP\db\DAORegistry;
+use PKP\log\event\PKPSubmissionEventLogEntry;
 use PKP\log\SubmissionLog;
 use PKP\mail\EmailData;
 use PKP\mail\mailables\DecisionNotifyReviewer;
 use PKP\mail\mailables\ReviewerUnassign;
+use PKP\security\Validation;
 use PKP\submission\reviewAssignment\ReviewAssignment;
 use PKP\submission\reviewAssignment\ReviewAssignmentDAO;
 use PKP\user\User;
@@ -62,16 +65,18 @@ protected function sendReviewersEmail(DecisionNotifyReviewer|ReviewerUnassign $m
             }
         }
 
-        SubmissionLog::logEvent(
-            Application::get()->getRequest(),
-            $submission,
-            SubmissionEventLogEntry::SUBMISSION_LOG_DECISION_EMAIL_SENT,
-            'submission.event.decisionReviewerEmailSent',
-            [
-                'recipientCount' => count($recipients),
-                'subject' => $email->subject,
-            ]
-        );
+        $eventLog = Repo::eventLog()->newDataObject([
+            'assocType' => PKPApplication::ASSOC_TYPE_SUBMISSION,
+            'assocId' => $submission->getId(),
+            'eventType' => PKPSubmissionEventLogEntry::SUBMISSION_LOG_DECISION_EMAIL_SENT,
+            'userId' => Validation::loggedInAs() ?? Application::get()->getRequest()->getUser()?->getId(),
+            'message' => 'submission.event.decisionReviewerEmailSent',
+            'isTranslated' => 0,
+            'dateLogged' => Core::getCurrentDate(),
+            'recipientCount' => count($recipients),
+            'subject' => $email->subject,
+        ]);
+        Repo::eventLog()->add($eventLog);
     }
 
     /**

diff --git a/classes/facades/Repo.php b/classes/facades/Repo.php
@@ -34,6 +34,7 @@
 use PKP\job\repositories\Job as JobRepository;
 use PKP\submissionFile\Repository as SubmissionFileRepository;
 use PKP\userGroup\Repository as UserGroupRepository;
+use PKP\log\event\Repository as EventLogRepository;
 
 class Repo
 {
@@ -86,4 +87,9 @@ public static function userGroup(): UserGroupRepository
     {
         return app(UserGroupRepository::class);
     }
+
+	public static function eventLog(): EventLogRepository
+	{
+		return app(EventLogRepository::class);
+	}
 }