moodle/mod/workshop/tests/generator/lib.php
David Mudrák 84a57322c2 MDL-61905 workshop: Implement the privacy API in the workshop core
Workshop module stores personal data in its tables, via user
preference and via core_files and core_plagiarism subsystems.

When exporting the data, we export not only data created by users
themselves (such as their submissions and provided peer-assessments) but
also all relevant data that can (or must) be used to interpret created
content and evaluate the user's performance and skills.

On the other hand, when deleting data at user's request, we delete only
those data that do not affect other users' performance evaluation. The
reasoning is that one's right for privacy does not overweight someone
else's right for fair assessment. For that reason, we can't fully delete
whole provided peer-assessments, for example. Because they are used in
cross-comparison and grading evaluation of all other peers who assessed
the same submission. So instead, we replace provided texts but still
keep the original record.

Workshop defines the interface for its grading strategy subplugins to
allow them attach personal data under their control to the exported
structures.
2018-05-09 10:01:50 +02:00

163 lines
5.7 KiB
PHP

<?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/>.
/**
* mod_workshop data generator.
*
* @package mod_workshop
* @category test
* @copyright 2013 Marina Glancy
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
/**
* mod_workshop data generator class.
*
* @package mod_workshop
* @category test
* @copyright 2013 Marina Glancy
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class mod_workshop_generator extends testing_module_generator {
public function create_instance($record = null, array $options = null) {
global $CFG;
require_once($CFG->libdir.'/filelib.php');
$workshopconfig = get_config('workshop');
// Add default values for workshop.
$record = (array)$record + array(
'strategy' => $workshopconfig->strategy,
'grade' => $workshopconfig->grade,
'gradinggrade' => $workshopconfig->gradinggrade,
'gradedecimals' => $workshopconfig->gradedecimals,
'nattachments' => 1,
'submissionfiletypes' => null,
'maxbytes' => $workshopconfig->maxbytes,
'latesubmissions' => 0,
'useselfassessment' => 0,
'overallfeedbackmode' => 1,
'overallfeedbackfiles' => 0,
'overallfeedbackfiletypes' => null,
'overallfeedbackmaxbytes' => $workshopconfig->maxbytes,
'useexamples' => 0,
'examplesmode' => $workshopconfig->examplesmode,
'submissionstart' => 0,
'submissionend' => 0,
'phaseswitchassessment' => 0,
'assessmentstart' => 0,
'assessmentend' => 0,
);
if (!isset($record['gradecategory']) || !isset($record['gradinggradecategory'])) {
require_once($CFG->libdir.'/gradelib.php');
$courseid = is_object($record['course']) ? $record['course']->id : $record['course'];
$gradecategories = grade_get_categories_menu($courseid);
reset($gradecategories);
$defaultcategory = key($gradecategories);
$record += array(
'gradecategory' => $defaultcategory,
'gradinggradecategory' => $defaultcategory
);
}
if (!isset($record['instructauthorseditor'])) {
$record['instructauthorseditor'] = array(
'text' => 'Instructions for submission '.($this->instancecount+1),
'format' => FORMAT_MOODLE,
'itemid' => file_get_unused_draft_itemid()
);
}
if (!isset($record['instructreviewerseditor'])) {
$record['instructreviewerseditor'] = array(
'text' => 'Instructions for assessment '.($this->instancecount+1),
'format' => FORMAT_MOODLE,
'itemid' => file_get_unused_draft_itemid()
);
}
if (!isset($record['conclusioneditor'])) {
$record['conclusioneditor'] = array(
'text' => 'Conclusion '.($this->instancecount+1),
'format' => FORMAT_MOODLE,
'itemid' => file_get_unused_draft_itemid()
);
}
return parent::create_instance($record, (array)$options);
}
/**
* Generates a submission authored by the given user.
*
* @param int $workshopid Workshop instance id.
* @param int $authorid Author user id.
* @param stdClass|array $options Optional explicit properties.
* @return int The new submission id.
*/
public function create_submission($workshopid, $authorid, $options = null) {
global $DB;
$timenow = time();
$options = (array)$options;
$record = $options + array(
'workshopid' => $workshopid,
'example' => 0,
'authorid' => $authorid,
'timecreated' => $timenow,
'timemodified' => $timenow,
'title' => 'Generated submission',
'content' => 'Generated content',
'contentformat' => FORMAT_MARKDOWN,
'contenttrust' => 0,
);
$id = $DB->insert_record('workshop_submissions', $record);
return $id;
}
/**
* Generates an allocation of the given submission for peer-assessment by the given user
*
* @param int $submissionid Submission id.
* @param int $reviewerid Reviewer's user id.
* @param stdClass|array $options Optional explicit properties.
* @return int The new assessment id.
*/
public function create_assessment($submissionid, $reviewerid, $options = null) {
global $DB;
$timenow = time();
$options = (array)$options;
$record = $options + array(
'submissionid' => $submissionid,
'reviewerid' => $reviewerid,
'weight' => 1,
'timecreated' => $timenow,
'timemodified' => $timenow,
'grade' => null,
'feedbackauthor' => '',
'feedbackreviewer' => '',
);
$id = $DB->insert_record('workshop_assessments', $record);
return $id;
}
}