Merge pull request #315 from turnitin/develop

Develop into master for release 2018052401

Author: jmcgettrick

CHANGELOG.md

@@ -1,3 +1,77 @@
+### Date:		2018-May-24
+### Release:	v2018052401
+
+#### :zap: What's new
+
+---
+
+#### We now support Moodle 3.5
+
+You can find out more about Moodle 3.5 via Moodle's [release notes](https://docs.moodle.org/dev/Moodle_3.5_release_notes).
+
+#### Turnitin's Plagiarism Plugin is GDPR compliant!
+
+To support upcoming changes to European data protection law, we’ve focused our efforts on refreshing our processes around how we use your data.
+
+##### Repository settings are more transparent
+
+We've made the Moodle Plagiarism Plugin repository settings much clearer, by providing easy-to-understand, transparent language behind the Store student papers help icon. During assignment setup, administrators and instructors can now be completely sure that they're selecting the correct storage options for student papers.
+
+##### We're reporting on the data we store about our users
+
+Moodle has released two plugins with privacy features to assist with GDPR compliance. While we've successfully implemented [Moodle's new privacy features](https://docs.moodle.org/dev/Privacy_API), Moodle's update is only available to those using Moodle 3.3.5+, 3.4.2+, or 3.5. Therefore, if you're using an earlier version, you must upgrade to have access to these new features.
+
+To inform you about the data we store in relation to our users, we now provide a detailed list via the Moodle Privacy and Policies page. Learn more about the data we're reporting on via our [Moodle Plugins and GDPR](https://guides.turnitin.com/03_Integrations/Turnitin_Partner_Integrations/Moodle/Moodle_Plugins_and_GDPR) page.
+
+#### Students can request to download their data
+
+Students have the ability to request an export of their data stored in Moodle. This request can be accepted or declined by their Moodle administrator. If accepted, the student will be able to download all the data held about them, which includes data from Turnitin.
+
+#### Students can request to remove their data
+
+Students can also request their data to be removed from Moodle. This requested can be accepted or declined by their Moodle administrator. If accepted, the administrator will remove the student data from Moodle. However, administrators must contact support@turnitin.com to request that student data be removed from Turnitin itself.
+  
+> If you're a Moodle administrator, and using version 3.3.5+, 3.4.2+, or 3.5, follow the steps on the [Moodle Plugins and GDPR](https://guides.turnitin.com/03_Integrations/Turnitin_Partner_Integrations/Moodle/Moodle_Plugins_and_GDPR) page to view the data we store in Moodle.
+
+#### You can now send all papers to your institutional repository by default!
+
+We're aligning Turnitin repository options with the Plagiarism Plugin. If an institutional repository is enabled on their Turnitin account, administrators can now opt to **Submit all papers to the institutional repository**. This submission storage option sends all student submissions to the institutional repository without instructor intervention. For this repository option to work successfully, it must firstly be enabled in Turnitin, before it can be configured in Moodle.
+
+If you're a Moodle administrator, follow the steps below to enable this repository setting in Turnitin:
+
+1. Log into Turnitin.com or TurnitinUK.com.
+2. Under **Edit**, select the cog  icon.
+3. Select **Edit account settings**.
+4. Scroll to **Paper repository options** and select **Submit all papers to the institution repository**.
+6. Select the **Submit** button at the bottom of the page.
+
+Now, it's time to move to Moodle!
+
+1. From the Moodle left-hand side panel, select **Site administration**.
+2. Select **Plugins**.
+3. Select **Activity Modules**.
+4. Then **Manage Activities**.
+5. Scroll to **Turnitin Assignment 2** and select **Settings**.
+6. Scroll to **Paper Repository Assignments** and select **Submit all papers to the institutional repository**.
+
+### :wrench: Fixes and enhancements
+
+#### We've removed a technical notice from the assignment settings page
+
+In Moodle's debug mode, a peculiar notice appeared within the assignment settings: 'Array to string conversion in /usr/share/nginx/html/lib/pear/HTML/QuickForm/select.php on line 501'. We've made some adjustments to ensure that this doesn't appear in future.
+
+#### You can now exit lightboxes using the 'Close' button
+       	
+We received a report that the Close button in the Plagiarism Plugin's lightboxes wasn't performing correctly, in that it wasn't actually closing anything! Instead, users saw the following error: 'Uncaught TypeError: Cannot read property 'close' of undefined at HTMLAnchorElement.onclick'. Thanks for the heads up, @Haietza! We've fixed this issue.
+
+> **Lightboxes** display content by filling the screen and dimming out the rest of the web page. They can be closed to find the website contents still available. Items such as the QuickMark manager and the rubric manager are contained inside a lightbox.
+
+#### Instructors can now successfully submit on behalf of a student
+  	
+An instructor encountered an issue when attempting to resubmit on behalf of a student within a group submission. This was down to us incorrectly checking the permissions of the student, rather than the submitter. These permissions told us that the student wasn't permitted to resubmit to the assignment, but if we'd checked the instructor permissions, we'd have found that their permissions allowed this. Phew. A big thanks to @micaherne for his patch to fix this! It did the job nicely.
+
+---
+
 ### :snowflake: Date:		2018-January-16
 ### :snowflake: Release:	v2018011602
 

classes/digitalreceipt/pp_receipt_message.php

@@ -31,11 +31,17 @@ class pp_receipt_message {
      * @param string $message
      * @return void
      */
-    public function send_message($userid, $message) {
+    public function send_message($userid, $message, $courseid) {
+        global $CFG;
 
         $subject = get_string('digital_receipt_subject', 'plagiarism_turnitin');
 
-        $eventdata = new stdClass();
+        // Pre 2.9 does not have \core\message\message()
+        if ($CFG->branch >= 29) {
+            $eventdata = new \core\message\message();
+        } else {
+            $eventdata = new stdClass();
+        }
         $eventdata->component         = 'plagiarism_turnitin'; // Your component name.
         $eventdata->name              = 'submission'; // This is the message name from messages.php.
         $eventdata->userfrom          = \core_user::get_noreply_user();
@@ -46,6 +52,7 @@ public function send_message($userid, $message) {
         $eventdata->fullmessagehtml   = $message;
         $eventdata->smallmessage      = '';
         $eventdata->notification      = 1; // This is only set to 0 for personal messages between users.
+        $eventdata->courseid          = $courseid;
 
         message_send($eventdata);
     }

classes/modules/turnitin_assign.class.php

@@ -69,7 +69,7 @@ public function set_content($linkarray, $cm) {
      * @param $assignid
      */
     public function is_resubmission_allowed($assignid, $reportgenspeed, $submissiontype, $attemptreopenmethod) {
-        global $DB;
+        global $DB, $CFG;
 
         // Get the maximum number of file submissions allowed.
         $params = array('assignment' => $assignid,
@@ -82,6 +82,10 @@ public function is_resubmission_allowed($assignid, $reportgenspeed, $submissiont
             $maxfilesubmissions = $result->value;
         }
 
+        if ($CFG->branch <= 32) {
+            require_once($CFG->dirroot.'/mod/assign/lib.php');
+        }
+
         return ($reportgenspeed > 0 && $attemptreopenmethod == ASSIGN_ATTEMPT_REOPEN_METHOD_NONE
             && ($submissiontype == 'text_content' || $maxfilesubmissions == 1));
     }

classes/modules/turnitin_forum.class.php

@@ -46,12 +46,19 @@ public function user_enrolled_on_course($context, $userid) {
         return has_capability('mod/'.$this->modname.':replypost', $context, $userid);
     }
 
-    public function get_author($itemid) {
+    public function get_author($itemid = 0) {
         return;
     }
 
-    public function set_content($linkarray, $moduleid) {
-        return $linkarray["content"];
+    public function set_content($linkarray) {
+        global $DB;
+
+        if (empty($linkarray['postid'])) {
+            return $linkarray["content"];
+        } else {
+            $post = $DB->get_record('forum_posts', array('id' => $linkarray['postid']));
+            return $post->message;
+        }
     }
 
     public function create_file_event($params) {

classes/privacy/provider.php

@@ -0,0 +1,199 @@
+<?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/>.
+
+/**
+ * Privacy Subsystem implementation for mod_turnitintool.
+ *
+ * @package    plagiarism_turnitin
+ * @copyright  2018 David Winn <dwinn@turnitin.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace plagiarism_turnitin\privacy;
+
+defined('MOODLE_INTERNAL') || die();
+
+use core_privacy\local\metadata\collection;
+use core_privacy\local\request\contextlist;
+use core_privacy\local\request\helper;
+use core_privacy\local\request\writer;
+
+class provider implements
+    // This plugin does store personal user data.
+    \core_privacy\local\metadata\provider,
+    \core_plagiarism\privacy\plagiarism_provider {
+
+    // This trait must be included to provide the relevant polyfill for the metadata provider.
+    use \core_privacy\local\legacy_polyfill;
+
+    // This trait must be included to provide the relevant polyfill for the plagirism provider.
+    use \core_plagiarism\privacy\legacy_polyfill;
+
+    /**
+     * Return the fields which contain personal data.
+     *
+     * @param $collection collection a reference to the collection to use to store the metadata.
+     * @return $collection the updated collection of metadata items.
+     */
+    public static function _get_metadata(collection $collection) {
+
+        $collection->link_subsystem(
+            'core_files',
+            'privacy:metadata:core_files'
+        );
+
+        $collection->add_database_table(
+            'plagiarism_turnitin_files',
+            [
+                'userid' => 'privacy:metadata:plagiarism_turnitin_files:userid',
+                'similarityscore' => 'privacy:metadata:plagiarism_turnitin_files:submissionscore',
+                'attempt' => 'privacy:metadata:plagiarism_turnitin_files:attempt',
+                'transmatch' => 'privacy:metadata:plagiarism_turnitin_files:transmatch',
+                'lastmodified' => 'privacy:metadata:plagiarism_turnitin_files:lastmodified',
+                'grade' => 'privacy:metadata:plagiarism_turnitin_files:grade',
+                'orcapable' => 'privacy:metadata:plagiarism_turnitin_files:orcapable',
+                'student_read' => 'privacy:metadata:plagiarism_turnitin_files:student_read',
+            ],
+            'privacy:metadata:plagiarism_turnitin_files'
+        );
+
+        $collection->link_external_location('plagiarism_turnitin_client', [
+            'email' => 'privacy:metadata:plagiarism_turnitin_client:email',
+            'firstname' => 'privacy:metadata:plagiarism_turnitin_client:firstname',
+            'lastname' => 'privacy:metadata:plagiarism_turnitin_client:lastname',
+            'submission_title' => 'privacy:metadata:plagiarism_turnitin_client:submission_title',
+            'submission_filename' => 'privacy:metadata:plagiarism_turnitin_client:submission_filename',
+        ], 'privacy:metadata:plagiarism_turnitin_client');
+
+        return $collection;
+    }
+
+    /**
+     * Get the list of contexts that contain user information for the specified user.
+     *
+     * @param int $userid the userid.
+     * @return contextlist the list of contexts containing user info for the user.
+     */
+    public static function _get_contexts_for_userid($userid) {
+
+        $params = ['modulename' => 'assign',
+            'contextlevel' => CONTEXT_MODULE,
+            'userid' => $userid];
+
+        $sql = "SELECT ctx.id
+                  FROM {course_modules} cm
+                  JOIN {modules} m ON cm.module = m.id AND m.name = :modulename
+                  JOIN {assign} a ON cm.instance = a.id
+                  JOIN {context} ctx ON cm.id = ctx.instanceid AND ctx.contextlevel = :contextlevel
+             LEFT JOIN {plagiarism_turnitin_files} tf ON cm.instance = cm
+                 WHERE tf.userid = :userid";
+
+        $contextlist = new contextlist();
+        $contextlist->add_from_sql($sql, $params);
+
+        return $contextlist;
+    }
+
+
+    /**
+     * Export all plagiarism data from each plagiarism plugin for the specified userid and context.
+     *
+     * @param   int         $userid The user to export.
+     * @param   \context    $context The context to export.
+     * @param   array       $subcontext The subcontext within the context to export this information to.
+     * @param   array       $linkarray The weird and wonderful link array used to display information for a specific item
+     */
+    public static function _export_plagiarism_user_data($userid, \context $context, array $subcontext, array $linkarray) {
+        global $DB;
+
+        $user = $DB->get_record('user', array('id' => $userid));
+
+        $params = ['userid' => $user->id];
+
+        $sql = "SELECT cm,
+                similarityscore,
+                attempt,
+                transmatch,
+                lastmodified,
+                grade,
+                orcapable,
+                student_read
+                  FROM {plagiarism_turnitin_files}
+                 WHERE userid = :userid";
+        $submissions = $DB->get_records_sql($sql, $params);
+
+        foreach ($submissions as $submission) {
+            $context = \context_module::instance($submission->cm);
+            self::_export_plagiarism_turnitin_data_for_user((array)$submission, $context, $user);
+        }
+    }
+
+    /**
+     * Export the supplied personal data for a single activity, along with any generic data or area files.
+     *
+     * @param array $submissiondata the personal data to export.
+     * @param \context_module $context the module context.
+     * @param \stdClass $user the user record
+     */
+    protected static function _export_plagiarism_turnitin_data_for_user(array $submissiondata, \context_module $context, \stdClass $user) {
+        // Fetch the generic module data.
+        $contextdata = helper::get_context_data($context, $user);
+
+        // Merge with module data and write it.
+        $contextdata = (object)array_merge((array)$contextdata, $submissiondata);
+        writer::with_context($context)->export_data([], $contextdata);
+
+        // Write generic module intro files.
+        helper::export_context_files($context, $user);
+    }
+
+    /**
+     * Delete all data for all users in the specified context.
+     *
+     * @param \context $context the context to delete in.
+     */
+    public static function _delete_plagiarism_for_context(\context $context) {
+        global $DB;
+
+        if (empty($context)) {
+            return;
+        }
+
+        if (!$context instanceof \context_module) {
+            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]);
+
+    }
+
+    /**
+     * Delete all user information for the provided user and context.
+     *
+     * @param  int      $userid    The user to delete
+     * @param  \context $context   The context to refine the deletion.
+     */
+    public static function _delete_plagiarism_for_user($userid, \context $context) {
+        global $DB;
+
+        $DB->delete_records('plagiarism_turnitin_files', ['userid' => $userid]);
+    }
+}

jquery/jquery-1.8.2.min.js

@@ -167,7 +167,7 @@ jQuery(document).ready(function($) {
     }
 
     function lightBoxCloseButton(closeBtnText) {
-        $('body').append('<div id="tii_close_bar"><a href="#" onclick="$.colorbox.close(); return false;">' + M.str.plagiarism_turnitin.closebutton + '</a></div>');
+        $('body').append('<div id="tii_close_bar"><a href="#" onclick="jQuery(\'#cboxClose\').click(); return false;">' + M.str.plagiarism_turnitin.closebutton + '</a></div>');
     }
 
     function getLoadingGif() {

jquery/jquery-3.3.1.min.js

@@ -78,7 +78,6 @@
 $string['standardrepository'] = 'المستودع القياسي';
 $string['submitpapersto'] = 'حفظ مستندات الطلبة';
 $string['institutionalrepository'] = 'المستودعات المؤسسية (عند الاقتضاء)';
-$string['submitpapersto_help'] = 'سيوفر هذا الإعداد للمدرسين القدرة على اختيار ما اذا كانت المستندات ستحفظ في مستودع مستندات الطلبة. تكمن الفائدة من ارسال المستندات إلى مستودع مستندات الطلبة في التحقق من مستندات الطلاب التي تم إرسالها مقابل إرسالات 'الطلاب الآخرين في صفوفك الدراسية الحالية أو السابقة. إذا اخترت "لا مستودعات" فلن يتم تخزين المستندات في مخزن مستندات الطلاب.'';
 $string['checkagainstnote'] = 'ملحوظة: إذا لم تحدد "نعم" لخيار "التحقق مقابل..." واحد على الأقل الموجود أدناه، فلن يتم إنشاء تقرير الأصالة.';
 $string['spapercheck'] = 'قحص مقابل مستندات الطلبة المخزونة';
 $string['internetcheck'] = 'فحص مقابل الإنترنت';
@@ -199,3 +198,5 @@
 $string['deleted'] = 'تم حذف';
 $string['pending'] = 'قيد الانتظار';
 $string['because'] = 'هذا بسبب قيام أحد المسؤولين بحذف مهمة معلقة من قائمة المعالجة وإيقاف الإرسال إلى Turnitin. <br /><strong>ما زال الملف موجودًا في Moodle، الرجاء الاتصال بمعلمك.</strong><br />الرجاء الاطلاع أدناه على أي رموز خطأ:';
+$string['submitpapersto_help'] = '<strong>لا توجد مستودعات: </strong><br />تتم مطالبة Turnitin بعدم تخزين المستندات المرسلة في أي مستودع. وسوف تقتصر معالجتنا للورق على إجراء فحص أولي على التشابه.<br /><br /><strong>المستودع القياسي: </strong><br />سوف يخزن Turnitin نُسخة من المستندات المرسلة فقط في المستودع القياسي. وباختيار هذا الخيار، يتم توجيه Turnitin باستخدام المستندات المخزنة فقط لإجراء فحوصات تشابه على المستندات التي يتم إرسالها لاحقًا.<br /><br /><strong>المستودعات المؤسسية (عند الاقتضاء): </strong><br />باختيار هذا الخيار، يتم توجيه Turnitin إلى إضافة المستندات المرسلة إلى المستودع الخاص بالمؤسسة فقط. ويتم إجراء فحوصات التشابه على المستندات المرسلة بواسطة معلمين آخرين من مؤسستك.';
+$string['errorcode12'] = 'لم يتم إرسال هذا الملف إلى Turnitin، لأنه ينتمي إلى مهمة تم حذف دورتها التدريبية. معرف السطر: ({$a->id}) | معرف وحدة الدورة: ({$a->cm}) | معرف المستخدم: ({$a->userid})';