Merge pull request #336 from turnitin/develop

Develop to master for release

Author: jmcgettrick

CHANGELOG.md

@@ -1,3 +1,26 @@
+### 2018-June-26
+### v2018062601
+
+#### Fixes and enhancements
+
+---
+
+#### Resubmissions now overwrite the previous submission
+
+When a student made a resubmission to Turnitin, their previous submission wasn't removed from the assignment inbox; this led to confusion for instructors, who weren't too sure which submission was the most up-to-date version. We've made sure that resubmissions now overwrite the existing submission.
+
+> **Known issue:** While we've been able to fix this issue for students, if an instructor resubmits on behalf of a student, multiple submissions may still appear in Turnitin. We're working on a fix for this and will update you as soon as we find one!
+
+#### The Plagiarism Plugin now works on Moodle 3.1 and earlier versions
+
+Users running Moodle version 3.1 or earlier encountered an unexpected error when submitting a file. The error message, referring to an invalid parameter, was the result of a change made in our previous release. We apologize for the trouble this may have caused and can confirm that Moodle version 3.1 and earlier now function correctly.
+
+#### Moodle unit tests now pass
+
+We’ve ensured all Moodle unit tests now pass with the plugin installed. Thanks to @danmarsden and @kenneth-hendricks for their contributions.
+
+---
+
 ### Date:		2018-May-24
 ### Release:	v2018052401
 

classes/digitalreceipt/pp_receipt_message.php

@@ -52,7 +52,10 @@ public function send_message($userid, $message, $courseid) {
         $eventdata->fullmessagehtml   = $message;
         $eventdata->smallmessage      = '';
         $eventdata->notification      = 1; // This is only set to 0 for personal messages between users.
-        $eventdata->courseid          = $courseid;
+
+        if ($CFG->branch >= 32) {
+            $eventdata->courseid = $courseid;
+        }
 
         message_send($eventdata);
     }

classes/modules/turnitin_assign.class.php

@@ -68,7 +68,7 @@ public function set_content($linkarray, $cm) {
      *
      * @param $assignid
      */
-    public function is_resubmission_allowed($assignid, $reportgenspeed, $submissiontype, $attemptreopenmethod) {
+    public function is_resubmission_allowed($assignid, $reportgenspeed, $submissiontype, $attemptreopenmethod, $attemptreopened = null) {
         global $DB, $CFG;
 
         // Get the maximum number of file submissions allowed.
@@ -82,12 +82,20 @@ public function is_resubmission_allowed($assignid, $reportgenspeed, $submissiont
             $maxfilesubmissions = $result->value;
         }
 
-        if ($CFG->branch <= 32) {
-            require_once($CFG->dirroot.'/mod/assign/lib.php');
+        require_once($CFG->dirroot . '/mod/assign/locallib.php');
+
+        // If resubmissions are enabled in a Turnitin sense.
+        if ($reportgenspeed > 0) {
+            // If the attempt reopened method is none, or an attempt has not been reopened/has previous submission.
+            if ($attemptreopenmethod == ASSIGN_ATTEMPT_REOPEN_METHOD_NONE || $attemptreopened == 'submitted') {
+                // If this is a text or file submission, or we can only submit one file.
+                if ($submissiontype == 'text_content' || ($submissiontype == 'file' && $maxfilesubmissions == 1)) {
+                    // Treat this as a resubmission.
+                    return true;
+                }
+            }
         }
-
-        return ($reportgenspeed > 0 && $attemptreopenmethod == ASSIGN_ATTEMPT_REOPEN_METHOD_NONE
-            && ($submissiontype == 'text_content' || $maxfilesubmissions == 1));
+        return false;
     }
 
     public function get_onlinetext($userid, $cm) {
@@ -102,8 +110,13 @@ public function get_onlinetext($userid, $cm) {
 
         $onlinetextdata = new stdClass();
         $onlinetextdata->itemid = $submission->id;
-        $onlinetextdata->onlinetext = $moodletextsubmission->onlinetext;
-        $onlinetextdata->onlineformat = $moodletextsubmission->onlineformat;
+
+        if (isset($moodletextsubmission->onlinetext)) {
+            $onlinetextdata->onlinetext = $moodletextsubmission->onlinetext;
+        }
+        if (isset($moodletextsubmission->onlineformat)) {
+            $onlinetextdata->onlineformat = $moodletextsubmission->onlineformat;
+        }
 
         return $onlinetextdata;
     }

classes/privacy/provider.php

@@ -119,6 +119,10 @@ public static function _get_contexts_for_userid($userid) {
     public static function _export_plagiarism_user_data($userid, \context $context, array $subcontext, array $linkarray) {
         global $DB;
 
+        if (empty($userid)) {
+            return;
+        }
+
         $user = $DB->get_record('user', array('id' => $userid));
 
         $params = ['userid' => $user->id];
@@ -176,12 +180,8 @@ public static function _delete_plagiarism_for_context(\context $context) {
             return;
         }
 
-        $instanceid = $DB->get_field('course_modules', 'instance', ['id' => $context->instanceid], MUST_EXIST);
-
-        $cm = get_coursemodule_from_instance('assign', $instanceid);
-
         // Delete all submissions.
-        $DB->delete_records('plagiarism_turnitin_files', ['cm' => $cm->id]);
+        $DB->delete_records('plagiarism_turnitin_files', ['cm' => $context->instanceid]);
 
     }
 

jquery/turnitin_module.js

@@ -194,7 +194,7 @@ jQuery(document).ready(function($) {
 
     // Open the DV in a new window in such a way as to not be blocked by popups.
     function openDV(dvtype, submissionid, coursemoduleid, url) {
-        dvWindow = window.open('', '_blank');
+        dvWindow = window.open('', 'turnitin_viewer');
         var loading = '<div class="tii_dv_loading" style="text-align:center;">';
         loading += '<img src="' + M.cfg.wwwroot + '/plagiarism/turnitin/pix/tiiIcon.svg" style="width:100px; height: 100px">';
         loading += '<p style="font-family: Arial, Helvetica, sans-serif;">' + M.str.plagiarism_turnitin.loadingdv + '</p>';

jquery/turnitin_module_post29.js

@@ -194,7 +194,7 @@ require(['jquery'], function($) {
 
     // Open the DV in a new window in such a way as to not be blocked by popups.
     function openDV(dvtype, submissionid, coursemoduleid, url) {
-        dvWindow = window.open('', '_blank');
+        dvWindow = window.open('', 'turnitin_viewer');
         var loading = '<div class="tii_dv_loading" style="text-align:center;">';
         loading += '<img src="' + M.cfg.wwwroot + '/plagiarism/turnitin/pix/tiiIcon.svg" style="width:100px; height: 100px">';
         loading += '<p style="font-family: Arial, Helvetica, sans-serif;">' + M.str.plagiarism_turnitin.loadingdv + '</p>';

lib.php

@@ -2127,7 +2127,7 @@ public function migrate_previous_course($coursedata, $turnitincid, $workflowcont
      * @param int $itemid
      * @return bool
      */
-    public function queue_submission_to_turnitin($cm, $author, $submitter, $identifier, $submissiontype, $itemid = 0) {
+    public function queue_submission_to_turnitin($cm, $author, $submitter, $identifier, $submissiontype, $itemid = 0, $eventtype = null) {
         global $CFG, $DB, $turnitinacceptedfiles;
         $errorcode = 0;
         $attempt = 0;
@@ -2141,13 +2141,31 @@ public function queue_submission_to_turnitin($cm, $author, $submitter, $identifi
         // Get module data.
         $moduledata = $DB->get_record($cm->modname, array('id' => $cm->instance));
         $moduledata->resubmission_allowed = false;
+
         if ($cm->modname == 'assign') {
+            if (!isset($_SESSION["moodlesubmissionstatus"])) {
+                $_SESSION["moodlesubmissionstatus"] = null;
+            }
+
+            if ($eventtype == "content_uploaded" || $eventtype == "file_uploaded") {
+                $moodlesubmission = $DB->get_record('assign_submission',
+                    array('assignment' => $cm->instance,
+                        'userid' => $author,
+                        'id' => $itemid), 'status');
+                $_SESSION["moodlesubmissionstatus"] = $moodlesubmission->status;
+            }
+
             $moduledata->resubmission_allowed = $moduleobject->is_resubmission_allowed(
                 $cm->instance,
                 $settings["plagiarism_report_gen"],
                 $submissiontype,
-                $moduledata->attemptreopenmethod
+                $moduledata->attemptreopenmethod,
+                $_SESSION["moodlesubmissionstatus"]
             );
+
+            if ($eventtype != "content_uploaded" && $eventtype != "file_uploaded") {
+                unset($_SESSION["moodlesubmissionstatus"]);
+            }
         }
 
         // Work out submission method.
@@ -2188,8 +2206,8 @@ public function queue_submission_to_turnitin($cm, $author, $submitter, $identifi
 
                 // Check if this content/file has been submitted previously.
                 $previoussubmissions = $DB->get_records_select('plagiarism_turnitin_files',
-                                                    " cm = ? AND userid = ? AND ".$typefield." = ? AND identifier = ? ",
-                                                array($cm->id, $author, $submissiontype, $identifier),
+                                                    " cm = ? AND userid = ? AND ".$typefield." = ? ",
+                                                array($cm->id, $author, $submissiontype),
                                                     'id', $submissionfields);
                 $previoussubmission = end($previoussubmissions);
 
@@ -2199,7 +2217,7 @@ public function queue_submission_to_turnitin($cm, $author, $submitter, $identifi
                             && $timemodified <= $previoussubmission->lastmodified) {
                         return true;
                     } else if ($moduledata->resubmission_allowed) {
-                        // Replace submission in the specific circumstance where Turnitin can accomodate resubmissions.
+                        // Replace submission in the specific circumstance where Turnitin can accommodate resubmissions.
                         $submissionid = $previoussubmission->id;
                         $this->reset_tii_submission($cm, $author, $identifier, $previoussubmission, $submissiontype);
                         $tiisubmissionid = $previoussubmission->externalid;
@@ -2209,6 +2227,7 @@ public function queue_submission_to_turnitin($cm, $author, $submitter, $identifi
                             $this->reset_tii_submission($cm, $author, $identifier, $previoussubmission, $submissiontype);
                         } else {
                             $submissionid = $this->create_new_tii_submission($cm, $author, $identifier, $submissiontype);
+                            $tiisubmissionid = $previoussubmission->externalid;
                         }
                     }
                     $attempt = $previoussubmission->attempt;
@@ -2389,7 +2408,7 @@ public function event_handler($eventdata) {
                 return true;
             } else {
                 $result = $this->queue_submission_to_turnitin(
-                                            $cm, $author, $submitter, $identifier, $submissiontype, $eventdata['objectid']);
+                                            $cm, $author, $submitter, $identifier, $submissiontype, $eventdata['objectid'], $eventdata['eventtype']);
             }
         }
 
@@ -2422,7 +2441,7 @@ public function event_handler($eventdata) {
 
                 $result = $result && $this->queue_submission_to_turnitin(
                                                 $cm, $author, $submitter, $pathnamehash, 'file',
-                                                $eventdata['objectid']);
+                                                $eventdata['objectid'], $eventdata['eventtype']);
             }
         }
 
@@ -2691,11 +2710,18 @@ function plagiarism_turnitin_send_queued_submissions() {
         // Get module data.
         $moduledata = $DB->get_record($cm->modname, array('id' => $cm->instance));
         $moduledata->resubmission_allowed = false;
+
         if ($cm->modname == 'assign') {
+            $moodlesubmission = $DB->get_record('assign_submission',
+                array('assignment' => $cm->instance,
+                    'userid' => $queueditem->userid,
+                    'id' => $queueditem->itemid), 'status');
+
             $moduledata->resubmission_allowed = $moduleobject->is_resubmission_allowed(
                 $cm->instance, $settings["plagiarism_report_gen"],
                 $queueditem->submissiontype,
-                $moduledata->attemptreopenmethod
+                $moduledata->attemptreopenmethod,
+                $moodlesubmission->status
             );
         }
 
@@ -2814,7 +2840,6 @@ function plagiarism_turnitin_send_queued_submissions() {
                 if (is_null($queueditem->externalid)) {
                     $apimethod = "createSubmission";
                 } else {
-
                     $apimethod = ($moduledata->resubmission_allowed) ? "replaceSubmission" : "createSubmission";
 
                     // Delete old text content submissions from Turnitin if not replacing.

tests/behat/assignment.feature

@@ -0,0 +1,95 @@
+@plugin @plagiarism @plagiarism_turnitin @plagiarism_turnitin_sanity @plagairism_turnitin_smoke @plagiarism_turnitin_assignment
+Feature: Plagiarism plugin works with a Moodle Assignment
+  In order to allow students to send assignment submissions to Turnitin
+  As a user
+  I need to create an assignment with the plugin enabled and the assignment to launch successfully.
+
+  Background: Set up the plugin
+    Given the following "courses" exist:
+      | fullname | shortname | category | groupmode |
+      | Course 1 | C1        | 0        | 0         |
+    And I create a unique user with username "student1"
+    And I create a unique user with username "instructor1"
+    And the following "course enrolments" exist:
+      | user        | course | role    |
+      | student1    | C1     | student |
+      | instructor1 | C1     | teacher |
+    And I log in as "admin"
+    And I navigate to "Advanced features" node in "Site administration"
+    And I set the field "Enable plagiarism plugins" to "1"
+    And I press "Save changes"
+    And I navigate to "Turnitin" node in "Site administration > Plugins > Plagiarism"
+    And I set the following fields to these values:
+      | Enable Turnitin            | 1 |
+      | Enable Turnitin for assign | 1 |
+    And I press "Save changes"
+    And I navigate to "Turnitin Assignment 2" node in "Site administration > Plugins > Activity modules"
+    And I configure Turnitin URL
+    And I configure Turnitin credentials
+    And I set the following fields to these values:
+      | Enable Diagnostic Mode | Standard |
+    And I press "Save changes"
+    Then the following should exist in the "plugins-control-panel" table:
+      | Plugin name         |
+      | plagiarism_turnitin |
+    # Create Assignment.
+    And I am on "Course 1" course homepage with editing mode on
+    And I add a "Assignment" to section "1" and I fill the form with:
+      | Assignment name                   | Test assignment name |
+      | use_turnitin                      | 1                    |
+      | plagiarism_compare_student_papers | 1                    |
+    Then I should see "Test assignment name"
+
+  @javascript
+  Scenario: Student accepts eula, submits and instructor opens the viewer
+    Given I log out
+    # Student accepts eula.
+    And I log in as "student1"
+    And I am on "Course 1" course homepage
+    And I follow "Test assignment name"
+    And I press "Add submission"
+    And I click on ".pp_turnitin_eula_link" "css_element"
+    And I wait until ".cboxIframe" "css_element" exists
+    And I switch to iframe with locator ".cboxIframe"
+    And I wait until the page is ready
+    And I click on ".agree-button" "css_element"
+    And I wait until the page is ready
+    Then I should see "Test assignment name"
+    # Student submits.
+    And I am on "Course 1" course homepage
+    And I follow "Test assignment name"
+    And I press "Add submission"
+    And I upload "plagiarism/turnitin/tests/fixtures/testfile.txt" file to "File submissions" filemanager
+    And I press "Save changes"
+    Then I should see "Submitted for grading"
+    And I should see "Queued"
+    # Trigger cron as admin for submission
+    And I log out
+    And I log in as "admin"
+    And I run the scheduled task "plagiarism_turnitin\task\send_submissions"
+    # Instructor opens viewer
+    And I log out
+    And I log in as "instructor1"
+    And I am on "Course 1" course homepage
+    And I follow "Test assignment name"
+    Then I should see "View all submissions"
+    When I navigate to "View all submissions" in current page administration
+    Then I should see "Turnitin ID:"
+    # Trigger cron as admin for report
+    And I log out
+    And I log in as "admin"
+    And I run the scheduled task "\plagiarism_turnitin\task\update_reports"
+    # Instructor opens viewer
+    And I log out
+    And I log in as "instructor1"
+    And I am on "Course 1" course homepage
+    And I follow "Test assignment name"
+    Then I should see "View all submissions"
+    When I navigate to "View all submissions" in current page administration
+    And I wait until "[alt='GradeMark']" "css_element" exists
+    And I click on "[alt='GradeMark']" "css_element"
+    And I switch to "turnitin_viewer" window
+    And I wait until the page is ready
+    And I click on ".agree-button" "css_element"
+    And I wait until the page is ready
+    Then I should see "testfile.txt"