DenysMedvid
/
moodle-plagiarism_pchkorg
mirror of https://github.com/PlagiarismCheck/moodle-plagiarism_pchkorg.git
1
0
Fork 0
Code Releases Activity

Add new options for min percent of plagiarism

This commit is contained in:
Jane Adelmann 2022-04-26 19:13:24 +03:00
parent 10b4ac6dd3
commit 9151e57228
No known key found for this signature in database
GPG Key ID: 4CCF39DF30B8AF72
5 changed files with 114 additions and 58 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
classes/permissions/capability.class.php
View File

@ -32,7 +32,6 @@ if (!defined('MOODLE_INTERNAL')) {
class capability class capability
{ {
/** /**
* ENABLE * ENABLE
*/ */
@ -41,4 +40,8 @@ class capability
* VIEW_SIMILARITY * VIEW_SIMILARITY
*/ */
const VIEW_SIMILARITY = 'plagiarism/pchkorg:viewsimilarity'; const VIEW_SIMILARITY = 'plagiarism/pchkorg:viewsimilarity';
/**
* CHANGE_MIN_PERCENT_FILTER
*/
const CHANGE_MIN_PERCENT_FILTER = 'plagiarism/pchkorg:changeminpercentfilter';
} }

11
db/access.php
View File

@ -45,4 +45,15 @@ $capabilities = array(
'coursecreator' => CAP_ALLOW 'coursecreator' => CAP_ALLOW
), ),
), ),
'plagiarism/pchkorg:changeminpercentfilter' => array(
'captype' => 'write',
'contextlevel' => CONTEXT_MODULE,
'archetypes' => array(
'editingteacher' => CAP_ALLOW,
'teacher' => CAP_ALLOW,
'manager' => CAP_ALLOW,
'student' => CAP_ALLOW,
'coursecreator' => CAP_ALLOW
),
),
); );

16
form/plagiarism_pchkorg_setup_form.php
View File

@ -23,6 +23,12 @@
defined('MOODLE_INTERNAL') || die(); defined('MOODLE_INTERNAL') || die();
//function pchkorg_check_pchkorg_min_percent($value)
//{
// return 0 <= $value && $value < 100;
//}
/** /**
* Class defined plugin settings form. * Class defined plugin settings form.
*/ */
@ -55,6 +61,16 @@ class plagiarism_pchkorg_setup_form extends moodleform {
$mform->addRule('pchkorg_token', null, 'required', null, 'client'); $mform->addRule('pchkorg_token', null, 'required', null, 'client');
$mform->setType('pchkorg_token', PARAM_TEXT); $mform->setType('pchkorg_token', PARAM_TEXT);
$mform->registerRule('check_pchkorg_min_percent', 'callback', 'pchkorg_check_pchkorg_min_percent');
$mform->addElement('text', 'pchkorg_min_percent', get_string('pchkorg_min_percent', 'plagiarism_pchkorg'));
$mform->addHelpButton('pchkorg_min_percent', 'pchkorg_min_percent', 'plagiarism_pchkorg');
$mform->addRule('pchkorg_min_percent', null, 'numeric', null, 'client');
$mform->addRule('pchkorg_min_percent', get_string('pchkorg_min_percent_range', 'plagiarism_pchkorg'), 'check_pchkorg_min_percent');
$mform->setType('pchkorg_min_percent', PARAM_INT);
$this->add_action_buttons(true); $this->add_action_buttons(true);
} }
} }

4
lang/en/plagiarism_pchkorg.php
View File

@ -36,6 +36,9 @@ $string['pchkorg_submit'] = 'Submit';
$string['pchkorg_check_for_plagiarism_report'] = 'View report'; $string['pchkorg_check_for_plagiarism_report'] = 'View report';
$string['savedconfigsuccess'] = 'Settings had been changed'; $string['savedconfigsuccess'] = 'Settings had been changed';
$string['pchkorg_check_for_plagiarism'] = 'Check for plagiarism'; $string['pchkorg_check_for_plagiarism'] = 'Check for plagiarism';
$string['pchkorg_min_percent'] = 'Exclude sources below X% similarity';
$string['pchkorg_min_percent_help'] = 'Exclude sources below X% similarity';
$string['pchkorg_min_percent_range'] = 'Must be between 0 and 99';
$string['pchkorg_disclosure'] = 'Submission will be sent to <a target="_blank" href="https://plagiarismcheck.org/">PlagiarismCheck.org</a> for check. $string['pchkorg_disclosure'] = 'Submission will be sent to <a target="_blank" href="https://plagiarismcheck.org/">PlagiarismCheck.org</a> for check.
<br /> <br />
By submitting assignment I agree with <a target="_blank" href="https://plagiarismcheck.org/terms-of-service/">Terms &amp; Conditions</a> By submitting assignment I agree with <a target="_blank" href="https://plagiarismcheck.org/terms-of-service/">Terms &amp; Conditions</a>
@ -70,3 +73,4 @@ $string['pchkorg_label_sent'] = 'ID: %s Sent';
$string['pchkorg_label_queued'] = 'In queue'; $string['pchkorg_label_queued'] = 'In queue';
$string['pchkorg:enable'] = 'Allow to enable/disable PlagiarismCheck.org inside an activity'; $string['pchkorg:enable'] = 'Allow to enable/disable PlagiarismCheck.org inside an activity';
$string['pchkorg:viewsimilarity'] = 'Allow to view similarity value from PlagiarismCheck.org'; $string['pchkorg:viewsimilarity'] = 'Allow to view similarity value from PlagiarismCheck.org';
$string['pchkorg:changeminpercentfilter'] = 'Allow changing "Exclude sources below X% similarity"';

136
lib.php
View File

@ -34,6 +34,11 @@ require_once(__DIR__ . '/classes/permissions/capability.class.php');
use plagiarism_pchkorg\classes\permissions\capability; use plagiarism_pchkorg\classes\permissions\capability;
function pchkorg_check_pchkorg_min_percent($value)
{
return 0 <= $value && $value < 100;
}
/** /**
* Class plagiarism_plugin_pchkorg * Class plagiarism_plugin_pchkorg
*/ */
@ -115,7 +120,7 @@ class plagiarism_plugin_pchkorg extends plagiarism_plugin {
} }
$filerecords = $DB->get_records('plagiarism_pchkorg_files', (array) $where, $filerecords = $DB->get_records('plagiarism_pchkorg_files', (array) $where,
'id', '*', 0, 1); 'id', '*', 0, 1);
if ($filerecords) { if ($filerecords) {
$filerecord = end($filerecords); $filerecord = end($filerecords);
@ -130,8 +135,8 @@ class plagiarism_plugin_pchkorg extends plagiarism_plugin {
$formid = 'plagiarism_pchkorg_report_id_' . $filerecord->id; $formid = 'plagiarism_pchkorg_report_id_' . $filerecord->id;
$score = $filerecord->score; $score = $filerecord->score;
$title = sprintf(get_string('pchkorg_label_title', 'plagiarism_pchkorg'), $title = sprintf(get_string('pchkorg_label_title', 'plagiarism_pchkorg'),
$filerecord->textid, $filerecord->textid,
$score); $score);
$label = sprintf(get_string('pchkorg_label_result', 'plagiarism_pchkorg'), $filerecord->textid, $score); $label = sprintf(get_string('pchkorg_label_result', 'plagiarism_pchkorg'), $filerecord->textid, $score);
if ($score < 30) { if ($score < 30) {
@ -213,21 +218,29 @@ display: inline-block;"
if (!isset($data->pchkorg_module_use)) { if (!isset($data->pchkorg_module_use)) {
return; return;
} }
$fields = array('pchkorg_module_use', 'pchkorg_min_percent');
$records = $DB->get_records('plagiarism_pchkorg_config', array( $records = $DB->get_records('plagiarism_pchkorg_config', array(
'cm' => $data->coursemodule 'cm' => $data->coursemodule
)); ));
if (empty($records)) { foreach ($fields as $field) {
$insert = new \stdClass(); $isfounded = false;
$insert->cm = $data->coursemodule;
$insert->name = 'pchkorg_module_use';
$insert->value = $data->pchkorg_module_use;
$DB->insert_record('plagiarism_pchkorg_config', $insert);
} else {
foreach ($records as $record) { foreach ($records as $record) {
$record->value = $data->{$record->name}; if ($record->name === $field) {
$DB->update_record('plagiarism_pchkorg_config', $record); $isfounded = true;
$record->value = $data->{$record->name};
$DB->update_record('plagiarism_pchkorg_config', $record);
break;
}
}
if (!$isfounded) {
$insert = new \stdClass();
$insert->cm = $data->coursemodule;
$insert->name = $field;
$insert->value = $data->{$field};
$DB->insert_record('plagiarism_pchkorg_config', $insert);
} }
} }
} }
@ -258,7 +271,7 @@ display: inline-block;"
$cm = optional_param('update', $defaultcmid, PARAM_INT); $cm = optional_param('update', $defaultcmid, PARAM_INT);
if (null !== $cm) { if (null !== $cm) {
$records = $DB->get_records('plagiarism_pchkorg_config', array( $records = $DB->get_records('plagiarism_pchkorg_config', array(
'cm' => $cm, 'cm' => $cm,
)); ));
if (!empty($records)) { if (!empty($records)) {
$record = end($records); $record = end($records);
@ -268,16 +281,25 @@ display: inline-block;"
$mform->addElement('header', 'plagiarism_pchkorg', get_string('pluginname', 'plagiarism_pchkorg')); $mform->addElement('header', 'plagiarism_pchkorg', get_string('pluginname', 'plagiarism_pchkorg'));
$mform->addElement( $mform->addElement(
'select', 'select',
$setting = 'pchkorg_module_use', $setting = 'pchkorg_module_use',
get_string('pchkorg_module_use', 'plagiarism_pchkorg'), get_string('pchkorg_module_use', 'plagiarism_pchkorg'),
array(get_string('no'), get_string('yes')) array(get_string('no'), get_string('yes'))
); );
$mform->addHelpButton('pchkorg_module_use', 'pchkorg_module_use', 'plagiarism_pchkorg'); $mform->addHelpButton('pchkorg_module_use', 'pchkorg_module_use', 'plagiarism_pchkorg');
if (!isset($mform->exportValues()[$setting]) || is_null($mform->exportValues()[$setting])) { if (!isset($mform->exportValues()[$setting]) || is_null($mform->exportValues()[$setting])) {
$mform->setDefault($setting, '1'); $mform->setDefault($setting, '1');
} }
$mform->registerRule('check_pchkorg_min_percent', 'callback', 'pchkorg_check_pchkorg_min_percent');
$mform->addElement('text', 'pchkorg_min_percent', get_string('pchkorg_min_percent', 'plagiarism_pchkorg'));
$mform->addHelpButton('pchkorg_min_percent', 'pchkorg_min_percent', 'plagiarism_pchkorg');
$mform->addRule('pchkorg_min_percent', null, 'numeric', null, 'client');
$mform->addRule('pchkorg_min_percent', get_string('pchkorg_min_percent_range', 'plagiarism_pchkorg'), 'check_pchkorg_min_percent');
$mform->setType('pchkorg_min_percent', PARAM_INT);
} }
} }
@ -385,7 +407,7 @@ display: inline-block;"
// Related user ID will be NULL if an instructor submits on behalf of a student who is in a group. // Related user ID will be NULL if an instructor submits on behalf of a student who is in a group.
// To get around this, we get the group ID, get the group members and set the author as the first student in the group. // To get around this, we get the group ID, get the group members and set the author as the first student in the group.
if ((empty($eventdata['relateduserid'])) && ($eventdata['other']['modulename'] == 'assign') if ((empty($eventdata['relateduserid'])) && ($eventdata['other']['modulename'] == 'assign')
&& has_capability('mod/assign:editothersubmission', context_module::instance($cm->id), $submitter)) { && has_capability('mod/assign:editothersubmission', context_module::instance($cm->id), $submitter)) {
$moodlesubmission = $DB->get_record('assign_submission', array('id' => $eventdata['objectid']), 'id, groupid'); $moodlesubmission = $DB->get_record('assign_submission', array('id' => $eventdata['objectid']), 'id, groupid');
if (!empty($moodlesubmission->groupid)) { if (!empty($moodlesubmission->groupid)) {
$author = $this->get_first_group_author($cm->course, $moodlesubmission->groupid); $author = $this->get_first_group_author($cm->course, $moodlesubmission->groupid);
@ -398,14 +420,14 @@ display: inline-block;"
// Get content. // Get content.
$moodlesubmission = $DB->get_record('assign_submission', array('id' => $eventdata['objectid']), 'id'); $moodlesubmission = $DB->get_record('assign_submission', array('id' => $eventdata['objectid']), 'id');
if ($moodletextsubmission = $DB->get_record('assignsubmission_onlinetext', if ($moodletextsubmission = $DB->get_record('assignsubmission_onlinetext',
array('submission' => $moodlesubmission->id), 'onlinetext')) { array('submission' => $moodlesubmission->id), 'onlinetext')) {
$eventdata['other']['content'] = $moodletextsubmission->onlinetext; $eventdata['other']['content'] = $moodletextsubmission->onlinetext;
} }
$filesconditions = array( $filesconditions = array(
'component' => 'assignsubmission_file', 'component' => 'assignsubmission_file',
'itemid' => $moodlesubmission->id, 'itemid' => $moodlesubmission->id,
'userid' => $author 'userid' => $author
); );
$moodlefiles = $DB->get_records('files', $filesconditions); $moodlefiles = $DB->get_records('files', $filesconditions);
@ -455,15 +477,15 @@ display: inline-block;"
// Queue text content to send to plagiarismcheck.org. // Queue text content to send to plagiarismcheck.org.
// If there was an error when creating the assignment then still queue the submission so it can be saved as failed. // If there was an error when creating the assignment then still queue the submission so it can be saved as failed.
if (in_array($eventdata['eventtype'], array("content_uploaded", "assessable_submitted")) if (in_array($eventdata['eventtype'], array("content_uploaded", "assessable_submitted"))
&& !empty($eventdata['other']['content'])) { && !empty($eventdata['other']['content'])) {
$signature = sha1($eventdata['other']['content']); $signature = sha1($eventdata['other']['content']);
$filesconditions = array( $filesconditions = array(
'signature' => $signature, 'signature' => $signature,
'cm' => $cmid, 'cm' => $cmid,
'userid' => $USER->id, 'userid' => $USER->id,
'itemid' => $eventdata['objectid'] 'itemid' => $eventdata['objectid']
); );
$oldfile = $DB->get_record('plagiarism_pchkorg_files', $filesconditions); $oldfile = $DB->get_record('plagiarism_pchkorg_files', $filesconditions);
@ -536,7 +558,7 @@ display: inline-block;"
$filesconditions = array('state' => 10); $filesconditions = array('state' => 10);
$moodlefiles = $DB->get_records('plagiarism_pchkorg_files', $filesconditions, $moodlefiles = $DB->get_records('plagiarism_pchkorg_files', $filesconditions,
'id', '*', 0, 20); 'id', '*', 0, 20);
if ($moodlefiles) { if ($moodlefiles) {
$fs = get_file_storage(); $fs = get_file_storage();
@ -547,32 +569,32 @@ display: inline-block;"
$cm = get_coursemodule_from_id('', $filedb->cm); $cm = get_coursemodule_from_id('', $filedb->cm);
if ($filedb->fileid === null) { if ($filedb->fileid === null) {
$moodletextsubmission = $DB->get_record('assignsubmission_onlinetext', $moodletextsubmission = $DB->get_record('assignsubmission_onlinetext',
array('submission' => $filedb->itemid), '*'); array('submission' => $filedb->itemid), '*');
if ($moodletextsubmission) { if ($moodletextsubmission) {
$content = $moodletextsubmission->onlinetext; $content = $moodletextsubmission->onlinetext;
if ($apiprovider->is_group_token()) { if ($apiprovider->is_group_token()) {
$textid = $apiprovider->send_group_text( $textid = $apiprovider->send_group_text(
$apiprovider->user_email_to_hash($user->email), $apiprovider->user_email_to_hash($user->email),
$cm->course, $cm->course,
$cm->id, $cm->id,
$moodletextsubmission->id, $moodletextsubmission->id,
$moodletextsubmission->id, $moodletextsubmission->id,
html_to_text($content, 75, false), html_to_text($content, 75, false),
'plain/text', 'plain/text',
sprintf('%s-submussion.txt', $moodletextsubmission->id) sprintf('%s-submussion.txt', $moodletextsubmission->id)
); );
} else { } else {
$textid = $apiprovider->send_text( $textid = $apiprovider->send_text(
html_to_text($content, 75, false), html_to_text($content, 75, false),
'plain/text', 'plain/text',
sprintf('%s-submussion.txt', $moodletextsubmission->id) sprintf('%s-submussion.txt', $moodletextsubmission->id)
); );
} }
} }
} else { } else {
$moodlesubmission = $DB->get_record('assign_submission', array('assignment' => $cm->instance, $moodlesubmission = $DB->get_record('assign_submission', array('assignment' => $cm->instance,
'userid' => $filedb->userid, 'id' => $filedb->itemid), 'id'); 'userid' => $filedb->userid, 'id' => $filedb->itemid), 'id');
$file = $fs->get_file_by_id($filedb->fileid); $file = $fs->get_file_by_id($filedb->fileid);
// We can not receive file by id. // We can not receive file by id.
@ -591,20 +613,20 @@ display: inline-block;"
if ($apiprovider->is_group_token()) { if ($apiprovider->is_group_token()) {
$textid = $apiprovider->send_group_text( $textid = $apiprovider->send_group_text(
$apiprovider->user_email_to_hash($user->email), $apiprovider->user_email_to_hash($user->email),
$cm->course, $cm->course,
$cm->id, $cm->id,
$moodlesubmission->id, $moodlesubmission->id,
$file->get_id(), $file->get_id(),
$file->get_content(), $file->get_content(),
$file->get_mimetype(), $file->get_mimetype(),
$file->get_filename() $file->get_filename()
); );
} else { } else {
$agreementwhere = array( $agreementwhere = array(
'cm' => 0, 'cm' => 0,
'name' => 'accepted_agreement', 'name' => 'accepted_agreement',
'value' => '1' 'value' => '1'
); );
$agreementaccepted = $DB->get_records('plagiarism_pchkorg_config', $agreementwhere); $agreementaccepted = $DB->get_records('plagiarism_pchkorg_config', $agreementwhere);
if (empty($agreementaccepted)) { if (empty($agreementaccepted)) {
@ -613,9 +635,9 @@ display: inline-block;"
} }
$textid = $apiprovider->send_text( $textid = $apiprovider->send_text(
$file->get_content(), $file->get_content(),
$file->get_mimetype(), $file->get_mimetype(),
$file->get_filename() $file->get_filename()
); );
} }
} }
@ -661,7 +683,7 @@ display: inline-block;"
$filesconditions = array('state' => 12); $filesconditions = array('state' => 12);
$moodlefiles = $DB->get_records('plagiarism_pchkorg_files', $filesconditions, $moodlefiles = $DB->get_records('plagiarism_pchkorg_files', $filesconditions,
'id', '*', 0, 20); 'id', '*', 0, 20);
foreach ($moodlefiles as $filedb) { foreach ($moodlefiles as $filedb) {
$report = $apiprovider->check_text($filedb->textid); $report = $apiprovider->check_text($filedb->textid);