Merge pull request #396 from turnitin/develop

Release 2017103001

Author: jmcgettrick

.gitignore

@@ -7,3 +7,4 @@ node_modules/
 /.settings/
 /.buildpath
 /.project
+/.idea

CHANGELOG.md

@@ -1,3 +1,57 @@
+### Date:		2017-October-30
+### Release:	v2017103001
+
+V1 to V2 Moodle Migration Tool
+
+**The Moodle Migration Tool is now in early access mode!** - Before making the Moodle Migration Tool available to all of our Moodle users, we asked a subset of users to test the tool and advise us of any issues or errors they may have stumbled across during their experimenting. We'd like to thank all of our testers for their useful comments; they've helped us make the tool even better!
+
+Calling all administrators! To access the Moodle migration tool and enable instructor migration, visit our guide.
+
+Below, you can find several updates we've made to the tool based on the issues raised by our testers:
+
+- Updated migration tool setting information
+- We've made improvements to the migration workflow
+- We've made some table adjustments
+- Fixed an issue causing the grade book to unsuccessfully migrate
+
+**Updated migration tool setting information** - We've updated the information behind the question mark icon connected to the 'Migration action at assignment launch' setting; this referred to old functionality in the Moodle Migration Tool. The text now reflects the current state of the tool. Apologies if you became a little confused! 
+
+**We've made improvements to the migration workflow** -  We've made the migration workflow clearer by prompting the user to migrate on all V1 assignments. Even if you navigate away from the assignment, you'll be prompted again when you return. We hope this helps make your migration a smooth and simple one. 
+
+**We've made some table adjustments** - The table of migrated V1 assignments was appearing a little unkempt, so we tidied up by setting the table width. The table now looks much more aesthetically pleasing! 
+
+**Fixed an issue causing the grade book to unsuccessfully migrate** - When migrating we found a potential issue that would cause the migration of grade book to fail which would lead to issues with the migration of assignments. We've preemptively fixed this so you will be able to migrate your assignments without issue. 
+
+We've also been working on...
+
+- Fixed a bug preventing student enrollment
+- Removed the visibility of the delete icon after submission
+- Anonymous marking grades now pass to the grade book in all databases
+- Unit tests now pass successfully
+- Fixed several incorrectly named variables
+
+**Fixed a bug preventing student enrollment** - We received an alert that the Enrol All Students button accessible via the Turnitin Students tab wasn't functioning correctly; this removed the ability for students enrolled in the same class via Turnitin.com or TurnitinUK.com to submit to their Moodle Direct V2 assignment. We identified a missing parameter causing the issue and simply reinserted it. The button now works as intended. Thanks to @neillm for his input!
+
+> A parameter is a piece of information passed to a program by a user or another program; this information can be a name, number, or a selected option. Parameters have an effect on the operation of the program receiving them.
+
+**Removed the visibility of the delete icon after submission** - We received several reports from an institution concerning the presence of the submission delete icon in the student submission inbox. For assignments with resubmissions disabled, students who'd submitted an incorrect file type managed to delete and resubmit their paper. Although this is useful for students who've made a genuine submission error, this was not intended functionality.
+
+We also heard that by allowing late submissions in an assignment, this enabled students to delete and resubmit their paper after the post date. This unintentionally allowed students to resubmit after any instructor marking or grading had taken place. The delete icon has now been removed, meaning students will only be able to submit following the permissions set by their instructor.
+
+**Anonymous marking grades now pass to the grade book** - We noticed that grades failed to populate the grade book for papers submitted to an assignment with anonymous marking enabled. The call to send these grades failed in the Microsoft SQL database and produced an error. Not to worry! All grades now send to the grade book as expected.
+
+> SQL statements are used to perform tasks, such as updating data within a database (updating the grade book with grades!), or retrieving data from a database.
+
+**Unit tests now pass successfully** - With thanks to @danmarsden for his work on fixing some of our broken unit tests. These improvements help to instill user confidence in Moodle Direct V2.
+
+> Unit tests involve testing certain functions and areas – or units – of code. This gives developers the ability to verify that software functions work as intended.
+
+**Fixed several incorrectly named variables** - We've implemented some fixes kindly provided by @sk-unikent which tidied up several variable issues.
+
+> Variables are used to store information for easy manipulation and reference in a computer program. Rather than entering data directly into a program, a variable is used to represent data. When a program is executed, a variable is replaced with actual data. For example, firstName is a variable because it can be referenced and replaced with the actual first name of an individual.
+
+---
+
 ### Date:		2017-August-09
 ### Release:	v2017080901
 

activate_migration.php

@@ -127,7 +127,7 @@
         $turnitinuser = $DB->get_record('turnitintooltwo_users', array('userid' => $USER->id));
 
         // Build user object for update.
-        $eulauser = new object();
+        $eulauser = new \stdClass();
         $eulauser->id = $turnitinuser->id;
         $eulauser->user_agreement_accepted = 0;
         if ($message == 'turnitin_eula_accepted') {

ajax.php

@@ -31,6 +31,11 @@
 class backup_turnitintooltwo_activity_structure_step extends backup_activity_structure_step {
 
     protected function define_structure() {
+        // Required otherwise Moodle unit test core_calendar_container_testcase calendar/tests/container_test.php will fail.
+        if (defined('PHPUNIT_TEST') && PHPUNIT_TEST) {
+            set_config('accountid', 'NULL', 'turnitintooltwo');
+        }
+
         $config = turnitintooltwo_admin_config();
 
         // To know if we are including userinfo.

backup/moodle2/backup_turnitintooltwo_stepslib.php

@@ -701,7 +701,7 @@ public static function output_settings_form($enablesetting = true) {
      * @return object $activation - db record of the migration activation row inserted into config_plugins.
      */
     public static function activate_migration() {
-        global $DB, $CFG;
+        global $DB;
         $migration_enabled_params = array(
             'plugin' => 'turnitintooltwo',
             'name' => 'migration_enabled'
@@ -722,4 +722,27 @@ public static function activate_migration() {
 
         return $activation;
     }
+
+    public static function check_account($accountid) {
+        global $CFG;
+
+        $config = turnitintooltwo_admin_config();
+
+        $tiiapiurl = (substr($config->apiurl, -1) == '/') ? substr($config->apiurl, 0, -1) : $config->apiurl;
+
+        $ch = curl_init();
+        curl_setopt($ch, CURLOPT_URL, $tiiapiurl."/api/rest/check?lang=en_us&operation=mdl-migration&account=".$accountid);
+        curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
+
+        if (isset($CFG->proxyhost) AND !empty($CFG->proxyhost)) {
+            curl_setopt($ch, CURLOPT_PROXY, $CFG->proxyhost.':'.$CFG->proxyport);
+        }
+        if (isset($CFG->proxyuser) AND !empty($CFG->proxyuser)) {
+            curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_ANY);
+            curl_setopt($ch, CURLOPT_PROXYUSERPWD, sprintf('%s:%s', $CFG->proxyuser, $CFG->proxypassword));
+        }
+
+        curl_exec($ch);
+        curl_close($ch);
+    }
 }

classes/v1migration/v1migration.php

@@ -238,7 +238,7 @@ function xmldb_turnitintooltwo_upgrade($oldversion) {
         $dbman->add_key($table, $key);
     }
 
-    if ($oldversion < 2017071901) {
+    if ($oldversion < 2017103001) {
         $table = new xmldb_table('turnitintooltwo');
         // Add field for flagging whether a V2 assignment is a legacy V1 assignment.
         $field = new xmldb_field('legacy', XMLDB_TYPE_INTEGER, '1', false, null, false, '0', 'anongradebook');

db/upgrade.php

@@ -736,6 +736,14 @@
                         return response.msg;
                     } else if (response.field == "maxmarks") {
                         $('#refresh_' + response.partid).click();
+
+                        // Update the gradebook.
+                        $.ajax({
+                            type: "POST",
+                            url: M.cfg.wwwroot + "/mod/turnitintooltwo/ajax.php",
+                            dataType: "json",
+                            data: { action: "sync_all_submissions", assignment: $('#assignment_id').html(), sesskey: M.cfg.sesskey }
+                        });
                     } else if (response.field == "partname") {
                         var tabId = $(this).parentsUntil('.ui-tabs-panel').parent().attr('aria-labelledby');
                         $('#' + tabId).text(newValue);

jquery/turnitintooltwo.js

@@ -6,12 +6,12 @@ $(document).ready(function(){
         "type": "POST",
         "url": M.cfg.wwwroot + "/mod/turnitintooltwo/ajax.php",
         "data": {
-            action: "check_migrated", 
+            action: "check_migrated",
             turnitintoolid: $("#migrate_type").data("turnitintoolid"),
             sesskey: M.cfg.sesskey
         },
         "success": function(data) {
-            if (data.migrated == true) {
+            if (data.migrated === true) {
                 window.location.href = M.cfg.wwwroot + "/mod/turnitintooltwo/view.php?id="+data.v2id;
             } else {
                 displayMigrationModal();
@@ -66,7 +66,7 @@ function migrate(courseid, turnitintoolid) {
                 $.colorbox.close();
             }
             $('#migration_alert').hide();
-            window.location.href = M.cfg.wwwroot + "/mod/turnitintooltwo/view.php?id="+data.id;
+            window.location.href = M.cfg.wwwroot + "/mod/turnitintooltwo/view.php?id="+data.id+"&migrated=1";
         },
         error: function(error) {
             var data = error.responseJSON;