MDL-27550 workshop: assessments are now displayed via proper rendering subsystem
[moodle.git] / mod / workshop / submission.php
CommitLineData
33e4dea6
DM
1<?php
2
53fad4b9
DM
3// This file is part of Moodle - http://moodle.org/
4//
33e4dea6
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//
33e4dea6
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/>.
17
33e4dea6 18/**
51508f25 19 * View a single (usually the own) submission, submit own work.
33e4dea6 20 *
65601f04
DM
21 * @package mod
22 * @subpackage workshop
23 * @copyright 2009 David Mudrak <david.mudrak@gmail.com>
24 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
33e4dea6
DM
25 */
26
27require_once(dirname(dirname(dirname(__FILE__))).'/config.php');
127032fe 28require_once(dirname(__FILE__).'/locallib.php');
33e4dea6 29
c1e883bb
DM
30$cmid = required_param('cmid', PARAM_INT); // course module id
31$id = optional_param('id', 0, PARAM_INT); // submission id
32$edit = optional_param('edit', false, PARAM_BOOL); // open for editing?
ac239eba 33$assess = optional_param('assess', false, PARAM_BOOL); // instant assessment required
33e4dea6 34
c1e883bb
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
51508f25
DM
43$workshop = $DB->get_record('workshop', array('id' => $cm->instance), '*', MUST_EXIST);
44$workshop = new workshop($workshop, $cm, $course);
45
a6855934 46$PAGE->set_url($workshop->submission_url(), array('cmid' => $cmid, 'id' => $id, 'edit' => $edit));
33e4dea6 47
127032fe 48if ($id) { // submission is specified
51508f25 49 $submission = $workshop->get_submission_by_id($id);
5450f7b6
DM
50 $workshop->log('view submission', $workshop->submission_url($submission->id), $submission->id);
51
127032fe 52} else { // no submission specified
0dc47fb9 53 if (!$submission = $workshop->get_submission_by_author($USER->id)) {
7a789aa8 54 $submission = new stdclass();
127032fe 55 $submission->id = null;
00aca3c1 56 $submission->authorid = $USER->id;
2e7bd6c2 57 $submission->example = 0;
c6b784f0
DM
58 $submission->grade = null;
59 $submission->gradeover = null;
60719642 60 $submission->published = null;
c6b784f0 61 $submission->feedbackauthor = null;
884482fb 62 $submission->feedbackauthorformat = editors_get_preferred_format();
53fad4b9 63 }
33e4dea6 64}
c1e883bb 65
00aca3c1 66$ownsubmission = $submission->authorid == $USER->id;
67cd00ba
DM
67$canviewall = has_capability('mod/workshop:viewallsubmissions', $workshop->context);
68$cansubmit = has_capability('mod/workshop:submit', $workshop->context);
ac239eba 69$canallocate = has_capability('mod/workshop:allocate', $workshop->context);
232175e4 70$canpublish = has_capability('mod/workshop:publishsubmissions', $workshop->context);
090a7907 71$canoverride = (($workshop->phase == workshop::PHASE_EVALUATION) and has_capability('mod/workshop:overridegrades', $workshop->context));
5a372494
DM
72$userassessment = $workshop->get_assessment_of_submission_by_user($submission->id, $USER->id);
73$isreviewer = !empty($userassessment);
2f289d36 74$editable = ($cansubmit and $ownsubmission);
d67c20b8
DM
75$ispublished = ($workshop->phase == workshop::PHASE_CLOSED
76 and $submission->published == 1
77 and has_capability('mod/workshop:viewpublishedsubmissions', $workshop->context));
2f289d36 78
9ddff589 79if (empty($submission->id) and !$workshop->creating_submission_allowed($USER->id)) {
2f289d36
DM
80 $editable = false;
81}
9ddff589 82if ($submission->id and !$workshop->modifying_submission_allowed($USER->id)) {
2f289d36
DM
83 $editable = false;
84}
85
514d8c22
DM
86if ($editable and $workshop->useexamples and $workshop->examplesmode == workshop::EXAMPLES_BEFORE_SUBMISSION
87 and !has_capability('mod/workshop:manageexamples', $workshop->context)) {
88 // check that all required examples have been assessed by the user
89 $examples = $workshop->get_examples_for_reviewer($USER->id);
90 foreach ($examples as $exampleid => $example) {
91 if (is_null($example->grade)) {
92 $editable = false;
93 break;
94 }
95 }
96}
97$edit = ($editable and $edit);
51508f25 98
d67c20b8
DM
99$seenaspublished = false; // is the submission seen as a published submission?
100
3dc78e5b
DM
101if ($submission->id and ($ownsubmission or $canviewall or $isreviewer)) {
102 // ok you can go
d67c20b8
DM
103} elseif ($submission->id and $ispublished) {
104 // ok you can go
105 $seenaspublished = true;
3dc78e5b
DM
106} elseif (is_null($submission->id) and $cansubmit) {
107 // ok you can go
108} else {
60719642 109 print_error('nopermissions', 'error', $workshop->view_url(), 'view or create submission');
c1e883bb
DM
110}
111
9ddff589 112if ($assess and $submission->id and !$isreviewer and $canallocate and $workshop->assessing_allowed($USER->id)) {
ac239eba
DM
113 require_sesskey();
114 $assessmentid = $workshop->add_allocation($submission, $USER->id);
115 redirect($workshop->assess_url($assessmentid));
116}
117
514d8c22 118if ($edit) {
67cd00ba
DM
119 require_once(dirname(__FILE__).'/submission_form.php');
120
121 $maxfiles = $workshop->nattachments;
122 $maxbytes = $workshop->maxbytes;
123 $contentopts = array('trusttext' => true, 'subdirs' => false, 'maxfiles' => $maxfiles, 'maxbytes' => $maxbytes);
124 $attachmentopts = array('subdirs' => true, 'maxfiles' => $maxfiles, 'maxbytes' => $maxbytes);
125 $submission = file_prepare_standard_editor($submission, 'content', $contentopts, $workshop->context,
64f93798 126 'mod_workshop', 'submission_content', $submission->id);
67cd00ba 127 $submission = file_prepare_standard_filemanager($submission, 'attachment', $attachmentopts, $workshop->context,
64f93798 128 'mod_workshop', 'submission_attachment', $submission->id);
67cd00ba
DM
129
130 $mform = new workshop_submission_form($PAGE->url, array('current' => $submission, 'workshop' => $workshop,
131 'contentopts' => $contentopts, 'attachmentopts' => $attachmentopts));
132
133 if ($mform->is_cancelled()) {
134 redirect($workshop->view_url());
135
136 } elseif ($cansubmit and $formdata = $mform->get_data()) {
2e7bd6c2
DM
137 if ($formdata->example == 0) {
138 // this was used just for validation, it must be set to zero when dealing with normal submissions
139 unset($formdata->example);
140 } else {
141 throw new coding_exception('Invalid submission form data value: example');
142 }
67cd00ba 143 $timenow = time();
2e7bd6c2 144 if (is_null($submission->id)) {
67cd00ba 145 $formdata->workshopid = $workshop->id;
81eccf0a 146 $formdata->example = 0;
67cd00ba
DM
147 $formdata->authorid = $USER->id;
148 $formdata->timecreated = $timenow;
884482fb 149 $formdata->feedbackauthorformat = editors_get_preferred_format();
67cd00ba
DM
150 }
151 $formdata->timemodified = $timenow;
152 $formdata->title = trim($formdata->title);
153 $formdata->content = ''; // updated later
154 $formdata->contentformat = FORMAT_HTML; // updated later
155 $formdata->contenttrust = 0; // updated later
2f289d36
DM
156 $formdata->late = 0x0; // bit mask
157 if (!empty($workshop->submissionend) and ($workshop->submissionend < time())) {
158 $formdata->late = $formdata->late | 0x1;
159 }
160 if ($workshop->phase == workshop::PHASE_ASSESSMENT) {
161 $formdata->late = $formdata->late | 0x2;
162 }
2e7bd6c2
DM
163 if (is_null($submission->id)) {
164 $submission->id = $formdata->id = $DB->insert_record('workshop_submissions', $formdata);
5450f7b6 165 $workshop->log('add submission', $workshop->submission_url($submission->id), $submission->id);
2e7bd6c2 166 } else {
5450f7b6 167 $workshop->log('update submission', $workshop->submission_url($submission->id), $submission->id);
2e7bd6c2
DM
168 if (empty($formdata->id) or empty($submission->id) or ($formdata->id != $submission->id)) {
169 throw new moodle_exception('err_submissionid', 'workshop');
170 }
67cd00ba
DM
171 }
172 // save and relink embedded images and save attachments
173 $formdata = file_postupdate_standard_editor($formdata, 'content', $contentopts, $workshop->context,
2e7bd6c2 174 'mod_workshop', 'submission_content', $submission->id);
67cd00ba 175 $formdata = file_postupdate_standard_filemanager($formdata, 'attachment', $attachmentopts, $workshop->context,
2e7bd6c2 176 'mod_workshop', 'submission_attachment', $submission->id);
f1b4b387 177 if (empty($formdata->attachment)) {
ac239eba 178 // explicit cast to zero integer
f1b4b387
DM
179 $formdata->attachment = 0;
180 }
67cd00ba
DM
181 // store the updated values or re-save the new submission (re-saving needed because URLs are now rewritten)
182 $DB->update_record('workshop_submissions', $formdata);
183 redirect($workshop->submission_url($formdata->id));
33e4dea6 184 }
33e4dea6
DM
185}
186
232175e4
DM
187// load the form to override grade and/or publish the submission and process the submitted data eventually
188if (!$edit and ($canoverride or $canpublish)) {
189 $options = array(
190 'editable' => true,
191 'editablepublished' => $canpublish,
192 'overridablegrade' => $canoverride);
193 $feedbackform = $workshop->get_feedbackauthor_form($PAGE->url, $submission, $options);
557a1100
DM
194 if ($data = $feedbackform->get_data()) {
195 $data = file_postupdate_standard_editor($data, 'feedbackauthor', array(), $workshop->context);
7a789aa8 196 $record = new stdclass();
557a1100 197 $record->id = $submission->id;
232175e4
DM
198 if ($canoverride) {
199 $record->gradeover = $workshop->raw_grade_value($data->gradeover, $workshop->grade);
200 $record->gradeoverby = $USER->id;
201 $record->feedbackauthor = $data->feedbackauthor;
202 $record->feedbackauthorformat = $data->feedbackauthorformat;
203 }
204 if ($canpublish) {
205 $record->published = !empty($data->published);
206 }
557a1100
DM
207 $DB->update_record('workshop_submissions', $record);
208 redirect($workshop->view_url());
209 }
210}
211
0dc47fb9
DM
212$PAGE->set_title($workshop->name);
213$PAGE->set_heading($course->fullname);
39861053 214if ($edit) {
b761e6d9 215 $PAGE->navbar->add(get_string('mysubmission', 'workshop'), $workshop->submission_url(), navigation_node::TYPE_CUSTOM);
39861053 216 $PAGE->navbar->add(get_string('editingsubmission', 'workshop'));
51508f25 217} elseif ($ownsubmission) {
b761e6d9 218 $PAGE->navbar->add(get_string('mysubmission', 'workshop'));
51508f25
DM
219} else {
220 $PAGE->navbar->add(get_string('submission', 'workshop'));
39861053 221}
33e4dea6 222
c1e883bb 223// Output starts here
81b22887
DM
224$output = $PAGE->get_renderer('mod_workshop');
225echo $output->header();
226echo $output->heading(format_string($workshop->name), 2);
c1e883bb 227
e0142f7e
DM
228// show instructions for submitting as thay may contain some list of questions and we need to know them
229// while reading the submitted answer
230if (trim($workshop->instructauthors)) {
231 $instructions = file_rewrite_pluginfile_urls($workshop->instructauthors, 'pluginfile.php', $PAGE->context->id,
232 'mod_workshop', 'instructauthors', 0, workshop::instruction_editors_options($PAGE->context));
233 print_collapsible_region_start('', 'workshop-viewlet-instructauthors', get_string('instructauthors', 'workshop'));
367a75fa 234 echo $output->box(format_text($instructions, $workshop->instructauthorsformat, array('overflowdiv'=>true)), array('generalbox', 'instructions'));
e0142f7e
DM
235 print_collapsible_region_end();
236}
237
3dc78e5b
DM
238// if in edit mode, display the form to edit the submission
239
514d8c22 240if ($edit) {
c1e883bb 241 $mform->display();
81b22887 242 echo $output->footer();
c1e883bb
DM
243 die();
244}
245
3dc78e5b
DM
246// else display the submission
247
248if ($submission->id) {
d67c20b8
DM
249 if ($seenaspublished) {
250 $showauthor = has_capability('mod/workshop:viewauthorpublished', $workshop->context);
251 } else {
252 $showauthor = has_capability('mod/workshop:viewauthornames', $workshop->context);
253 }
254 echo $output->render($workshop->prepare_submission($submission, $showauthor));
3dc78e5b 255} else {
81b22887 256 echo $output->box(get_string('noyoursubmission', 'workshop'));
c1e883bb
DM
257}
258
514d8c22 259if ($editable) {
2f289d36
DM
260 if ($submission->id) {
261 $btnurl = new moodle_url($PAGE->url, array('edit' => 'on', 'id' => $submission->id));
262 $btntxt = get_string('editsubmission', 'workshop');
263 } else {
264 $btnurl = new moodle_url($PAGE->url, array('edit' => 'on'));
265 $btntxt = get_string('createsubmission', 'workshop');
266 }
81b22887 267 echo $output->single_button($btnurl, $btntxt, 'get');
c1e883bb
DM
268}
269
9ddff589 270if ($submission->id and !$edit and !$isreviewer and $canallocate and $workshop->assessing_allowed($USER->id)) {
ac239eba 271 $url = new moodle_url($PAGE->url, array('assess' => 1));
81b22887 272 echo $output->single_button($url, get_string('assess', 'workshop'), 'post');
ac239eba
DM
273}
274
0dfb4bad
DM
275if (($workshop->phase == workshop::PHASE_CLOSED) and ($ownsubmission or $canviewall)) {
276 if (!empty($submission->gradeoverby) and strlen(trim($submission->feedbackauthor)) > 0) {
277 echo $output->render(new workshop_feedback_author($submission));
278 }
279}
280
3dc78e5b
DM
281// and possibly display the submission's review(s)
282
3dc78e5b 283if ($isreviewer) {
38504a44
DM
284 // user's own assessment
285 $strategy = $workshop->grading_strategy_instance();
286 $mform = $strategy->get_assessment_form($PAGE->url, 'assessment', $userassessment, false);
287 $options = array(
288 'showreviewer' => true,
289 'showauthor' => $showauthor,
290 'showform' => !is_null($userassessment->grade),
291 'showweight' => true,
292 );
293 $assessment = $workshop->prepare_assessment($userassessment, $mform, $options);
294 $assessment->title = get_string('assessmentbyyourself', 'workshop');
295
296 if ($workshop->assessing_allowed($USER->id)) {
297 if (is_null($userassessment->grade)) {
298 $assessment->add_action($workshop->assess_url($assessment->id), get_string('assess', 'workshop'));
299 } else {
300 $assessment->add_action($workshop->assess_url($assessment->id), get_string('reassess', 'workshop'));
5a372494 301 }
5a372494 302 }
38504a44
DM
303 if ($canoverride) {
304 $assessment->add_action($workshop->assess_url($assessment->id), get_string('assessmentsettings', 'workshop'));
305 }
306
307 echo $output->render($assessment);
3dc78e5b
DM
308}
309
5a372494 310if (has_capability('mod/workshop:viewallassessments', $workshop->context) or ($ownsubmission and $workshop->assessments_available())) {
38504a44
DM
311 // other assessments
312 $strategy = $workshop->grading_strategy_instance();
313 $assessments = $workshop->get_assessments_of_submission($submission->id);
314 $showreviewer = has_capability('mod/workshop:viewreviewernames', $workshop->context);
5a372494
DM
315 foreach ($assessments as $assessment) {
316 if ($assessment->reviewerid == $USER->id) {
317 // own assessment has been displayed already
318 continue;
319 }
38504a44
DM
320 $mform = $strategy->get_assessment_form($PAGE->url, 'assessment', $assessment, false);
321 $options = array(
322 'showreviewer' => $showreviewer,
323 'showauthor' => $showauthor,
324 'showform' => !is_null($assessment->grade),
325 'showweight' => true,
326 );
327 $assessment = $workshop->prepare_assessment($assessment, $mform, $options);
328 if ($canoverride) {
329 $assessment->add_action($workshop->assess_url($assessment->id), get_string('assessmentsettings', 'workshop'));
7a5f4be0 330 }
38504a44 331 echo $output->render($assessment);
5a372494 332 }
3dc78e5b
DM
333}
334
557a1100
DM
335if (!$edit and $canoverride) {
336 // display a form to override the submission grade
337 $feedbackform->display();
338}
339
81b22887 340echo $output->footer();