MDL-74433 mod_assign: Fix logging of submission removal

mod/assign/classes/event/submission_removed.php

@@ -0,0 +1,154 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+namespace mod_assign\event;
+
+use assign;
+use coding_exception;
+use stdClass;
+
+/**
+ * The mod_assign submission removed event class.
+ *
+ * @property-read array $other {
+ *      Extra information about the event.
+ *
+ *      - int submissionid: ID number of this submission.
+ *      - int submissionattempt: Number of attempts made on this submission.
+ *      - string submissionstatus: Status of the submission.
+ *      - int groupid: (optional) The group ID if this is a teamsubmission.
+ *      - string groupname: (optional) The name of the group if this is a teamsubmission.
+ * }
+ *
+ * @package    mod_assign
+ * @since      Moodle 4.0
+ * @copyright  2022 TU Berlin
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class submission_removed extends base {
+    /**
+     * Create instance of event.
+     *
+     * @param assign $assign
+     * @param stdClass $submission
+     * @return submission_removed
+     * @throws coding_exception
+     */
+    public static function create_from_submission(assign $assign, stdClass $submission): submission_removed {
+        $groupname = null;
+        $groupid = 0;
+        if (empty($submission->userid) && !empty($submission->groupid)) {
+            $groupname = groups_get_group_name($submission->groupid);
+            $groupid = $submission->groupid;
+        }
+        $data = [
+            'context' => $assign->get_context(),
+            'objectid' => $submission->id,
+            'relateduserid' => $assign->get_instance()->teamsubmission ? null : $submission->userid,
+            'anonymous' => $assign->is_blind_marking() ? 1 : 0,
+            'other' => [
+                'submissionid' => $submission->id,
+                'submissionattempt' => $submission->attemptnumber,
+                'submissionstatus' => $submission->status,
+                'groupid' => $groupid,
+                'groupname' => $groupname
+            ]
+        ];
+        /** @var submission_removed $event */
+        $event = self::create($data);
+        $event->set_assign($assign);
+        $event->add_record_snapshot('assign_submission', $submission);
+        return $event;
+    }
+
+    /**
+     * Init method.
+     */
+    protected function init() {
+        $this->data['crud'] = 'd';
+        $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
+        $this->data['objecttable'] = 'assign_submission';
+    }
+
+    /**
+     * Returns localised general event name.
+     *
+     * @return string
+     * @throws coding_exception
+     */
+    public static function get_name(): string {
+        return get_string('eventsubmissionremoved', 'mod_assign');
+    }
+
+    /**
+     * Returns non-localised description of what happened.
+     *
+     * @return string
+     */
+    public function get_description(): string {
+        $descriptionstring = "The user with id '$this->userid' removed the submission with id '$this->objectid' in " .
+            "the assignment with course module id '$this->contextinstanceid' submitted by ";
+        if (!empty($this->other['groupid'])) {
+            $groupname = $this->other['groupname'];
+            $groupid = $this->other['groupid'];
+            $descriptionstring .= "the group '$groupname' with id '$groupid'.";
+        } else {
+            $descriptionstring .= "the user with id '$this->relateduserid'.";
+        }
+        return $descriptionstring;
+    }
+
+    /**
+     * Custom validation.
+     *
+     * @return void
+     * @throws coding_exception
+     */
+    protected function validate_data() {
+        parent::validate_data();
+        if (!isset($this->other['submissionid'])) {
+            throw new coding_exception('The \'submissionid\' value must be set in other.');
+        }
+        if (!isset($this->other['submissionattempt'])) {
+            throw new coding_exception('The \'submissionattempt\' value must be set in other.');
+        }
+        if (!isset($this->other['submissionstatus'])) {
+            throw new coding_exception('The \'submissionstatus\' value must be set in other.');
+        }
+    }
+
+    /**
+     * Get objectid mapping.
+     *
+     * @return array
+     */
+    public static function get_objectid_mapping(): array {
+        return ['db' => 'assign_submission', 'restore' => 'submission'];
+    }
+
+    /**
+     * Get other mapping.
+     *
+     * @return array
+     */
+    public static function get_other_mapping(): array {
+        $othermapped = [];
+        $othermapped['submissionid'] = ['db' => 'assign_submission', 'restore' => 'submission'];
+        $othermapped['groupid'] = ['db' => 'groups', 'restore' => 'group'];
+
+        return $othermapped;
+    }
+}

mod/assign/classes/event/submission_status_updated.php

@@ -103,8 +103,12 @@ class submission_status_updated extends base {
      */
     protected function get_legacy_logdata() {
         $submission = $this->get_record_snapshot('assign_submission', $this->objectid);
-        $user = $this->get_record_snapshot('user', $submission->userid);
-        $logmessage = get_string('reverttodraftforstudent', 'assign', array('id' => $user->id, 'fullname' => fullname($user)));
+        if ($this->assign->get_instance()->teamsubmission) {
+            $logmessage = get_string('reverttodraftforgroup', 'assign', $submission->groupid);
+        } else {
+            $user = $this->get_record_snapshot('user', $submission->userid);
+            $logmessage = get_string('reverttodraftforstudent', 'assign', ['id' => $user->id, 'fullname' => fullname($user)]);
+        }
         $this->set_legacy_logdata('revert submission to draft', $logmessage);
         return parent::get_legacy_logdata();
     }

mod/assign/lang/en/assign.php

@@ -211,6 +211,7 @@ $string['eventsubmissionduplicated'] = 'The user duplicated their submission.';
 $string['eventsubmissionformviewed'] = 'Submission form viewed.';
 $string['eventsubmissiongraded'] = 'The submission has been graded.';
 $string['eventsubmissionlocked'] = 'The submissions have been locked for a user.';
+$string['eventsubmissionremoved'] = 'Submission removed.';
 $string['eventsubmissionstatusupdated'] = 'The status of the submission has been updated.';
 $string['eventsubmissionstatusviewed'] = 'The status of the submission has been viewed.';
 $string['eventsubmissionunlocked'] = 'The submissions have been unlocked for a user.';
@@ -483,6 +484,7 @@ $string['removesubmissionconfirmwithtimelimit'] = 'Are you sure you want to remo
 $string['revealidentities'] = 'Reveal student identities';
 $string['revealidentitiesconfirm'] = 'Are you sure you want to reveal student identities for this assignment? This operation cannot be undone. Once the student identities have been revealed, the marks will be released to the gradebook.';
 $string['reverttodefaults'] = 'Revert to assignment defaults';
+$string['reverttodraftforgroup'] = 'Revert submission to draft for group {$a}.';
 $string['reverttodraftforstudent'] = 'Revert submission to draft for student: (id={$a->id}, fullname={$a->fullname}).';
 $string['reverttodraft'] = 'Revert the submission to draft status';
 $string['reverttodraftshort'] = 'Revert the submission to draft';

mod/assign/locallib.php

@@ -94,6 +94,8 @@ require_once($CFG->dirroot . '/mod/assign/renderable.php');
 require_once($CFG->dirroot . '/mod/assign/gradingtable.php');
 require_once($CFG->libdir . '/portfolio/caller.php');
 
+use mod_assign\event\submission_removed;
+use mod_assign\event\submission_status_updated;
 use \mod_assign\output\grading_app;
 use \mod_assign\output\assign_header;
 use \mod_assign\output\assign_submission_status;
@@ -8217,6 +8219,7 @@ class assign {
      *
      * @param int $userid
      * @return boolean
+     * @throws coding_exception
      */
     public function remove_submission($userid) {
         global $USER;
@@ -8254,9 +8257,8 @@ class assign {
             $completion->update_state($this->get_course_module(), COMPLETION_INCOMPLETE, $userid);
         }
 
-        if ($submission->userid != 0) {
-            \mod_assign\event\submission_status_updated::create_from_submission($this, $submission)->trigger();
-        }
+        submission_removed::create_from_submission($this, $submission)->trigger();
+        submission_status_updated::create_from_submission($this, $submission)->trigger();
         return true;
     }
 

mod/assign/tests/event/events_test.php

@@ -191,6 +191,80 @@ class events_test extends \advanced_testcase {
         }
     }
 
+    /**
+     * Test submission_removed event.
+     *
+     * @covers \mod_assign\event\submission_removed
+     */
+    public function test_submission_removed() {
+        $this->resetAfterTest();
+
+        $course = $this->getDataGenerator()->create_course();
+        $this->getDataGenerator()->create_and_enrol($course, 'teacher');
+        $student = $this->getDataGenerator()->create_and_enrol($course, 'student');
+
+        $assign = $this->create_instance($course);
+        $this->add_submission($student, $assign);
+        $submission = $assign->get_user_submission($student->id, 0);
+
+        $sink = $this->redirectEvents();
+        $assign->remove_submission($student->id);
+        $events = $sink->get_events();
+        $this->assertCount(2, $events);
+        $event = $events[0];
+        $this->assertInstanceOf('mod_assign\event\submission_removed', $event);
+        $this->assertEquals($assign->get_context(), $event->get_context());
+        $this->assertEquals($submission->id, $event->objectid);
+        $this->assertEquals($student->id, $event->relateduserid);
+        $this->assertEquals($submission->id, $event->other['submissionid']);
+        $this->assertEquals(0, $event->other['submissionattempt']);
+        $this->assertEquals(ASSIGN_SUBMISSION_STATUS_NEW, $event->other['submissionstatus']);
+        $this->assertEquals(0, $event->other['groupid']);
+        $this->assertEquals(null, $event->other['groupname']);
+        $sink->close();
+    }
+
+    /**
+     * Test submission_removed event when a team submission is removed.
+     *
+     * @covers \mod_assign\event\submission_removed
+     */
+    public function test_team_submission_removed() {
+        $this->resetAfterTest();
+
+        $course = $this->getDataGenerator()->create_course();
+        $this->getDataGenerator()->create_and_enrol($course, 'teacher');
+        $group = $this->getDataGenerator()->create_group(['courseid' => $course->id]);
+
+        $student = $this->getDataGenerator()->create_and_enrol($course, 'student');
+        groups_add_member($group, $student);
+
+        $otherstudent = $this->getDataGenerator()->create_and_enrol($course, 'student');
+        groups_add_member($group, $otherstudent);
+
+        $assign = $this->create_instance($course, [
+            'teamsubmission' => 1,
+        ]);
+        $this->add_submission($student, $assign);
+        $submission = $assign->get_group_submission($student->id, 0, true);
+
+        $sink = $this->redirectEvents();
+        $assign->remove_submission($student->id);
+        $events = $sink->get_events();
+        $this->assertCount(2, $events);
+        $event = $events[0];
+        $this->assertInstanceOf('mod_assign\event\submission_removed', $event);
+        $this->assertEquals($assign->get_context(), $event->get_context());
+        $this->assertEquals($submission->id, $event->objectid);
+        $this->assertEquals(null, $event->relateduserid);
+        $this->assertEquals($submission->id, $event->other['submissionid']);
+        $this->assertEquals(0, $event->other['submissionattempt']);
+        $this->assertEquals(ASSIGN_SUBMISSION_STATUS_NEW, $event->other['submissionstatus']);
+        $this->assertEquals($group->id, $event->other['groupid']);
+        $this->assertEquals($group->name, $event->other['groupname']);
+        $sink->close();
+    }
+
     public function test_extension_granted() {
         $this->resetAfterTest();
 
@@ -345,7 +419,12 @@ class events_test extends \advanced_testcase {
         $this->assertEventContextNotUsed($event);
     }
 
-    public function test_submission_status_updated() {
+    /**
+     * Test submission_status_updated event when a submission is updated.
+     *
+     * @covers \mod_assign\event\submission_status_updated
+     */
+    public function test_submission_status_updated_on_update() {
         $this->resetAfterTest();
 
         $course = $this->getDataGenerator()->create_course();
@@ -383,6 +462,95 @@ class events_test extends \advanced_testcase {
         $sink->close();
     }
 
+    /**
+     * Test submission_status_updated event when a submission is removed.
+     *
+     * @covers \mod_assign\event\submission_status_updated
+     */
+    public function test_submission_status_updated_on_remove() {
+        $this->resetAfterTest();
+
+        $course = $this->getDataGenerator()->create_course();
+        $teacher = $this->getDataGenerator()->create_and_enrol($course, 'teacher');
+        $student = $this->getDataGenerator()->create_and_enrol($course, 'student');
+
+        $assign = $this->create_instance($course);
+        $this->add_submission($student, $assign);
+        $submission = $assign->get_user_submission($student->id, false);
+
+        $sink = $this->redirectEvents();
+        $assign->remove_submission($student->id);
+
+        $events = $sink->get_events();
+        $this->assertCount(2, $events);
+
+        $event = $events[1];
+        $this->assertInstanceOf('\mod_assign\event\submission_status_updated', $event);
+        $this->assertEquals($assign->get_context(), $event->get_context());
+        $this->assertEquals($submission->id, $event->objectid);
+        $this->assertEquals($student->id, $event->relateduserid);
+        $this->assertEquals(ASSIGN_SUBMISSION_STATUS_NEW, $event->other['newstatus']);
+        $expected = [
+            $assign->get_course()->id,
+            'assign',
+            'revert submission to draft',
+            'view.php?id=' . $assign->get_course_module()->id,
+            get_string('reverttodraftforstudent', 'assign', ['id' => $student->id,
+                'fullname' => fullname($student)]),
+            $assign->get_course_module()->id
+        ];
+        $this->assertEventLegacyLogData($expected, $event);
+        $sink->close();
+    }
+
+    /**
+     * Test submission_status_updated event when a team submission is removed.
+     *
+     * @covers \mod_assign\event\submission_status_updated
+     */
+    public function test_team_submission_status_updated_on_remove() {
+        $this->resetAfterTest();
+
+        $course = $this->getDataGenerator()->create_course();
+        $teacher = $this->getDataGenerator()->create_and_enrol($course, 'teacher');
+        $group = $this->getDataGenerator()->create_group(['courseid' => $course->id]);
+
+        $student = $this->getDataGenerator()->create_and_enrol($course, 'student');
+        groups_add_member($group, $student);
+
+        $otherstudent = $this->getDataGenerator()->create_and_enrol($course, 'student');
+        groups_add_member($group, $otherstudent);
+
+        $assign = $this->create_instance($course, [
+            'teamsubmission' => 1,
+        ]);
+        $this->add_submission($student, $assign);
+        $submission = $assign->get_group_submission($student->id, 0, false);
+
+        $sink = $this->redirectEvents();
+        $assign->remove_submission($student->id);
+
+        $events = $sink->get_events();
+        $this->assertCount(2, $events);
+
+        $event = $events[1];
+        $this->assertInstanceOf('\mod_assign\event\submission_status_updated', $event);
+        $this->assertEquals($assign->get_context(), $event->get_context());
+        $this->assertEquals($submission->id, $event->objectid);
+        $this->assertEquals(null, $event->relateduserid);
+        $this->assertEquals(ASSIGN_SUBMISSION_STATUS_NEW, $event->other['newstatus']);
+        $expected = [
+            $course->id,
+            'assign',
+            'revert submission to draft',
+            'view.php?id=' . $assign->get_course_module()->id,
+            get_string('reverttodraftforgroup', 'assign', $group->id),
+            $assign->get_course_module()->id
+        ];
+        $this->assertEventLegacyLogData($expected, $event);
+        $sink->close();
+    }
+
     public function test_marker_updated() {
         $this->resetAfterTest();
 

mod/assign/version.php

@@ -25,5 +25,5 @@
 defined('MOODLE_INTERNAL') || die();
 
 $plugin->component = 'mod_assign'; // Full name of the plugin (used for diagnostics).
-$plugin->version  = 2022112800;    // The current module version (Date: YYYYMMDDXX).
+$plugin->version  = 2023020700;    // The current module version (Date: YYYYMMDDXX).
 $plugin->requires = 2022111800;    // Requires this Moodle version.