Added option to disable cheat guard

backup/moodle2/backup_xp_stepslib.php

@@ -45,7 +45,7 @@ protected function define_structure() {
         $xpconfig = new backup_nested_element('config', array('courseid'), array(
             'enabled', 'enablelog', 'keeplogs', 'levels', 'lastlogpurge', 'enableladder', 'enableinfos', 'levelsdata',
             'enablelevelupnotif', 'enablecustomlevelbadges', 'maxactionspertime', 'timeformaxactions', 'timebetweensameactions',
-            'identitymode', 'rankmode', 'neighbours'
+            'identitymode', 'rankmode', 'neighbours', 'enablecheatguard'
         ));
         $xpfilters = new backup_nested_element('filters');
         $xpfilter = new backup_nested_element('filter', array('courseid'), array('ruledata', 'points', 'sortorder'));

classes/manager.php

@@ -78,6 +78,7 @@ class block_xp_manager {
         'levels' => 10,
         'enablelog' => 1,
         'keeplogs' => 3,
+        'enablecheatguard' => true,   // Enable cheat guard.
         'enableladder' => true,       // Enable the ladder.
         'enableinfos' => true,        // Enable the infos page.
         'levelsdata' => '',           // JSON encoded value of the levels data.
@@ -251,9 +252,11 @@ public function capture_event(\core\event\base $event) {
             return;
         }
 
-        // Check if the user can capture this event, anti cheater method.
-        if (!$this->can_capture_event($event)) {
-            return;
+        if ($this->get_config('enablecheatguard')) {
+            // Check if the user can capture this event, anti cheater method.
+            if (!$this->can_capture_event($event)) {
+                return;
+            }
         }
 
         $userid = $event->userid;

classes/settings_form.php

@@ -96,20 +96,26 @@ public function definition() {
 
         $mform->addElement('header', 'hdrcheating', get_string('cheatguard', 'block_xp'));
 
+        $mform->setDefault('enablecheatguard', $defaultconfig->enablecheatguard);
+        $mform->addElement('selectyesno', 'enablecheatguard', get_string('enablecheatguard', 'block_xp'));
+
         $mform->addElement('text', 'maxactionspertime', get_string('maxactionspertime', 'block_xp'));
         $mform->setDefault('maxactionspertime', $defaultconfig->maxactionspertime);
         $mform->addHelpButton('maxactionspertime', 'maxactionspertime', 'block_xp');
         $mform->setType('maxactionspertime', PARAM_INT);
+        $mform->disabledIf('maxactionspertime','enablecheatguard', 'eq', 0);
 
         $mform->addElement('text', 'timeformaxactions', get_string('timeformaxactions', 'block_xp'));
         $mform->setDefault('timeformaxactions', $defaultconfig->timeformaxactions);
         $mform->addHelpButton('timeformaxactions', 'timeformaxactions', 'block_xp');
         $mform->setType('timeformaxactions', PARAM_INT);
+        $mform->disabledIf('timeformaxactions','enablecheatguard', 'eq', 0);
 
         $mform->addElement('text', 'timebetweensameactions', get_string('timebetweensameactions', 'block_xp'));
         $mform->setDefault('timebetweensameactions', $defaultconfig->timebetweensameactions);
         $mform->addHelpButton('timebetweensameactions', 'timebetweensameactions', 'block_xp');
         $mform->setType('timebetweensameactions', PARAM_INT);
+        $mform->disabledIf('timebetweensameactions','enablecheatguard', 'eq', 0);
 
         $mform->addElement('header', 'hdrloggin', get_string('logging', 'block_xp'));
 

db/install.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<XMLDB PATH="blocks/xp/db" VERSION="20160224" COMMENT="XMLDB file for Moodle blocks/xp"
+<XMLDB PATH="blocks/xp/db" VERSION="20170214" COMMENT="XMLDB file for Moodle blocks/xp"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:noNamespaceSchemaLocation="../../../lib/xmldb/xmldb.xsd"
 >
@@ -45,6 +45,7 @@
         <FIELD NAME="keeplogs" TYPE="int" LENGTH="10" NOTNULL="true" SEQUENCE="false"/>
         <FIELD NAME="levels" TYPE="int" LENGTH="10" NOTNULL="true" SEQUENCE="false"/>
         <FIELD NAME="lastlogpurge" TYPE="int" LENGTH="10" NOTNULL="true" DEFAULT="0" SEQUENCE="false"/>
+        <FIELD NAME="enablecheatguard" TYPE="int" LENGTH="1" NOTNULL="true" DEFAULT="1" SEQUENCE="false"/>
         <FIELD NAME="enableladder" TYPE="int" LENGTH="1" NOTNULL="true" DEFAULT="1" SEQUENCE="false" COMMENT="Enable the ladder"/>
         <FIELD NAME="enableinfos" TYPE="int" LENGTH="1" NOTNULL="true" DEFAULT="1" SEQUENCE="false" COMMENT="Enable the infos page"/>
         <FIELD NAME="levelsdata" TYPE="text" NOTNULL="false" SEQUENCE="false" COMMENT="The data related to the levels"/>

db/upgrade.php

@@ -311,6 +311,21 @@ function xmldb_block_xp_upgrade($oldversion) {
         upgrade_block_savepoint(true, 2016022403, 'xp');
     }
 
+    if ($oldversion < 2017021401) {
+
+        // Define field enablecheatguard to be added to block_xp_config.
+        $table = new xmldb_table('block_xp_config');
+        $field = new xmldb_field('enablecheatguard', XMLDB_TYPE_INTEGER, '1', null, XMLDB_NOTNULL, null, '1', 'lastlogpurge');
+
+        // Conditionally launch add field enablecheatguard.
+        if (!$dbman->field_exists($table, $field)) {
+            $dbman->add_field($table, $field);
+        }
+
+        // Xp savepoint reached.
+        upgrade_block_savepoint(true, 2017021401, 'xp');
+    }
+
     return true;
 
 }

lang/en/block_xp.php

@@ -62,6 +62,7 @@
 $string['displayparticipantsidentity'] = 'Display participants identity';
 $string['displayrank'] = 'Display rank';
 $string['displayrelativerank'] = 'Display a relative rank';
+$string['enablecheatguard'] = 'Enable cheat guard';
 $string['enableinfos'] = 'Enable infos page';
 $string['enableinfos_help'] = 'When set to \'No\', students will not be able to view the infos page.';
 $string['enableladder'] = 'Enable the ladder';

version.php

@@ -24,7 +24,7 @@
 
 defined('MOODLE_INTERNAL') || die();
 
-$plugin->version    = 2016032700;
+$plugin->version    = 2017021401;
 $plugin->requires   = 2014041500;
 $plugin->component  = 'block_xp';
 $plugin->maturity   = MATURITY_STABLE;