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