MDL-59250 mod_workshop: Move assessment edition code to API function
[moodle.git] / mod / workshop / assessment.php
CommitLineData
0968b1a3 1<?php
53fad4b9
DM
2
3// This file is part of Moodle - http://moodle.org/
4//
0968b1a3
DM
5// Moodle is free software: you can redistribute it and/or modify
6// it under the terms of the GNU General Public License as published by
7// the Free Software Foundation, either version 3 of the License, or
8// (at your option) any later version.
9//
10// Moodle is distributed in the hope that it will be useful,
11// but WITHOUT ANY WARRANTY; without even the implied warranty of
12// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13// GNU General Public License for more details.
53fad4b9 14//
0968b1a3
DM
15// You should have received a copy of the GNU General Public License
16// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
53fad4b9 17
0968b1a3 18/**
407b1e91 19 * Assess a submission or view the single assessment
0968b1a3 20 *
407b1e91
DM
21 * Assessment id parameter must be passed. The script displays the submission and
22 * the assessment form. If the current user is the reviewer and the assessing is
23 * allowed, new assessment can be saved.
24 * If the assessing is not allowed (for example, the assessment period is over
25 * or the current user is eg a teacher), the assessment form is opened
26 * in a non-editable mode.
27 * The capability 'mod/workshop:peerassess' is intentionally not checked here.
28 * The user is considered as a reviewer if the corresponding assessment record
29 * has been prepared for him/her (during the allocation). So even a user without the
30 * peerassess capability (like a 'teacher', for example) can become a reviewer.
0968b1a3 31 *
5cdcfcb9 32 * @package mod_workshop
65601f04
DM
33 * @copyright 2009 David Mudrak <david.mudrak@gmail.com>
34 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
0968b1a3
DM
35 */
36
1fcf0ca8
RS
37require(__DIR__.'/../../config.php');
38require_once(__DIR__.'/locallib.php');
0968b1a3 39
407b1e91
DM
40$asid = required_param('asid', PARAM_INT); // assessment id
41$assessment = $DB->get_record('workshop_assessments', array('id' => $asid), '*', MUST_EXIST);
becec954 42$submission = $DB->get_record('workshop_submissions', array('id' => $assessment->submissionid, 'example' => 0), '*', MUST_EXIST);
407b1e91 43$workshop = $DB->get_record('workshop', array('id' => $submission->workshopid), '*', MUST_EXIST);
74df2951 44$course = $DB->get_record('course', array('id' => $workshop->course), '*', MUST_EXIST);
407b1e91 45$cm = get_coursemodule_from_instance('workshop', $workshop->id, $course->id, false, MUST_EXIST);
0968b1a3
DM
46
47require_login($course, false, $cm);
a39d7d87
DM
48if (isguestuser()) {
49 print_error('guestsarenotallowed');
50}
51$workshop = new workshop($workshop, $cm, $course);
6e309973 52
407b1e91
DM
53$PAGE->set_url($workshop->assess_url($assessment->id));
54$PAGE->set_title($workshop->name);
55$PAGE->set_heading($course->fullname);
56$PAGE->navbar->add(get_string('assessingsubmission', 'workshop'));
407b1e91 57
c6b784f0
DM
58$cansetassessmentweight = has_capability('mod/workshop:allocate', $workshop->context);
59$canoverridegrades = has_capability('mod/workshop:overridegrades', $workshop->context);
407b1e91 60$isreviewer = ($USER->id == $assessment->reviewerid);
407b1e91 61
b1e896cf 62$workshop->check_view_assessment($assessment, $submission);
407b1e91
DM
63
64// only the reviewer is allowed to modify the assessment
9ddff589 65if ($isreviewer and $workshop->assessing_allowed($USER->id)) {
77f43e7d 66 $assessmenteditable = true;
407b1e91 67} else {
77f43e7d 68 $assessmenteditable = false;
0968b1a3 69}
0968b1a3 70
cff28ef0 71// check that all required examples have been assessed by the user
86928d2a
JL
72if ($assessmenteditable) {
73
74 list($assessed, $notice) = $workshop->check_examples_assessed_before_assessment($assessment->reviewerid);
75 if (!$assessed) {
81b22887 76 echo $output->header();
764d7ba9 77 echo $output->heading(format_string($workshop->name));
86928d2a 78 notice(get_string($notice, 'workshop'), new moodle_url('/mod/workshop/view.php', array('id' => $cm->id)));
81b22887 79 echo $output->footer();
cff28ef0 80 exit;
cff28ef0
DM
81 }
82}
83
05e69e56
DM
84// load the grading strategy logic
85$strategy = $workshop->grading_strategy_instance();
86
c6b784f0
DM
87if (is_null($assessment->grade) and !$assessmenteditable) {
88 $mform = null;
89} else {
1df3bc14
DM
90 // Are there any other pending assessments to do but this one?
91 if ($assessmenteditable) {
92 $pending = $workshop->get_pending_assessments_by_reviewer($assessment->reviewerid, $assessment->id);
93 } else {
94 $pending = array();
95 }
c6b784f0 96 // load the assessment form and process the submitted data eventually
77d746a2
DM
97 $mform = $strategy->get_assessment_form($PAGE->url, 'assessment', $assessment, $assessmenteditable,
98 array('editableweight' => $cansetassessmentweight, 'pending' => !empty($pending)));
c6a793d5
DM
99
100 // Set data managed by the workshop core, subplugins set their own data themselves.
101 $currentdata = (object)array(
102 'weight' => $assessment->weight,
103 'feedbackauthor' => $assessment->feedbackauthor,
104 'feedbackauthorformat' => $assessment->feedbackauthorformat,
105 );
77d746a2
DM
106 if ($assessmenteditable and $workshop->overallfeedbackmode) {
107 $currentdata = file_prepare_standard_editor($currentdata, 'feedbackauthor', $workshop->overall_feedback_content_options(),
108 $workshop->context, 'mod_workshop', 'overallfeedback_content', $assessment->id);
109 if ($workshop->overallfeedbackfiles) {
110 $currentdata = file_prepare_standard_filemanager($currentdata, 'feedbackauthorattachment',
111 $workshop->overall_feedback_attachment_options(), $workshop->context, 'mod_workshop', 'overallfeedback_attachment',
112 $assessment->id);
c6a793d5 113 }
c6a793d5
DM
114 }
115 $mform->set_data($currentdata);
116
c6b784f0 117 if ($mform->is_cancelled()) {
407b1e91 118 redirect($workshop->view_url());
c6b784f0 119 } elseif ($assessmenteditable and ($data = $mform->get_data())) {
c6a793d5 120
57f44fba
JL
121 // Add or update assessment.
122 $rawgrade = $workshop->edit_assessment($assessment, $submission, $data, $strategy);
c6a793d5
DM
123
124 // And finally redirect the user's browser.
c6b784f0
DM
125 if (!is_null($rawgrade) and isset($data->saveandclose)) {
126 redirect($workshop->view_url());
1df3bc14
DM
127 } else if (!is_null($rawgrade) and isset($data->saveandshownext)) {
128 $next = reset($pending);
129 if (!empty($next)) {
130 redirect($workshop->assess_url($next->id));
131 } else {
132 redirect($PAGE->url); // This should never happen but just in case...
133 }
c6b784f0
DM
134 } else {
135 // either it is not possible to calculate the $rawgrade
136 // or the reviewer has chosen "Save and continue"
137 redirect($PAGE->url);
138 }
05e69e56
DM
139 }
140}
141
c6b784f0
DM
142// load the form to override gradinggrade and/or set weight and process the submitted data eventually
143if ($canoverridegrades or $cansetassessmentweight) {
144 $options = array(
145 'editable' => true,
146 'editableweight' => $cansetassessmentweight,
147 'overridablegradinggrade' => $canoverridegrades);
148 $feedbackform = $workshop->get_feedbackreviewer_form($PAGE->url, $assessment, $options);
77f43e7d 149 if ($data = $feedbackform->get_data()) {
e554671d 150 $data = file_postupdate_standard_editor($data, 'feedbackreviewer', array(), $workshop->context);
7a789aa8 151 $record = new stdclass();
e554671d 152 $record->id = $assessment->id;
c6b784f0
DM
153 if ($cansetassessmentweight) {
154 $record->weight = $data->weight;
155 }
156 if ($canoverridegrades) {
157 $record->gradinggradeover = $workshop->raw_grade_value($data->gradinggradeover, $workshop->gradinggrade);
158 $record->gradinggradeoverby = $USER->id;
159 $record->feedbackreviewer = $data->feedbackreviewer;
160 $record->feedbackreviewerformat = $data->feedbackreviewerformat;
161 }
e554671d
DM
162 $DB->update_record('workshop_assessments', $record);
163 redirect($workshop->view_url());
77f43e7d
DM
164 }
165}
166
407b1e91 167// output starts here
81b22887
DM
168$output = $PAGE->get_renderer('mod_workshop'); // workshop renderer
169echo $output->header();
764d7ba9
RW
170echo $output->heading(format_string($workshop->name));
171echo $output->heading(get_string('assessedsubmission', 'workshop'), 3);
a39d7d87 172
407b1e91 173$submission = $workshop->get_submission_by_id($submission->id); // reload so can be passed to the renderer
81b22887 174echo $output->render($workshop->prepare_submission($submission, has_capability('mod/workshop:viewauthornames', $workshop->context)));
a39d7d87 175
5924db72 176// show instructions for assessing as they may contain important information
e0142f7e
DM
177// for evaluating the assessment
178if (trim($workshop->instructreviewers)) {
179 $instructions = file_rewrite_pluginfile_urls($workshop->instructreviewers, 'pluginfile.php', $PAGE->context->id,
e46aec4c 180 'mod_workshop', 'instructreviewers', null, workshop::instruction_editors_options($PAGE->context));
e0142f7e 181 print_collapsible_region_start('', 'workshop-viewlet-instructreviewers', get_string('instructreviewers', 'workshop'));
367a75fa 182 echo $output->box(format_text($instructions, $workshop->instructreviewersformat, array('overflowdiv'=>true)), array('generalbox', 'instructions'));
e0142f7e
DM
183 print_collapsible_region_end();
184}
185
38504a44
DM
186// extend the current assessment record with user details
187$assessment = $workshop->get_assessment_by_id($assessment->id);
188
77f43e7d 189if ($isreviewer) {
38504a44
DM
190 $options = array(
191 'showreviewer' => true,
192 'showauthor' => has_capability('mod/workshop:viewauthornames', $workshop->context),
193 'showform' => $assessmenteditable or !is_null($assessment->grade),
194 'showweight' => true,
195 );
196 $assessment = $workshop->prepare_assessment($assessment, $mform, $options);
197 $assessment->title = get_string('assessmentbyyourself', 'workshop');
198 echo $output->render($assessment);
77f43e7d 199
c6b784f0 200} else {
38504a44
DM
201 $options = array(
202 'showreviewer' => has_capability('mod/workshop:viewreviewernames', $workshop->context),
203 'showauthor' => has_capability('mod/workshop:viewauthornames', $workshop->context),
204 'showform' => $assessmenteditable or !is_null($assessment->grade),
205 'showweight' => true,
206 );
207 $assessment = $workshop->prepare_assessment($assessment, $mform, $options);
208 echo $output->render($assessment);
c6b784f0 209}
38504a44
DM
210
211if (!$assessmenteditable and $canoverridegrades) {
77f43e7d 212 $feedbackform->display();
77f43e7d 213}
38504a44 214
81b22887 215echo $output->footer();