[Summary view]

Differences Between: [Versions 39 and 400] [Versions 39 and 401] [Versions 39 and 402] [Versions 39 and 403]

   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              'workshop-viewlet-instructauthors-collapsed');
 198      echo $output->box(format_text($instructions, $workshop->instructauthorsformat, array('overflowdiv'=>true)), array('generalbox', 'instructions'));
 199      print_collapsible_region_end();
 200  }
 201  
 202  // if in edit mode, display the form to edit the submission
 203  
 204  if ($edit) {
 205      if (!empty($CFG->enableplagiarism)) {
 206          require_once($CFG->libdir.'/plagiarismlib.php');
 207          echo plagiarism_print_disclosure($cm->id);
 208      }
 209      $mform->display();
 210      echo $output->footer();
 211      die();
 212  }
 213  
 214  // Confirm deletion (if requested).
 215  if ($deletable and $delete) {
 216      $prompt = get_string('submissiondeleteconfirm', 'workshop');
 217      if ($candeleteall) {
 218          $count = count($workshop->get_assessments_of_submission($submission->id));
 219          if ($count > 0) {
 220              $prompt = get_string('submissiondeleteconfirmassess', 'workshop', ['count' => $count]);
 221          }
 222      }
 223      echo $output->confirm($prompt, new moodle_url($PAGE->url, ['delete' => 1, 'confirm' => 1]), $workshop->view_url());
 224  }
 225  
 226  // else display the submission
 227  
 228  if ($submission->id) {
 229      if ($seenaspublished) {
 230          $showauthor = has_capability('mod/workshop:viewauthorpublished', $workshop->context);
 231      } else {
 232          $showauthor = has_capability('mod/workshop:viewauthornames', $workshop->context);
 233      }
 234      echo $output->render($workshop->prepare_submission($submission, $showauthor));
 235  } else {
 236      echo $output->box(get_string('noyoursubmission', 'workshop'));
 237  }
 238  
 239  // If not at removal confirmation screen, some action buttons can be displayed.
 240  if (!$delete) {
 241      // Display create/edit button.
 242      if ($editable) {
 243          if ($submission->id) {
 244              $btnurl = new moodle_url($PAGE->url, array('edit' => 'on', 'id' => $submission->id));
 245              $btntxt = get_string('editsubmission', 'workshop');
 246          } else {
 247              $btnurl = new moodle_url($PAGE->url, array('edit' => 'on'));
 248              $btntxt = get_string('createsubmission', 'workshop');
 249          }
 250          echo $output->single_button($btnurl, $btntxt, 'get');
 251      }
 252  
 253      // Display delete button.
 254      if ($submission->id and $deletable) {
 255          $url = new moodle_url($PAGE->url, array('delete' => 1));
 256          echo $output->single_button($url, get_string('deletesubmission', 'workshop'), 'get');
 257      }
 258  
 259      // Display assess button.
 260      if ($submission->id and !$edit and !$isreviewer and $canallocate and $workshop->assessing_allowed($USER->id)) {
 261          $url = new moodle_url($PAGE->url, array('assess' => 1));
 262          echo $output->single_button($url, get_string('assess', 'workshop'), 'post');
 263      }
 264  }
 265  
 266  if (($workshop->phase == workshop::PHASE_CLOSED) and ($ownsubmission or $canviewall)) {
 267      if (!empty($submission->gradeoverby) and strlen(trim($submission->feedbackauthor)) > 0) {
 268          echo $output->render(new workshop_feedback_author($submission));
 269      }
 270  }
 271  
 272  // and possibly display the submission's review(s)
 273  
 274  if ($isreviewer) {
 275      // user's own assessment
 276      $strategy   = $workshop->grading_strategy_instance();
 277      $mform      = $strategy->get_assessment_form($PAGE->url, 'assessment', $userassessment, false);
 278      $options    = array(
 279          'showreviewer'  => true,
 280          'showauthor'    => $showauthor,
 281          'showform'      => !is_null($userassessment->grade),
 282          'showweight'    => true,
 283      );
 284      $assessment = $workshop->prepare_assessment($userassessment, $mform, $options);
 285      $assessment->title = get_string('assessmentbyyourself', 'workshop');
 286  
 287      if ($workshop->assessing_allowed($USER->id)) {
 288          if (is_null($userassessment->grade)) {
 289              $assessment->add_action($workshop->assess_url($assessment->id), get_string('assess', 'workshop'));
 290          } else {
 291              $assessment->add_action($workshop->assess_url($assessment->id), get_string('reassess', 'workshop'));
 292          }
 293      }
 294      if ($canoverride) {
 295          $assessment->add_action($workshop->assess_url($assessment->id), get_string('assessmentsettings', 'workshop'));
 296      }
 297  
 298      echo $output->render($assessment);
 299  
 300      if ($workshop->phase == workshop::PHASE_CLOSED) {
 301          if (strlen(trim($userassessment->feedbackreviewer)) > 0) {
 302              echo $output->render(new workshop_feedback_reviewer($userassessment));
 303          }
 304      }
 305  }
 306  
 307  if (has_capability('mod/workshop:viewallassessments', $workshop->context) or ($ownsubmission and $workshop->assessments_available())) {
 308      // other assessments
 309      $strategy       = $workshop->grading_strategy_instance();
 310      $assessments    = $workshop->get_assessments_of_submission($submission->id);
 311      $showreviewer   = has_capability('mod/workshop:viewreviewernames', $workshop->context);
 312      foreach ($assessments as $assessment) {
 313          if ($assessment->reviewerid == $USER->id) {
 314              // own assessment has been displayed already
 315              continue;
 316          }
 317          if (is_null($assessment->grade) and !has_capability('mod/workshop:viewallassessments', $workshop->context)) {
 318              // students do not see peer-assessment that are not graded yet
 319              continue;
 320          }
 321          $mform      = $strategy->get_assessment_form($PAGE->url, 'assessment', $assessment, false);
 322          $options    = array(
 323              'showreviewer'  => $showreviewer,
 324              'showauthor'    => $showauthor,
 325              'showform'      => !is_null($assessment->grade),
 326              'showweight'    => true,
 327          );
 328          $displayassessment = $workshop->prepare_assessment($assessment, $mform, $options);
 329          if ($canoverride) {
 330              $displayassessment->add_action($workshop->assess_url($assessment->id), get_string('assessmentsettings', 'workshop'));
 331          }
 332          echo $output->render($displayassessment);
 333  
 334          if ($workshop->phase == workshop::PHASE_CLOSED and has_capability('mod/workshop:viewallassessments', $workshop->context)) {
 335              if (strlen(trim($assessment->feedbackreviewer)) > 0) {
 336                  echo $output->render(new workshop_feedback_reviewer($assessment));
 337              }
 338          }
 339      }
 340  }
 341  
 342  if (!$edit and $canoverride) {
 343      // display a form to override the submission grade
 344      $feedbackform->display();
 345  }
 346  
 347  // If portfolios are enabled and we are not on the edit/removal confirmation screen, display a button to export this page.
 348  // The export is not offered if the submission is seen as a published one (it has no relation to the current user.
 349  if (!empty($CFG->enableportfolios)) {
 350      if (!$delete and !$edit and !$seenaspublished and $submission->id and ($ownsubmission or $canviewall or $isreviewer)) {
 351          if (has_capability('mod/workshop:exportsubmissions', $workshop->context)) {
 352              require_once($CFG->libdir.'/portfoliolib.php');
 353  
 354              $button = new portfolio_add_button();
 355              $button->set_callback_options('mod_workshop_portfolio_caller', array(
 356                  'id' => $workshop->cm->id,
 357                  'submissionid' => $submission->id,
 358              ), 'mod_workshop');
 359              $button->set_formats(PORTFOLIO_FORMAT_RICHHTML);
 360              echo html_writer::start_tag('div', array('class' => 'singlebutton'));
 361              echo $button->to_html(PORTFOLIO_ADD_FULL_FORM, get_string('exportsubmission', 'workshop'));
 362              echo html_writer::end_tag('div');
 363          }
 364      }
 365  }
 366  
 367  echo $output->footer();