MDL-59239 mod_workshop: New WS mod_workshop_view_submission
[moodle.git] / mod / workshop / submission.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
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.
13 //
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/>.
17 /**
18  * View a single (usually the own) submission, submit own work.
19  *
20  * @package    mod_workshop
21  * @copyright  2009 David Mudrak <david.mudrak@gmail.com>
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 require(__DIR__.'/../../config.php');
26 require_once(__DIR__.'/locallib.php');
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.
35 $cm = get_coursemodule_from_id('workshop', $cmid, 0, false, MUST_EXIST);
36 $course = $DB->get_record('course', array('id' => $cm->course), '*', MUST_EXIST);
38 require_login($course, false, $cm);
39 if (isguestuser()) {
40     print_error('guestsarenotallowed');
41 }
43 $workshoprecord = $DB->get_record('workshop', array('id' => $cm->instance), '*', MUST_EXIST);
44 $workshop = new workshop($workshoprecord, $cm, $course);
46 $PAGE->set_url($workshop->submission_url(), array('cmid' => $cmid, 'id' => $id));
48 if ($edit) {
49     $PAGE->url->param('edit', $edit);
50 }
52 if ($id) { // submission is specified
53     $submission = $workshop->get_submission_by_id($id);
54     // Trigger submission viewed event.
55     $workshop->set_submission_viewed($submission);
57 } else { // no submission specified
58     if (!$submission = $workshop->get_submission_by_author($USER->id)) {
59         $submission = new stdclass();
60         $submission->id = null;
61         $submission->authorid = $USER->id;
62         $submission->example = 0;
63         $submission->grade = null;
64         $submission->gradeover = null;
65         $submission->published = null;
66         $submission->feedbackauthor = null;
67         $submission->feedbackauthorformat = editors_get_preferred_format();
68     }
69 }
71 $ownsubmission  = $submission->authorid == $USER->id;
72 $canviewall     = has_capability('mod/workshop:viewallsubmissions', $workshop->context);
73 $cansubmit      = has_capability('mod/workshop:submit', $workshop->context);
74 $canallocate    = has_capability('mod/workshop:allocate', $workshop->context);
75 $canpublish     = has_capability('mod/workshop:publishsubmissions', $workshop->context);
76 $canoverride    = (($workshop->phase == workshop::PHASE_EVALUATION) and has_capability('mod/workshop:overridegrades', $workshop->context));
77 $candeleteall   = has_capability('mod/workshop:deletesubmissions', $workshop->context);
78 $userassessment = $workshop->get_assessment_of_submission_by_user($submission->id, $USER->id);
79 $isreviewer     = !empty($userassessment);
80 $editable       = ($cansubmit and $ownsubmission);
81 $deletable      = $candeleteall;
82 $ispublished    = ($workshop->phase == workshop::PHASE_CLOSED
83                     and $submission->published == 1
84                     and has_capability('mod/workshop:viewpublishedsubmissions', $workshop->context));
86 if (empty($submission->id) and !$workshop->creating_submission_allowed($USER->id)) {
87     $editable = false;
88 }
89 if ($submission->id and !$workshop->modifying_submission_allowed($USER->id)) {
90     $editable = false;
91 }
93 $canviewall = $canviewall && $workshop->check_group_membership($submission->authorid);
95 $editable = ($editable && $workshop->check_examples_assessed_before_submission($USER->id));
96 $edit = ($editable and $edit);
98 if (!$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     }
107 if ($submission->id and $delete and $confirm and $deletable) {
108     require_sesskey();
109     $workshop->delete_submission($submission);
111     redirect($workshop->view_url());
114 $seenaspublished = false; // is the submission seen as a published submission?
116 if ($submission->id and ($ownsubmission or $canviewall or $isreviewer)) {
117     // ok you can go
118 } elseif ($submission->id and $ispublished) {
119     // ok you can go
120     $seenaspublished = true;
121 } elseif (is_null($submission->id) and $cansubmit) {
122     // ok you can go
123 } else {
124     print_error('nopermissions', 'error', $workshop->view_url(), 'view or create submission');
127 if ($assess and $submission->id and !$isreviewer and $canallocate and $workshop->assessing_allowed($USER->id)) {
128     require_sesskey();
129     $assessmentid = $workshop->add_allocation($submission, $USER->id);
130     redirect($workshop->assess_url($assessmentid));
133 if ($edit) {
134     require_once(__DIR__.'/submission_form.php');
136     $submission = file_prepare_standard_editor($submission, 'content', $workshop->submission_content_options(),
137         $workshop->context, 'mod_workshop', 'submission_content', $submission->id);
139     $submission = file_prepare_standard_filemanager($submission, 'attachment', $workshop->submission_attachment_options(),
140         $workshop->context, 'mod_workshop', 'submission_attachment', $submission->id);
142     $mform = new workshop_submission_form($PAGE->url, array('current' => $submission, 'workshop' => $workshop,
143         'contentopts' => $workshop->submission_content_options(), 'attachmentopts' => $workshop->submission_attachment_options()));
145     if ($mform->is_cancelled()) {
146         redirect($workshop->view_url());
148     } elseif ($cansubmit and $formdata = $mform->get_data()) {
150         $formdata->id = $submission->id;
151         // Creates or updates submission.
152         $submission->id = $workshop->edit_submission($formdata);
154         redirect($workshop->submission_url($submission->id));
155     }
158 // load the form to override grade and/or publish the submission and process the submitted data eventually
159 if (!$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);
165     if ($data = $feedbackform->get_data()) {
166         $data = file_postupdate_standard_editor($data, 'feedbackauthor', array(), $workshop->context);
167         $record = new stdclass();
168         $record->id = $submission->id;
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         }
178         $DB->update_record('workshop_submissions', $record);
179         redirect($workshop->view_url());
180     }
183 $PAGE->set_title($workshop->name);
184 $PAGE->set_heading($course->fullname);
185 if ($edit) {
186     $PAGE->navbar->add(get_string('mysubmission', 'workshop'), $workshop->submission_url(), navigation_node::TYPE_CUSTOM);
187     $PAGE->navbar->add(get_string('editingsubmission', 'workshop'));
188 } elseif ($ownsubmission) {
189     $PAGE->navbar->add(get_string('mysubmission', 'workshop'));
190 } else {
191     $PAGE->navbar->add(get_string('submission', 'workshop'));
194 // Output starts here
195 $output = $PAGE->get_renderer('mod_workshop');
196 echo $output->header();
197 echo $output->heading(format_string($workshop->name), 2);
198 echo $output->heading(get_string('mysubmission', 'workshop'), 3);
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
202 if (trim($workshop->instructauthors)) {
203     $instructions = file_rewrite_pluginfile_urls($workshop->instructauthors, 'pluginfile.php', $PAGE->context->id,
204         'mod_workshop', 'instructauthors', null, workshop::instruction_editors_options($PAGE->context));
205     print_collapsible_region_start('', 'workshop-viewlet-instructauthors', get_string('instructauthors', 'workshop'));
206     echo $output->box(format_text($instructions, $workshop->instructauthorsformat, array('overflowdiv'=>true)), array('generalbox', 'instructions'));
207     print_collapsible_region_end();
210 // if in edit mode, display the form to edit the submission
212 if ($edit) {
213     if (!empty($CFG->enableplagiarism)) {
214         require_once($CFG->libdir.'/plagiarismlib.php');
215         echo plagiarism_print_disclosure($cm->id);
216     }
217     $mform->display();
218     echo $output->footer();
219     die();
222 // Confirm deletion (if requested).
223 if ($deletable and $delete) {
224     $prompt = get_string('submissiondeleteconfirm', 'workshop');
225     if ($candeleteall) {
226         $count = count($workshop->get_assessments_of_submission($submission->id));
227         if ($count > 0) {
228             $prompt = get_string('submissiondeleteconfirmassess', 'workshop', ['count' => $count]);
229         }
230     }
231     echo $output->confirm($prompt, new moodle_url($PAGE->url, ['delete' => 1, 'confirm' => 1]), $workshop->view_url());
234 // else display the submission
236 if ($submission->id) {
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));
243 } else {
244     echo $output->box(get_string('noyoursubmission', 'workshop'));
247 // If not at removal confirmation screen, some action buttons can be displayed.
248 if (!$delete) {
249     // Display create/edit button.
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');
259     }
261     // Display delete button.
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     }
267     // Display assess button.
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     }
274 if (($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     }
280 // and possibly display the submission's review(s)
282 if ($isreviewer) {
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');
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'));
300         }
301     }
302     if ($canoverride) {
303         $assessment->add_action($workshop->assess_url($assessment->id), get_string('assessmentsettings', 'workshop'));
304     }
306     echo $output->render($assessment);
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     }
315 if (has_capability('mod/workshop:viewallassessments', $workshop->context) or ($ownsubmission and $workshop->assessments_available())) {
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);
320     foreach ($assessments as $assessment) {
321         if ($assessment->reviewerid == $USER->id) {
322             // own assessment has been displayed already
323             continue;
324         }
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         }
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         );
336         $displayassessment = $workshop->prepare_assessment($assessment, $mform, $options);
337         if ($canoverride) {
338             $displayassessment->add_action($workshop->assess_url($assessment->id), get_string('assessmentsettings', 'workshop'));
339         }
340         echo $output->render($displayassessment);
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             }
346         }
347     }
350 if (!$edit and $canoverride) {
351     // display a form to override the submission grade
352     $feedbackform->display();
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.
357 if (!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');
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     }
375 echo $output->footer();