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/>.
  16
  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  */
  24
  25 require(__DIR__.'/../../config.php');
  26 require_once(__DIR__.'/locallib.php');
  27
  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.
  34
  35 $cm = get_coursemodule_from_id('workshop', $cmid, 0, false, MUST_EXIST);
  36 $course = $DB->get_record('course', array('id' => $cm->course), '*', MUST_EXIST);
  37
  38 require_login($course, false, $cm);
  39 if (isguestuser()) {
  40     print_error('guestsarenotallowed');
  41 }
  42
  43 $workshoprecord = $DB->get_record('workshop', array('id' => $cm->instance), '*', MUST_EXIST);
  44 $workshop = new workshop($workshoprecord, $cm, $course);
  45
  46 $PAGE->set_url($workshop->submission_url(), array('cmid' => $cmid, 'id' => $id));
  47
  48 if ($edit) {
  49     $PAGE->url->param('edit', $edit);
  50 }
  51
  52 if ($id) { // submission is specified
  53     $submission = $workshop->get_submission_by_id($id);
  54
  55 } else { // no submission specified
  56     if (!$submission = $workshop->get_submission_by_author($USER->id)) {
  57         $submission = new stdclass();
  58         $submission->id = null;
  59         $submission->authorid = $USER->id;
  60         $submission->example = 0;
  61         $submission->grade = null;
  62         $submission->gradeover = null;
  63         $submission->published = null;
  64         $submission->feedbackauthor = null;
  65         $submission->feedbackauthorformat = editors_get_preferred_format();
  66     }
  67 }
  68
  69 $ownsubmission  = $submission->authorid == $USER->id;
  70 $canviewall     = has_capability('mod/workshop:viewallsubmissions', $workshop->context);
  71 $cansubmit      = has_capability('mod/workshop:submit', $workshop->context);
  72 $canallocate    = has_capability('mod/workshop:allocate', $workshop->context);
  73 $canpublish     = has_capability('mod/workshop:publishsubmissions', $workshop->context);
  74 $canoverride    = (($workshop->phase == workshop::PHASE_EVALUATION) and has_capability('mod/workshop:overridegrades', $workshop->context));
  75 $candeleteall   = has_capability('mod/workshop:deletesubmissions', $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 $deletable      = $candeleteall;
  80 $ispublished    = ($workshop->phase == workshop::PHASE_CLOSED
  81                     and $submission->published == 1
  82                     and has_capability('mod/workshop:viewpublishedsubmissions', $workshop->context));
  83
  84 if (empty($submission->id) and !$workshop->creating_submission_allowed($USER->id)) {
  85     $editable = false;
  86 }
  87 if ($submission->id and !$workshop->modifying_submission_allowed($USER->id)) {
  88     $editable = false;
  89 }
  90
  91 $canviewall = $canviewall && $workshop->check_group_membership($submission->authorid);
  92
  93 $editable = ($editable && $workshop->check_examples_assessed_before_submission($USER->id));
  94 $edit = ($editable and $edit);
  95
  96 if (!$candeleteall and $ownsubmission and $editable) {
  97     // Only allow the student to delete their own submission if it's still editable and hasn't been assessed.
  98     if (count($workshop->get_assessments_of_submission($submission->id)) > 0) {
  99         $deletable = false;
 100     } else {
 101         $deletable = true;
 102     }
 103 }
 104
 105 if ($submission->id and $delete and $confirm and $deletable) {
 106     require_sesskey();
 107     $workshop->delete_submission($submission);
 108
 109     redirect($workshop->view_url());
 110 }
 111
 112 $seenaspublished = false; // is the submission seen as a published submission?
 113
 114 if ($submission->id and ($ownsubmission or $canviewall or $isreviewer)) {
 115     // ok you can go
 116 } elseif ($submission->id and $ispublished) {
 117     // ok you can go
 118     $seenaspublished = true;
 119 } elseif (is_null($submission->id) and $cansubmit) {
 120     // ok you can go
 121 } else {
 122     print_error('nopermissions', 'error', $workshop->view_url(), 'view or create submission');
 123 }
 124
 125 if ($submission->id) {
 126     // Trigger submission viewed event.
 127     $workshop->set_submission_viewed($submission);
 128 }
 129
 130 if ($assess and $submission->id and !$isreviewer and $canallocate and $workshop->assessing_allowed($USER->id)) {
 131     require_sesskey();
 132     $assessmentid = $workshop->add_allocation($submission, $USER->id);
 133     redirect($workshop->assess_url($assessmentid));
 134 }
 135
 136 if ($edit) {
 137     require_once(__DIR__.'/submission_form.php');
 138
 139     $submission = file_prepare_standard_editor($submission, 'content', $workshop->submission_content_options(),
 140         $workshop->context, 'mod_workshop', 'submission_content', $submission->id);
 141
 142     $submission = file_prepare_standard_filemanager($submission, 'attachment', $workshop->submission_attachment_options(),
 143         $workshop->context, 'mod_workshop', 'submission_attachment', $submission->id);
 144
 145     $mform = new workshop_submission_form($PAGE->url, array('current' => $submission, 'workshop' => $workshop,
 146         'contentopts' => $workshop->submission_content_options(), 'attachmentopts' => $workshop->submission_attachment_options()));
 147
 148     if ($mform->is_cancelled()) {
 149         redirect($workshop->view_url());
 150
 151     } elseif ($cansubmit and $formdata = $mform->get_data()) {
 152
 153         $formdata->id = $submission->id;
 154         // Creates or updates submission.
 155         $submission->id = $workshop->edit_submission($formdata);
 156
 157         redirect($workshop->submission_url($submission->id));
 158     }
 159 }
 160
 161 // load the form to override grade and/or publish the submission and process the submitted data eventually
 162 if (!$edit and ($canoverride or $canpublish)) {
 163     $options = array(
 164         'editable' => true,
 165         'editablepublished' => $canpublish,
 166         'overridablegrade' => $canoverride);
 167     $feedbackform = $workshop->get_feedbackauthor_form($PAGE->url, $submission, $options);
 168     if ($data = $feedbackform->get_data()) {
 169         $workshop->evaluate_submission($submission, $data, $canpublish, $canoverride);
 170         redirect($workshop->view_url());
 171     }
 172 }
 173
 174 $PAGE->set_title($workshop->name);
 175 $PAGE->set_heading($course->fullname);
 176 if ($edit) {
 177     $PAGE->navbar->add(get_string('mysubmission', 'workshop'), $workshop->submission_url(), navigation_node::TYPE_CUSTOM);
 178     $PAGE->navbar->add(get_string('editingsubmission', 'workshop'));
 179 } elseif ($ownsubmission) {
 180     $PAGE->navbar->add(get_string('mysubmission', 'workshop'));
 181 } else {
 182     $PAGE->navbar->add(get_string('submission', 'workshop'));
 183 }
 184
 185 // Output starts here
 186 $output = $PAGE->get_renderer('mod_workshop');
 187 echo $output->header();
 188 echo $output->heading(format_string($workshop->name), 2);
 189 echo $output->heading(get_string('mysubmission', 'workshop'), 3);
 190
 191 // show instructions for submitting as thay may contain some list of questions and we need to know them
 192 // while reading the submitted answer
 193 if (trim($workshop->instructauthors)) {
 194     $instructions = file_rewrite_pluginfile_urls($workshop->instructauthors, 'pluginfile.php', $PAGE->context->id,
 195         'mod_workshop', 'instructauthors', null, workshop::instruction_editors_options($PAGE->context));
 196     print_collapsible_region_start('', 'workshop-viewlet-instructauthors', get_string('instructauthors', 'workshop'));
 197     echo $output->box(format_text($instructions, $workshop->instructauthorsformat, array('overflowdiv'=>true)), array('generalbox', 'instructions'));
 198     print_collapsible_region_end();
 199 }
 200
 201 // if in edit mode, display the form to edit the submission
 202
 203 if ($edit) {
 204     if (!empty($CFG->enableplagiarism)) {
 205         require_once($CFG->libdir.'/plagiarismlib.php');
 206         echo plagiarism_print_disclosure($cm->id);
 207     }
 208     $mform->display();
 209     echo $output->footer();
 210     die();
 211 }
 212
 213 // Confirm deletion (if requested).
 214 if ($deletable and $delete) {
 215     $prompt = get_string('submissiondeleteconfirm', 'workshop');
 216     if ($candeleteall) {
 217         $count = count($workshop->get_assessments_of_submission($submission->id));
 218         if ($count > 0) {
 219             $prompt = get_string('submissiondeleteconfirmassess', 'workshop', ['count' => $count]);
 220         }
 221     }
 222     echo $output->confirm($prompt, new moodle_url($PAGE->url, ['delete' => 1, 'confirm' => 1]), $workshop->view_url());
 223 }
 224
 225 // else display the submission
 226
 227 if ($submission->id) {
 228     if ($seenaspublished) {
 229         $showauthor = has_capability('mod/workshop:viewauthorpublished', $workshop->context);
 230     } else {
 231         $showauthor = has_capability('mod/workshop:viewauthornames', $workshop->context);
 232     }
 233     echo $output->render($workshop->prepare_submission($submission, $showauthor));
 234 } else {
 235     echo $output->box(get_string('noyoursubmission', 'workshop'));
 236 }
 237
 238 // If not at removal confirmation screen, some action buttons can be displayed.
 239 if (!$delete) {
 240     // Display create/edit button.
 241     if ($editable) {
 242         if ($submission->id) {
 243             $btnurl = new moodle_url($PAGE->url, array('edit' => 'on', 'id' => $submission->id));
 244             $btntxt = get_string('editsubmission', 'workshop');
 245         } else {
 246             $btnurl = new moodle_url($PAGE->url, array('edit' => 'on'));
 247             $btntxt = get_string('createsubmission', 'workshop');
 248         }
 249         echo $output->single_button($btnurl, $btntxt, 'get');
 250     }
 251
 252     // Display delete button.
 253     if ($submission->id and $deletable) {
 254         $url = new moodle_url($PAGE->url, array('delete' => 1));
 255         echo $output->single_button($url, get_string('deletesubmission', 'workshop'), 'get');
 256     }
 257
 258     // Display assess button.
 259     if ($submission->id and !$edit and !$isreviewer and $canallocate and $workshop->assessing_allowed($USER->id)) {
 260         $url = new moodle_url($PAGE->url, array('assess' => 1));
 261         echo $output->single_button($url, get_string('assess', 'workshop'), 'post');
 262     }
 263 }
 264
 265 if (($workshop->phase == workshop::PHASE_CLOSED) and ($ownsubmission or $canviewall)) {
 266     if (!empty($submission->gradeoverby) and strlen(trim($submission->feedbackauthor)) > 0) {
 267         echo $output->render(new workshop_feedback_author($submission));
 268     }
 269 }
 270
 271 // and possibly display the submission's review(s)
 272
 273 if ($isreviewer) {
 274     // user's own assessment
 275     $strategy   = $workshop->grading_strategy_instance();
 276     $mform      = $strategy->get_assessment_form($PAGE->url, 'assessment', $userassessment, false);
 277     $options    = array(
 278         'showreviewer'  => true,
 279         'showauthor'    => $showauthor,
 280         'showform'      => !is_null($userassessment->grade),
 281         'showweight'    => true,
 282     );
 283     $assessment = $workshop->prepare_assessment($userassessment, $mform, $options);
 284     $assessment->title = get_string('assessmentbyyourself', 'workshop');
 285
 286     if ($workshop->assessing_allowed($USER->id)) {
 287         if (is_null($userassessment->grade)) {
 288             $assessment->add_action($workshop->assess_url($assessment->id), get_string('assess', 'workshop'));
 289         } else {
 290             $assessment->add_action($workshop->assess_url($assessment->id), get_string('reassess', 'workshop'));
 291         }
 292     }
 293     if ($canoverride) {
 294         $assessment->add_action($workshop->assess_url($assessment->id), get_string('assessmentsettings', 'workshop'));
 295     }
 296
 297     echo $output->render($assessment);
 298
 299     if ($workshop->phase == workshop::PHASE_CLOSED) {
 300         if (strlen(trim($userassessment->feedbackreviewer)) > 0) {
 301             echo $output->render(new workshop_feedback_reviewer($userassessment));
 302         }
 303     }
 304 }
 305
 306 if (has_capability('mod/workshop:viewallassessments', $workshop->context) or ($ownsubmission and $workshop->assessments_available())) {
 307     // other assessments
 308     $strategy       = $workshop->grading_strategy_instance();
 309     $assessments    = $workshop->get_assessments_of_submission($submission->id);
 310     $showreviewer   = has_capability('mod/workshop:viewreviewernames', $workshop->context);
 311     foreach ($assessments as $assessment) {
 312         if ($assessment->reviewerid == $USER->id) {
 313             // own assessment has been displayed already
 314             continue;
 315         }
 316         if (is_null($assessment->grade) and !has_capability('mod/workshop:viewallassessments', $workshop->context)) {
 317             // students do not see peer-assessment that are not graded yet
 318             continue;
 319         }
 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         $displayassessment = $workshop->prepare_assessment($assessment, $mform, $options);
 328         if ($canoverride) {
 329             $displayassessment->add_action($workshop->assess_url($assessment->id), get_string('assessmentsettings', 'workshop'));
 330         }
 331         echo $output->render($displayassessment);
 332
 333         if ($workshop->phase == workshop::PHASE_CLOSED and has_capability('mod/workshop:viewallassessments', $workshop->context)) {
 334             if (strlen(trim($assessment->feedbackreviewer)) > 0) {
 335                 echo $output->render(new workshop_feedback_reviewer($assessment));
 336             }
 337         }
 338     }
 339 }
 340
 341 if (!$edit and $canoverride) {
 342     // display a form to override the submission grade
 343     $feedbackform->display();
 344 }
 345
 346 // If portfolios are enabled and we are not on the edit/removal confirmation screen, display a button to export this page.
 347 // The export is not offered if the submission is seen as a published one (it has no relation to the current user.
 348 if (!empty($CFG->enableportfolios)) {
 349     if (!$delete and !$edit and !$seenaspublished and $submission->id and ($ownsubmission or $canviewall or $isreviewer)) {
 350         if (has_capability('mod/workshop:exportsubmissions', $workshop->context)) {
 351             require_once($CFG->libdir.'/portfoliolib.php');
 352
 353             $button = new portfolio_add_button();
 354             $button->set_callback_options('mod_workshop_portfolio_caller', array(
 355                 'id' => $workshop->cm->id,
 356                 'submissionid' => $submission->id,
 357             ), 'mod_workshop');
 358             $button->set_formats(PORTFOLIO_FORMAT_RICHHTML);
 359             echo html_writer::start_tag('div', array('class' => 'singlebutton'));
 360             echo $button->to_html(PORTFOLIO_ADD_FULL_FORM, get_string('exportsubmission', 'workshop'));
 361             echo html_writer::end_tag('div');
 362         }
 363     }
 364 }
 365
 366 echo $output->footer();