MDL-59239 mod_workshop: New WS mod_workshop_view_submission
[moodle.git] / mod / workshop / submission.php
CommitLineData
33e4dea6 1<?php
53fad4b9
DM
2// This file is part of Moodle - http://moodle.org/
3//
33e4dea6
DM
4// Moodle is free software: you can redistribute it and/or modify
5// it under the terms of the GNU General Public License as published by
6// the Free Software Foundation, either version 3 of the License, or
7// (at your option) any later version.
8//
9// Moodle is distributed in the hope that it will be useful,
10// but WITHOUT ANY WARRANTY; without even the implied warranty of
11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12// GNU General Public License for more details.
53fad4b9 13//
33e4dea6
DM
14// You should have received a copy of the GNU General Public License
15// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
16
33e4dea6 17/**
51508f25 18 * View a single (usually the own) submission, submit own work.
33e4dea6 19 *
5cdcfcb9 20 * @package mod_workshop
65601f04
DM
21 * @copyright 2009 David Mudrak <david.mudrak@gmail.com>
22 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
33e4dea6
DM
23 */
24
1fcf0ca8
RS
25require(__DIR__.'/../../config.php');
26require_once(__DIR__.'/locallib.php');
33e4dea6 27
3fa22899
DM
28$cmid = required_param('cmid', PARAM_INT); // Course module id.
29$id = optional_param('id', 0, PARAM_INT); // Submission id.
30$edit = optional_param('edit', false, PARAM_BOOL); // Open the page for editing?
31$assess = optional_param('assess', false, PARAM_BOOL); // Instant assessment required.
32$delete = optional_param('delete', false, PARAM_BOOL); // Submission removal requested.
33$confirm = optional_param('confirm', false, PARAM_BOOL); // Submission removal request confirmed.
33e4dea6 34
3fa22899
DM
35$cm = get_coursemodule_from_id('workshop', $cmid, 0, false, MUST_EXIST);
36$course = $DB->get_record('course', array('id' => $cm->course), '*', MUST_EXIST);
33e4dea6
DM
37
38require_login($course, false, $cm);
33e4dea6 39if (isguestuser()) {
b8ead2e6 40 print_error('guestsarenotallowed');
33e4dea6
DM
41}
42
fef8ee91
RT
43$workshoprecord = $DB->get_record('workshop', array('id' => $cm->instance), '*', MUST_EXIST);
44$workshop = new workshop($workshoprecord, $cm, $course);
51508f25 45
2c75324e
DM
46$PAGE->set_url($workshop->submission_url(), array('cmid' => $cmid, 'id' => $id));
47
48if ($edit) {
49 $PAGE->url->param('edit', $edit);
50}
33e4dea6 51
127032fe 52if ($id) { // submission is specified
51508f25 53 $submission = $workshop->get_submission_by_id($id);
b99070b9
JL
54 // Trigger submission viewed event.
55 $workshop->set_submission_viewed($submission);
5450f7b6 56
127032fe 57} else { // no submission specified
0dc47fb9 58 if (!$submission = $workshop->get_submission_by_author($USER->id)) {
7a789aa8 59 $submission = new stdclass();
127032fe 60 $submission->id = null;
00aca3c1 61 $submission->authorid = $USER->id;
2e7bd6c2 62 $submission->example = 0;
c6b784f0
DM
63 $submission->grade = null;
64 $submission->gradeover = null;
60719642 65 $submission->published = null;
c6b784f0 66 $submission->feedbackauthor = null;
884482fb 67 $submission->feedbackauthorformat = editors_get_preferred_format();
53fad4b9 68 }
33e4dea6 69}
c1e883bb 70
00aca3c1 71$ownsubmission = $submission->authorid == $USER->id;
67cd00ba
DM
72$canviewall = has_capability('mod/workshop:viewallsubmissions', $workshop->context);
73$cansubmit = has_capability('mod/workshop:submit', $workshop->context);
ac239eba 74$canallocate = has_capability('mod/workshop:allocate', $workshop->context);
232175e4 75$canpublish = has_capability('mod/workshop:publishsubmissions', $workshop->context);
090a7907 76$canoverride = (($workshop->phase == workshop::PHASE_EVALUATION) and has_capability('mod/workshop:overridegrades', $workshop->context));
deabe48b 77$candeleteall = has_capability('mod/workshop:deletesubmissions', $workshop->context);
5a372494
DM
78$userassessment = $workshop->get_assessment_of_submission_by_user($submission->id, $USER->id);
79$isreviewer = !empty($userassessment);
2f289d36 80$editable = ($cansubmit and $ownsubmission);
deabe48b 81$deletable = $candeleteall;
d67c20b8
DM
82$ispublished = ($workshop->phase == workshop::PHASE_CLOSED
83 and $submission->published == 1
84 and has_capability('mod/workshop:viewpublishedsubmissions', $workshop->context));
2f289d36 85
9ddff589 86if (empty($submission->id) and !$workshop->creating_submission_allowed($USER->id)) {
2f289d36
DM
87 $editable = false;
88}
9ddff589 89if ($submission->id and !$workshop->modifying_submission_allowed($USER->id)) {
2f289d36
DM
90 $editable = false;
91}
92
931bba60 93$canviewall = $canviewall && $workshop->check_group_membership($submission->authorid);
f65bc55f 94
86928d2a 95$editable = ($editable && $workshop->check_examples_assessed_before_submission($USER->id));
514d8c22 96$edit = ($editable and $edit);
51508f25 97
deabe48b
PN
98if (!$candeleteall and $ownsubmission and $editable) {
99 // Only allow the student to delete their own submission if it's still editable and hasn't been assessed.
100 if (count($workshop->get_assessments_of_submission($submission->id)) > 0) {
101 $deletable = false;
102 } else {
103 $deletable = true;
104 }
105}
106
107if ($submission->id and $delete and $confirm and $deletable) {
108 require_sesskey();
109 $workshop->delete_submission($submission);
30c52da9 110
deabe48b
PN
111 redirect($workshop->view_url());
112}
113
d67c20b8
DM
114$seenaspublished = false; // is the submission seen as a published submission?
115
3dc78e5b
DM
116if ($submission->id and ($ownsubmission or $canviewall or $isreviewer)) {
117 // ok you can go
d67c20b8
DM
118} elseif ($submission->id and $ispublished) {
119 // ok you can go
120 $seenaspublished = true;
3dc78e5b
DM
121} elseif (is_null($submission->id) and $cansubmit) {
122 // ok you can go
123} else {
60719642 124 print_error('nopermissions', 'error', $workshop->view_url(), 'view or create submission');
c1e883bb
DM
125}
126
9ddff589 127if ($assess and $submission->id and !$isreviewer and $canallocate and $workshop->assessing_allowed($USER->id)) {
ac239eba
DM
128 require_sesskey();
129 $assessmentid = $workshop->add_allocation($submission, $USER->id);
130 redirect($workshop->assess_url($assessmentid));
131}
132
514d8c22 133if ($edit) {
1fcf0ca8 134 require_once(__DIR__.'/submission_form.php');
67cd00ba 135
996f7e82
DM
136 $submission = file_prepare_standard_editor($submission, 'content', $workshop->submission_content_options(),
137 $workshop->context, 'mod_workshop', 'submission_content', $submission->id);
138
139 $submission = file_prepare_standard_filemanager($submission, 'attachment', $workshop->submission_attachment_options(),
140 $workshop->context, 'mod_workshop', 'submission_attachment', $submission->id);
141
142 $mform = new workshop_submission_form($PAGE->url, array('current' => $submission, 'workshop' => $workshop,
143 'contentopts' => $workshop->submission_content_options(), 'attachmentopts' => $workshop->submission_attachment_options()));
67cd00ba
DM
144
145 if ($mform->is_cancelled()) {
146 redirect($workshop->view_url());
147
148 } elseif ($cansubmit and $formdata = $mform->get_data()) {
4c776cae
JL
149
150 $formdata->id = $submission->id;
151 // Creates or updates submission.
152 $submission->id = $workshop->edit_submission($formdata);
153
154 redirect($workshop->submission_url($submission->id));
33e4dea6 155 }
33e4dea6
DM
156}
157
232175e4
DM
158// load the form to override grade and/or publish the submission and process the submitted data eventually
159if (!$edit and ($canoverride or $canpublish)) {
160 $options = array(
161 'editable' => true,
162 'editablepublished' => $canpublish,
163 'overridablegrade' => $canoverride);
164 $feedbackform = $workshop->get_feedbackauthor_form($PAGE->url, $submission, $options);
557a1100
DM
165 if ($data = $feedbackform->get_data()) {
166 $data = file_postupdate_standard_editor($data, 'feedbackauthor', array(), $workshop->context);
7a789aa8 167 $record = new stdclass();
557a1100 168 $record->id = $submission->id;
232175e4
DM
169 if ($canoverride) {
170 $record->gradeover = $workshop->raw_grade_value($data->gradeover, $workshop->grade);
171 $record->gradeoverby = $USER->id;
172 $record->feedbackauthor = $data->feedbackauthor;
173 $record->feedbackauthorformat = $data->feedbackauthorformat;
174 }
175 if ($canpublish) {
176 $record->published = !empty($data->published);
177 }
557a1100
DM
178 $DB->update_record('workshop_submissions', $record);
179 redirect($workshop->view_url());
180 }
181}
182
0dc47fb9
DM
183$PAGE->set_title($workshop->name);
184$PAGE->set_heading($course->fullname);
39861053 185if ($edit) {
b761e6d9 186 $PAGE->navbar->add(get_string('mysubmission', 'workshop'), $workshop->submission_url(), navigation_node::TYPE_CUSTOM);
39861053 187 $PAGE->navbar->add(get_string('editingsubmission', 'workshop'));
51508f25 188} elseif ($ownsubmission) {
b761e6d9 189 $PAGE->navbar->add(get_string('mysubmission', 'workshop'));
51508f25
DM
190} else {
191 $PAGE->navbar->add(get_string('submission', 'workshop'));
39861053 192}
33e4dea6 193
c1e883bb 194// Output starts here
81b22887
DM
195$output = $PAGE->get_renderer('mod_workshop');
196echo $output->header();
197echo $output->heading(format_string($workshop->name), 2);
ddc9cff6 198echo $output->heading(get_string('mysubmission', 'workshop'), 3);
c1e883bb 199
e0142f7e
DM
200// show instructions for submitting as thay may contain some list of questions and we need to know them
201// while reading the submitted answer
202if (trim($workshop->instructauthors)) {
203 $instructions = file_rewrite_pluginfile_urls($workshop->instructauthors, 'pluginfile.php', $PAGE->context->id,
e46aec4c 204 'mod_workshop', 'instructauthors', null, workshop::instruction_editors_options($PAGE->context));
e0142f7e 205 print_collapsible_region_start('', 'workshop-viewlet-instructauthors', get_string('instructauthors', 'workshop'));
367a75fa 206 echo $output->box(format_text($instructions, $workshop->instructauthorsformat, array('overflowdiv'=>true)), array('generalbox', 'instructions'));
e0142f7e
DM
207 print_collapsible_region_end();
208}
209
3dc78e5b
DM
210// if in edit mode, display the form to edit the submission
211
514d8c22 212if ($edit) {
67ba9007
KG
213 if (!empty($CFG->enableplagiarism)) {
214 require_once($CFG->libdir.'/plagiarismlib.php');
215 echo plagiarism_print_disclosure($cm->id);
216 }
c1e883bb 217 $mform->display();
81b22887 218 echo $output->footer();
c1e883bb
DM
219 die();
220}
221
deabe48b
PN
222// Confirm deletion (if requested).
223if ($deletable and $delete) {
224 $prompt = get_string('submissiondeleteconfirm', 'workshop');
225 if ($candeleteall) {
58489e11
DM
226 $count = count($workshop->get_assessments_of_submission($submission->id));
227 if ($count > 0) {
228 $prompt = get_string('submissiondeleteconfirmassess', 'workshop', ['count' => $count]);
deabe48b
PN
229 }
230 }
58489e11 231 echo $output->confirm($prompt, new moodle_url($PAGE->url, ['delete' => 1, 'confirm' => 1]), $workshop->view_url());
deabe48b
PN
232}
233
3dc78e5b
DM
234// else display the submission
235
236if ($submission->id) {
d67c20b8
DM
237 if ($seenaspublished) {
238 $showauthor = has_capability('mod/workshop:viewauthorpublished', $workshop->context);
239 } else {
240 $showauthor = has_capability('mod/workshop:viewauthornames', $workshop->context);
241 }
242 echo $output->render($workshop->prepare_submission($submission, $showauthor));
3dc78e5b 243} else {
81b22887 244 echo $output->box(get_string('noyoursubmission', 'workshop'));
c1e883bb
DM
245}
246
58489e11
DM
247// If not at removal confirmation screen, some action buttons can be displayed.
248if (!$delete) {
0cc5c646 249 // Display create/edit button.
58489e11
DM
250 if ($editable) {
251 if ($submission->id) {
252 $btnurl = new moodle_url($PAGE->url, array('edit' => 'on', 'id' => $submission->id));
253 $btntxt = get_string('editsubmission', 'workshop');
254 } else {
255 $btnurl = new moodle_url($PAGE->url, array('edit' => 'on'));
256 $btntxt = get_string('createsubmission', 'workshop');
257 }
258 echo $output->single_button($btnurl, $btntxt, 'get');
2f289d36 259 }
c1e883bb 260
0cc5c646 261 // Display delete button.
58489e11
DM
262 if ($submission->id and $deletable) {
263 $url = new moodle_url($PAGE->url, array('delete' => 1));
264 echo $output->single_button($url, get_string('deletesubmission', 'workshop'), 'get');
265 }
deabe48b 266
0cc5c646 267 // Display assess button.
58489e11
DM
268 if ($submission->id and !$edit and !$isreviewer and $canallocate and $workshop->assessing_allowed($USER->id)) {
269 $url = new moodle_url($PAGE->url, array('assess' => 1));
270 echo $output->single_button($url, get_string('assess', 'workshop'), 'post');
271 }
ac239eba
DM
272}
273
0dfb4bad
DM
274if (($workshop->phase == workshop::PHASE_CLOSED) and ($ownsubmission or $canviewall)) {
275 if (!empty($submission->gradeoverby) and strlen(trim($submission->feedbackauthor)) > 0) {
276 echo $output->render(new workshop_feedback_author($submission));
277 }
278}
279
3dc78e5b
DM
280// and possibly display the submission's review(s)
281
3dc78e5b 282if ($isreviewer) {
38504a44
DM
283 // user's own assessment
284 $strategy = $workshop->grading_strategy_instance();
285 $mform = $strategy->get_assessment_form($PAGE->url, 'assessment', $userassessment, false);
286 $options = array(
287 'showreviewer' => true,
288 'showauthor' => $showauthor,
289 'showform' => !is_null($userassessment->grade),
290 'showweight' => true,
291 );
292 $assessment = $workshop->prepare_assessment($userassessment, $mform, $options);
293 $assessment->title = get_string('assessmentbyyourself', 'workshop');
294
295 if ($workshop->assessing_allowed($USER->id)) {
296 if (is_null($userassessment->grade)) {
297 $assessment->add_action($workshop->assess_url($assessment->id), get_string('assess', 'workshop'));
298 } else {
299 $assessment->add_action($workshop->assess_url($assessment->id), get_string('reassess', 'workshop'));
5a372494 300 }
5a372494 301 }
38504a44
DM
302 if ($canoverride) {
303 $assessment->add_action($workshop->assess_url($assessment->id), get_string('assessmentsettings', 'workshop'));
304 }
305
306 echo $output->render($assessment);
f68648e9
DM
307
308 if ($workshop->phase == workshop::PHASE_CLOSED) {
309 if (strlen(trim($userassessment->feedbackreviewer)) > 0) {
310 echo $output->render(new workshop_feedback_reviewer($userassessment));
311 }
312 }
3dc78e5b
DM
313}
314
0cc5c646 315if (has_capability('mod/workshop:viewallassessments', $workshop->context) or ($ownsubmission and $workshop->assessments_available())) {
38504a44
DM
316 // other assessments
317 $strategy = $workshop->grading_strategy_instance();
318 $assessments = $workshop->get_assessments_of_submission($submission->id);
319 $showreviewer = has_capability('mod/workshop:viewreviewernames', $workshop->context);
5a372494
DM
320 foreach ($assessments as $assessment) {
321 if ($assessment->reviewerid == $USER->id) {
322 // own assessment has been displayed already
323 continue;
324 }
3779dcae
DM
325 if (is_null($assessment->grade) and !has_capability('mod/workshop:viewallassessments', $workshop->context)) {
326 // students do not see peer-assessment that are not graded yet
327 continue;
328 }
38504a44
DM
329 $mform = $strategy->get_assessment_form($PAGE->url, 'assessment', $assessment, false);
330 $options = array(
331 'showreviewer' => $showreviewer,
332 'showauthor' => $showauthor,
333 'showform' => !is_null($assessment->grade),
334 'showweight' => true,
335 );
f68648e9 336 $displayassessment = $workshop->prepare_assessment($assessment, $mform, $options);
38504a44 337 if ($canoverride) {
f68648e9
DM
338 $displayassessment->add_action($workshop->assess_url($assessment->id), get_string('assessmentsettings', 'workshop'));
339 }
340 echo $output->render($displayassessment);
341
342 if ($workshop->phase == workshop::PHASE_CLOSED and has_capability('mod/workshop:viewallassessments', $workshop->context)) {
343 if (strlen(trim($assessment->feedbackreviewer)) > 0) {
344 echo $output->render(new workshop_feedback_reviewer($assessment));
345 }
7a5f4be0 346 }
5a372494 347 }
3dc78e5b
DM
348}
349
557a1100
DM
350if (!$edit and $canoverride) {
351 // display a form to override the submission grade
352 $feedbackform->display();
353}
354
0cc5c646
DM
355// If portfolios are enabled and we are not on the edit/removal confirmation screen, display a button to export this page.
356// The export is not offered if the submission is seen as a published one (it has no relation to the current user.
357if (!empty($CFG->enableportfolios)) {
358 if (!$delete and !$edit and !$seenaspublished and $submission->id and ($ownsubmission or $canviewall or $isreviewer)) {
359 if (has_capability('mod/workshop:exportsubmissions', $workshop->context)) {
360 require_once($CFG->libdir.'/portfoliolib.php');
361
362 $button = new portfolio_add_button();
363 $button->set_callback_options('mod_workshop_portfolio_caller', array(
364 'id' => $workshop->cm->id,
365 'submissionid' => $submission->id,
366 ), 'mod_workshop');
367 $button->set_formats(PORTFOLIO_FORMAT_RICHHTML);
368 echo html_writer::start_tag('div', array('class' => 'singlebutton'));
369 echo $button->to_html(PORTFOLIO_ADD_FULL_FORM, get_string('exportsubmission', 'workshop'));
370 echo html_writer::end_tag('div');
371 }
372 }
373}
374
81b22887 375echo $output->footer();