3 // This file is part of Moodle - http://moodle.org/
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.
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.
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/>.
19 * View a single (usually the own) submission, submit own work.
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
27 require_once(dirname(dirname(dirname(__FILE__
))).'/config.php');
28 require_once(dirname(__FILE__
).'/locallib.php');
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?
33 $assess = optional_param('assess', false, PARAM_BOOL
); // instant assessment required
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);
40 print_error('guestsarenotallowed');
43 $workshop = $DB->get_record('workshop', array('id' => $cm->instance
), '*', MUST_EXIST
);
44 $workshop = new workshop($workshop, $cm, $course);
46 $PAGE->set_url($workshop->submission_url(), array('cmid' => $cmid, 'id' => $id));
49 $PAGE->url
->param('edit', $edit);
52 if ($id) { // submission is specified
53 $submission = $workshop->get_submission_by_id($id);
54 $workshop->log('view submission', $workshop->submission_url($submission->id
), $submission->id
);
56 } else { // no submission specified
57 if (!$submission = $workshop->get_submission_by_author($USER->id
)) {
58 $submission = new stdclass();
59 $submission->id
= null;
60 $submission->authorid
= $USER->id
;
61 $submission->example
= 0;
62 $submission->grade
= null;
63 $submission->gradeover
= null;
64 $submission->published
= null;
65 $submission->feedbackauthor
= null;
66 $submission->feedbackauthorformat
= editors_get_preferred_format();
70 $ownsubmission = $submission->authorid
== $USER->id
;
71 $canviewall = has_capability('mod/workshop:viewallsubmissions', $workshop->context
);
72 $cansubmit = has_capability('mod/workshop:submit', $workshop->context
);
73 $canallocate = has_capability('mod/workshop:allocate', $workshop->context
);
74 $canpublish = has_capability('mod/workshop:publishsubmissions', $workshop->context
);
75 $canoverride = (($workshop->phase
== workshop
::PHASE_EVALUATION
) and has_capability('mod/workshop:overridegrades', $workshop->context
));
76 $userassessment = $workshop->get_assessment_of_submission_by_user($submission->id
, $USER->id
);
77 $isreviewer = !empty($userassessment);
78 $editable = ($cansubmit and $ownsubmission);
79 $ispublished = ($workshop->phase
== workshop
::PHASE_CLOSED
80 and $submission->published
== 1
81 and has_capability('mod/workshop:viewpublishedsubmissions', $workshop->context
));
83 if (empty($submission->id
) and !$workshop->creating_submission_allowed($USER->id
)) {
86 if ($submission->id
and !$workshop->modifying_submission_allowed($USER->id
)) {
90 if ($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
)) {
101 $edit = ($editable and $edit);
103 $seenaspublished = false; // is the submission seen as a published submission?
105 if ($submission->id
and ($ownsubmission or $canviewall or $isreviewer)) {
107 } elseif ($submission->id
and $ispublished) {
109 $seenaspublished = true;
110 } elseif (is_null($submission->id
) and $cansubmit) {
113 print_error('nopermissions', 'error', $workshop->view_url(), 'view or create submission');
116 if ($assess and $submission->id
and !$isreviewer and $canallocate and $workshop->assessing_allowed($USER->id
)) {
118 $assessmentid = $workshop->add_allocation($submission, $USER->id
);
119 redirect($workshop->assess_url($assessmentid));
123 require_once(dirname(__FILE__
).'/submission_form.php');
125 $maxfiles = $workshop->nattachments
;
126 $maxbytes = $workshop->maxbytes
;
127 $contentopts = array(
130 'maxfiles' => $maxfiles,
131 'maxbytes' => $maxbytes,
132 'context' => $workshop->context
135 $attachmentopts = array('subdirs' => true, 'maxfiles' => $maxfiles, 'maxbytes' => $maxbytes);
136 $submission = file_prepare_standard_editor($submission, 'content', $contentopts, $workshop->context
,
137 'mod_workshop', 'submission_content', $submission->id
);
138 $submission = file_prepare_standard_filemanager($submission, 'attachment', $attachmentopts, $workshop->context
,
139 'mod_workshop', 'submission_attachment', $submission->id
);
141 $mform = new workshop_submission_form($PAGE->url
, array('current' => $submission, 'workshop' => $workshop,
142 'contentopts' => $contentopts, 'attachmentopts' => $attachmentopts));
144 if ($mform->is_cancelled()) {
145 redirect($workshop->view_url());
147 } elseif ($cansubmit and $formdata = $mform->get_data()) {
148 if ($formdata->example
== 0) {
149 // this was used just for validation, it must be set to zero when dealing with normal submissions
150 unset($formdata->example
);
152 throw new coding_exception('Invalid submission form data value: example');
155 if (is_null($submission->id
)) {
156 $formdata->workshopid
= $workshop->id
;
157 $formdata->example
= 0;
158 $formdata->authorid
= $USER->id
;
159 $formdata->timecreated
= $timenow;
160 $formdata->feedbackauthorformat
= editors_get_preferred_format();
162 $formdata->timemodified
= $timenow;
163 $formdata->title
= trim($formdata->title
);
164 $formdata->content
= ''; // updated later
165 $formdata->contentformat
= FORMAT_HTML
; // updated later
166 $formdata->contenttrust
= 0; // updated later
167 $formdata->late
= 0x0; // bit mask
168 if (!empty($workshop->submissionend
) and ($workshop->submissionend
< time())) {
169 $formdata->late
= $formdata->late |
0x1;
171 if ($workshop->phase
== workshop
::PHASE_ASSESSMENT
) {
172 $formdata->late
= $formdata->late |
0x2;
174 if (is_null($submission->id
)) {
175 $submission->id
= $formdata->id
= $DB->insert_record('workshop_submissions', $formdata);
176 $workshop->log('add submission', $workshop->submission_url($submission->id
), $submission->id
);
178 $workshop->log('update submission', $workshop->submission_url($submission->id
), $submission->id
);
179 if (empty($formdata->id
) or empty($submission->id
) or ($formdata->id
!= $submission->id
)) {
180 throw new moodle_exception('err_submissionid', 'workshop');
183 // save and relink embedded images and save attachments
184 $formdata = file_postupdate_standard_editor($formdata, 'content', $contentopts, $workshop->context
,
185 'mod_workshop', 'submission_content', $submission->id
);
186 $formdata = file_postupdate_standard_filemanager($formdata, 'attachment', $attachmentopts, $workshop->context
,
187 'mod_workshop', 'submission_attachment', $submission->id
);
188 if (empty($formdata->attachment
)) {
189 // explicit cast to zero integer
190 $formdata->attachment
= 0;
192 // store the updated values or re-save the new submission (re-saving needed because URLs are now rewritten)
193 $DB->update_record('workshop_submissions', $formdata);
194 redirect($workshop->submission_url($formdata->id
));
198 // load the form to override grade and/or publish the submission and process the submitted data eventually
199 if (!$edit and ($canoverride or $canpublish)) {
202 'editablepublished' => $canpublish,
203 'overridablegrade' => $canoverride);
204 $feedbackform = $workshop->get_feedbackauthor_form($PAGE->url
, $submission, $options);
205 if ($data = $feedbackform->get_data()) {
206 $data = file_postupdate_standard_editor($data, 'feedbackauthor', array(), $workshop->context
);
207 $record = new stdclass();
208 $record->id
= $submission->id
;
210 $record->gradeover
= $workshop->raw_grade_value($data->gradeover
, $workshop->grade
);
211 $record->gradeoverby
= $USER->id
;
212 $record->feedbackauthor
= $data->feedbackauthor
;
213 $record->feedbackauthorformat
= $data->feedbackauthorformat
;
216 $record->published
= !empty($data->published
);
218 $DB->update_record('workshop_submissions', $record);
219 redirect($workshop->view_url());
223 $PAGE->set_title($workshop->name
);
224 $PAGE->set_heading($course->fullname
);
226 $PAGE->navbar
->add(get_string('mysubmission', 'workshop'), $workshop->submission_url(), navigation_node
::TYPE_CUSTOM
);
227 $PAGE->navbar
->add(get_string('editingsubmission', 'workshop'));
228 } elseif ($ownsubmission) {
229 $PAGE->navbar
->add(get_string('mysubmission', 'workshop'));
231 $PAGE->navbar
->add(get_string('submission', 'workshop'));
234 // Output starts here
235 $output = $PAGE->get_renderer('mod_workshop');
236 echo $output->header();
237 echo $output->heading(format_string($workshop->name
), 2);
239 // show instructions for submitting as thay may contain some list of questions and we need to know them
240 // while reading the submitted answer
241 if (trim($workshop->instructauthors
)) {
242 $instructions = file_rewrite_pluginfile_urls($workshop->instructauthors
, 'pluginfile.php', $PAGE->context
->id
,
243 'mod_workshop', 'instructauthors', 0, workshop
::instruction_editors_options($PAGE->context
));
244 print_collapsible_region_start('', 'workshop-viewlet-instructauthors', get_string('instructauthors', 'workshop'));
245 echo $output->box(format_text($instructions, $workshop->instructauthorsformat
, array('overflowdiv'=>true)), array('generalbox', 'instructions'));
246 print_collapsible_region_end();
249 // if in edit mode, display the form to edit the submission
253 echo $output->footer();
257 // else display the submission
259 if ($submission->id
) {
260 if ($seenaspublished) {
261 $showauthor = has_capability('mod/workshop:viewauthorpublished', $workshop->context
);
263 $showauthor = has_capability('mod/workshop:viewauthornames', $workshop->context
);
265 echo $output->render($workshop->prepare_submission($submission, $showauthor));
267 echo $output->box(get_string('noyoursubmission', 'workshop'));
271 if ($submission->id
) {
272 $btnurl = new moodle_url($PAGE->url
, array('edit' => 'on', 'id' => $submission->id
));
273 $btntxt = get_string('editsubmission', 'workshop');
275 $btnurl = new moodle_url($PAGE->url
, array('edit' => 'on'));
276 $btntxt = get_string('createsubmission', 'workshop');
278 echo $output->single_button($btnurl, $btntxt, 'get');
281 if ($submission->id
and !$edit and !$isreviewer and $canallocate and $workshop->assessing_allowed($USER->id
)) {
282 $url = new moodle_url($PAGE->url
, array('assess' => 1));
283 echo $output->single_button($url, get_string('assess', 'workshop'), 'post');
286 if (($workshop->phase
== workshop
::PHASE_CLOSED
) and ($ownsubmission or $canviewall)) {
287 if (!empty($submission->gradeoverby
) and strlen(trim($submission->feedbackauthor
)) > 0) {
288 echo $output->render(new workshop_feedback_author($submission));
292 // and possibly display the submission's review(s)
295 // user's own assessment
296 $strategy = $workshop->grading_strategy_instance();
297 $mform = $strategy->get_assessment_form($PAGE->url
, 'assessment', $userassessment, false);
299 'showreviewer' => true,
300 'showauthor' => $showauthor,
301 'showform' => !is_null($userassessment->grade
),
302 'showweight' => true,
304 $assessment = $workshop->prepare_assessment($userassessment, $mform, $options);
305 $assessment->title
= get_string('assessmentbyyourself', 'workshop');
307 if ($workshop->assessing_allowed($USER->id
)) {
308 if (is_null($userassessment->grade
)) {
309 $assessment->add_action($workshop->assess_url($assessment->id
), get_string('assess', 'workshop'));
311 $assessment->add_action($workshop->assess_url($assessment->id
), get_string('reassess', 'workshop'));
315 $assessment->add_action($workshop->assess_url($assessment->id
), get_string('assessmentsettings', 'workshop'));
318 echo $output->render($assessment);
320 if ($workshop->phase
== workshop
::PHASE_CLOSED
) {
321 if (strlen(trim($userassessment->feedbackreviewer
)) > 0) {
322 echo $output->render(new workshop_feedback_reviewer($userassessment));
327 if (has_capability('mod/workshop:viewallassessments', $workshop->context
) or ($ownsubmission and $workshop->assessments_available())) {
329 $strategy = $workshop->grading_strategy_instance();
330 $assessments = $workshop->get_assessments_of_submission($submission->id
);
331 $showreviewer = has_capability('mod/workshop:viewreviewernames', $workshop->context
);
332 foreach ($assessments as $assessment) {
333 if ($assessment->reviewerid
== $USER->id
) {
334 // own assessment has been displayed already
337 if (is_null($assessment->grade
) and !has_capability('mod/workshop:viewallassessments', $workshop->context
)) {
338 // students do not see peer-assessment that are not graded yet
341 $mform = $strategy->get_assessment_form($PAGE->url
, 'assessment', $assessment, false);
343 'showreviewer' => $showreviewer,
344 'showauthor' => $showauthor,
345 'showform' => !is_null($assessment->grade
),
346 'showweight' => true,
348 $displayassessment = $workshop->prepare_assessment($assessment, $mform, $options);
350 $displayassessment->add_action($workshop->assess_url($assessment->id
), get_string('assessmentsettings', 'workshop'));
352 echo $output->render($displayassessment);
354 if ($workshop->phase
== workshop
::PHASE_CLOSED
and has_capability('mod/workshop:viewallassessments', $workshop->context
)) {
355 if (strlen(trim($assessment->feedbackreviewer
)) > 0) {
356 echo $output->render(new workshop_feedback_reviewer($assessment));
362 if (!$edit and $canoverride) {
363 // display a form to override the submission grade
364 $feedbackform->display();
367 echo $output->footer();