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     $params = array(
  56         'objectid' => $submission->id,
  57         'context' => $workshop->context,
  58         'courseid' => $workshop->course->id,
  59         'relateduserid' => $submission->authorid,
  60         'other' => array(
  61             'workshopid' => $workshop->id
  62         )
  63     );
  64
  65     $event = \mod_workshop\event\submission_viewed::create($params);
  66     $event->trigger();
  67
  68 } else { // no submission specified
  69     if (!$submission = $workshop->get_submission_by_author($USER->id)) {
  70         $submission = new stdclass();
  71         $submission->id = null;
  72         $submission->authorid = $USER->id;
  73         $submission->example = 0;
  74         $submission->grade = null;
  75         $submission->gradeover = null;
  76         $submission->published = null;
  77         $submission->feedbackauthor = null;
  78         $submission->feedbackauthorformat = editors_get_preferred_format();
  79     }
  80 }
  81
  82 $ownsubmission  = $submission->authorid == $USER->id;
  83 $canviewall     = has_capability('mod/workshop:viewallsubmissions', $workshop->context);
  84 $cansubmit      = has_capability('mod/workshop:submit', $workshop->context);
  85 $canallocate    = has_capability('mod/workshop:allocate', $workshop->context);
  86 $canpublish     = has_capability('mod/workshop:publishsubmissions', $workshop->context);
  87 $canoverride    = (($workshop->phase == workshop::PHASE_EVALUATION) and has_capability('mod/workshop:overridegrades', $workshop->context));
  88 $candeleteall   = has_capability('mod/workshop:deletesubmissions', $workshop->context);
  89 $userassessment = $workshop->get_assessment_of_submission_by_user($submission->id, $USER->id);
  90 $isreviewer     = !empty($userassessment);
  91 $editable       = ($cansubmit and $ownsubmission);
  92 $deletable      = $candeleteall;
  93 $ispublished    = ($workshop->phase == workshop::PHASE_CLOSED
  94                     and $submission->published == 1
  95                     and has_capability('mod/workshop:viewpublishedsubmissions', $workshop->context));
  96
  97 if (empty($submission->id) and !$workshop->creating_submission_allowed($USER->id)) {
  98     $editable = false;
  99 }
 100 if ($submission->id and !$workshop->modifying_submission_allowed($USER->id)) {
 101     $editable = false;
 102 }
 103
 104 $canviewall = $canviewall && $workshop->check_group_membership($submission->authorid);
 105
 106 if ($editable and $workshop->useexamples and $workshop->examplesmode == workshop::EXAMPLES_BEFORE_SUBMISSION
 107         and !has_capability('mod/workshop:manageexamples', $workshop->context)) {
 108     // check that all required examples have been assessed by the user
 109     $examples = $workshop->get_examples_for_reviewer($USER->id);
 110     foreach ($examples as $exampleid => $example) {
 111         if (is_null($example->grade)) {
 112             $editable = false;
 113             break;
 114         }
 115     }
 116 }
 117 $edit = ($editable and $edit);
 118
 119 if (!$candeleteall and $ownsubmission and $editable) {
 120     // Only allow the student to delete their own submission if it's still editable and hasn't been assessed.
 121     if (count($workshop->get_assessments_of_submission($submission->id)) > 0) {
 122         $deletable = false;
 123     } else {
 124         $deletable = true;
 125     }
 126 }
 127
 128 if ($submission->id and $delete and $confirm and $deletable) {
 129     require_sesskey();
 130     $workshop->delete_submission($submission);
 131
 132     // Event information.
 133     $params = array(
 134         'context' => $workshop->context,
 135         'courseid' => $workshop->course->id,
 136         'relateduserid' => $submission->authorid,
 137         'other' => array(
 138             'submissiontitle' => $submission->title
 139         )
 140     );
 141     $params['objectid'] = $submission->id;
 142     $event = \mod_workshop\event\submission_deleted::create($params);
 143     $event->add_record_snapshot('workshop', $workshoprecord);
 144     $event->trigger();
 145
 146     redirect($workshop->view_url());
 147 }
 148
 149 $seenaspublished = false; // is the submission seen as a published submission?
 150
 151 if ($submission->id and ($ownsubmission or $canviewall or $isreviewer)) {
 152     // ok you can go
 153 } elseif ($submission->id and $ispublished) {
 154     // ok you can go
 155     $seenaspublished = true;
 156 } elseif (is_null($submission->id) and $cansubmit) {
 157     // ok you can go
 158 } else {
 159     print_error('nopermissions', 'error', $workshop->view_url(), 'view or create submission');
 160 }
 161
 162 if ($assess and $submission->id and !$isreviewer and $canallocate and $workshop->assessing_allowed($USER->id)) {
 163     require_sesskey();
 164     $assessmentid = $workshop->add_allocation($submission, $USER->id);
 165     redirect($workshop->assess_url($assessmentid));
 166 }
 167
 168 if ($edit) {
 169     require_once(__DIR__.'/submission_form.php');
 170
 171     $submission = file_prepare_standard_editor($submission, 'content', $workshop->submission_content_options(),
 172         $workshop->context, 'mod_workshop', 'submission_content', $submission->id);
 173
 174     $submission = file_prepare_standard_filemanager($submission, 'attachment', $workshop->submission_attachment_options(),
 175         $workshop->context, 'mod_workshop', 'submission_attachment', $submission->id);
 176
 177     $mform = new workshop_submission_form($PAGE->url, array('current' => $submission, 'workshop' => $workshop,
 178         'contentopts' => $workshop->submission_content_options(), 'attachmentopts' => $workshop->submission_attachment_options()));
 179
 180     if ($mform->is_cancelled()) {
 181         redirect($workshop->view_url());
 182
 183     } elseif ($cansubmit and $formdata = $mform->get_data()) {
 184         if ($formdata->example == 0) {
 185             // this was used just for validation, it must be set to zero when dealing with normal submissions
 186             unset($formdata->example);
 187         } else {
 188             throw new coding_exception('Invalid submission form data value: example');
 189         }
 190         $timenow = time();
 191         if (is_null($submission->id)) {
 192             $formdata->workshopid     = $workshop->id;
 193             $formdata->example        = 0;
 194             $formdata->authorid       = $USER->id;
 195             $formdata->timecreated    = $timenow;
 196             $formdata->feedbackauthorformat = editors_get_preferred_format();
 197         }
 198         $formdata->timemodified       = $timenow;
 199         $formdata->title              = trim($formdata->title);
 200         $formdata->content            = '';          // updated later
 201         $formdata->contentformat      = FORMAT_HTML; // updated later
 202         $formdata->contenttrust       = 0;           // updated later
 203         $formdata->late               = 0x0;         // bit mask
 204         if (!empty($workshop->submissionend) and ($workshop->submissionend < time())) {
 205             $formdata->late = $formdata->late | 0x1;
 206         }
 207         if ($workshop->phase == workshop::PHASE_ASSESSMENT) {
 208             $formdata->late = $formdata->late | 0x2;
 209         }
 210
 211         // Event information.
 212         $params = array(
 213             'context' => $workshop->context,
 214             'courseid' => $workshop->course->id,
 215             'other' => array(
 216                 'submissiontitle' => $formdata->title
 217             )
 218         );
 219         $logdata = null;
 220         if (is_null($submission->id)) {
 221             $submission->id = $formdata->id = $DB->insert_record('workshop_submissions', $formdata);
 222             $params['objectid'] = $submission->id;
 223             $event = \mod_workshop\event\submission_created::create($params);
 224             $event->trigger();
 225         } else {
 226             if (empty($formdata->id) or empty($submission->id) or ($formdata->id != $submission->id)) {
 227                 throw new moodle_exception('err_submissionid', 'workshop');
 228             }
 229         }
 230         $params['objectid'] = $submission->id;
 231
 232         // Save and relink embedded images and save attachments.
 233         $formdata = file_postupdate_standard_editor($formdata, 'content', $workshop->submission_content_options(),
 234             $workshop->context, 'mod_workshop', 'submission_content', $submission->id);
 235
 236         $formdata = file_postupdate_standard_filemanager($formdata, 'attachment', $workshop->submission_attachment_options(),
 237             $workshop->context, 'mod_workshop', 'submission_attachment', $submission->id);
 238
 239         if (empty($formdata->attachment)) {
 240             // explicit cast to zero integer
 241             $formdata->attachment = 0;
 242         }
 243         // store the updated values or re-save the new submission (re-saving needed because URLs are now rewritten)
 244         $DB->update_record('workshop_submissions', $formdata);
 245         $event = \mod_workshop\event\submission_updated::create($params);
 246         $event->add_record_snapshot('workshop', $workshoprecord);
 247         $event->trigger();
 248
 249         // send submitted content for plagiarism detection
 250         $fs = get_file_storage();
 251         $files = $fs->get_area_files($workshop->context->id, 'mod_workshop', 'submission_attachment', $submission->id);
 252
 253         $params['other']['content'] = $formdata->content;
 254         $params['other']['pathnamehashes'] = array_keys($files);
 255
 256         $event = \mod_workshop\event\assessable_uploaded::create($params);
 257         $event->set_legacy_logdata($logdata);
 258         $event->trigger();
 259
 260         redirect($workshop->submission_url($formdata->id));
 261     }
 262 }
 263
 264 // load the form to override grade and/or publish the submission and process the submitted data eventually
 265 if (!$edit and ($canoverride or $canpublish)) {
 266     $options = array(
 267         'editable' => true,
 268         'editablepublished' => $canpublish,
 269         'overridablegrade' => $canoverride);
 270     $feedbackform = $workshop->get_feedbackauthor_form($PAGE->url, $submission, $options);
 271     if ($data = $feedbackform->get_data()) {
 272         $data = file_postupdate_standard_editor($data, 'feedbackauthor', array(), $workshop->context);
 273         $record = new stdclass();
 274         $record->id = $submission->id;
 275         if ($canoverride) {
 276             $record->gradeover = $workshop->raw_grade_value($data->gradeover, $workshop->grade);
 277             $record->gradeoverby = $USER->id;
 278             $record->feedbackauthor = $data->feedbackauthor;
 279             $record->feedbackauthorformat = $data->feedbackauthorformat;
 280         }
 281         if ($canpublish) {
 282             $record->published = !empty($data->published);
 283         }
 284         $DB->update_record('workshop_submissions', $record);
 285         redirect($workshop->view_url());
 286     }
 287 }
 288
 289 $PAGE->set_title($workshop->name);
 290 $PAGE->set_heading($course->fullname);
 291 if ($edit) {
 292     $PAGE->navbar->add(get_string('mysubmission', 'workshop'), $workshop->submission_url(), navigation_node::TYPE_CUSTOM);
 293     $PAGE->navbar->add(get_string('editingsubmission', 'workshop'));
 294 } elseif ($ownsubmission) {
 295     $PAGE->navbar->add(get_string('mysubmission', 'workshop'));
 296 } else {
 297     $PAGE->navbar->add(get_string('submission', 'workshop'));
 298 }
 299
 300 // Output starts here
 301 $output = $PAGE->get_renderer('mod_workshop');
 302 echo $output->header();
 303 echo $output->heading(format_string($workshop->name), 2);
 304 echo $output->heading(get_string('mysubmission', 'workshop'), 3);
 305
 306 // show instructions for submitting as thay may contain some list of questions and we need to know them
 307 // while reading the submitted answer
 308 if (trim($workshop->instructauthors)) {
 309     $instructions = file_rewrite_pluginfile_urls($workshop->instructauthors, 'pluginfile.php', $PAGE->context->id,
 310         'mod_workshop', 'instructauthors', null, workshop::instruction_editors_options($PAGE->context));
 311     print_collapsible_region_start('', 'workshop-viewlet-instructauthors', get_string('instructauthors', 'workshop'));
 312     echo $output->box(format_text($instructions, $workshop->instructauthorsformat, array('overflowdiv'=>true)), array('generalbox', 'instructions'));
 313     print_collapsible_region_end();
 314 }
 315
 316 // if in edit mode, display the form to edit the submission
 317
 318 if ($edit) {
 319     if (!empty($CFG->enableplagiarism)) {
 320         require_once($CFG->libdir.'/plagiarismlib.php');
 321         echo plagiarism_print_disclosure($cm->id);
 322     }
 323     $mform->display();
 324     echo $output->footer();
 325     die();
 326 }
 327
 328 // Confirm deletion (if requested).
 329 if ($deletable and $delete) {
 330     $prompt = get_string('submissiondeleteconfirm', 'workshop');
 331     if ($candeleteall) {
 332         $count = count($workshop->get_assessments_of_submission($submission->id));
 333         if ($count > 0) {
 334             $prompt = get_string('submissiondeleteconfirmassess', 'workshop', ['count' => $count]);
 335         }
 336     }
 337     echo $output->confirm($prompt, new moodle_url($PAGE->url, ['delete' => 1, 'confirm' => 1]), $workshop->view_url());
 338 }
 339
 340 // else display the submission
 341
 342 if ($submission->id) {
 343     if ($seenaspublished) {
 344         $showauthor = has_capability('mod/workshop:viewauthorpublished', $workshop->context);
 345     } else {
 346         $showauthor = has_capability('mod/workshop:viewauthornames', $workshop->context);
 347     }
 348     echo $output->render($workshop->prepare_submission($submission, $showauthor));
 349 } else {
 350     echo $output->box(get_string('noyoursubmission', 'workshop'));
 351 }
 352
 353 // If not at removal confirmation screen, some action buttons can be displayed.
 354 if (!$delete) {
 355     // Display create/edit button.
 356     if ($editable) {
 357         if ($submission->id) {
 358             $btnurl = new moodle_url($PAGE->url, array('edit' => 'on', 'id' => $submission->id));
 359             $btntxt = get_string('editsubmission', 'workshop');
 360         } else {
 361             $btnurl = new moodle_url($PAGE->url, array('edit' => 'on'));
 362             $btntxt = get_string('createsubmission', 'workshop');
 363         }
 364         echo $output->single_button($btnurl, $btntxt, 'get');
 365     }
 366
 367     // Display delete button.
 368     if ($submission->id and $deletable) {
 369         $url = new moodle_url($PAGE->url, array('delete' => 1));
 370         echo $output->single_button($url, get_string('deletesubmission', 'workshop'), 'get');
 371     }
 372
 373     // Display assess button.
 374     if ($submission->id and !$edit and !$isreviewer and $canallocate and $workshop->assessing_allowed($USER->id)) {
 375         $url = new moodle_url($PAGE->url, array('assess' => 1));
 376         echo $output->single_button($url, get_string('assess', 'workshop'), 'post');
 377     }
 378 }
 379
 380 if (($workshop->phase == workshop::PHASE_CLOSED) and ($ownsubmission or $canviewall)) {
 381     if (!empty($submission->gradeoverby) and strlen(trim($submission->feedbackauthor)) > 0) {
 382         echo $output->render(new workshop_feedback_author($submission));
 383     }
 384 }
 385
 386 // and possibly display the submission's review(s)
 387
 388 if ($isreviewer) {
 389     // user's own assessment
 390     $strategy   = $workshop->grading_strategy_instance();
 391     $mform      = $strategy->get_assessment_form($PAGE->url, 'assessment', $userassessment, false);
 392     $options    = array(
 393         'showreviewer'  => true,
 394         'showauthor'    => $showauthor,
 395         'showform'      => !is_null($userassessment->grade),
 396         'showweight'    => true,
 397     );
 398     $assessment = $workshop->prepare_assessment($userassessment, $mform, $options);
 399     $assessment->title = get_string('assessmentbyyourself', 'workshop');
 400
 401     if ($workshop->assessing_allowed($USER->id)) {
 402         if (is_null($userassessment->grade)) {
 403             $assessment->add_action($workshop->assess_url($assessment->id), get_string('assess', 'workshop'));
 404         } else {
 405             $assessment->add_action($workshop->assess_url($assessment->id), get_string('reassess', 'workshop'));
 406         }
 407     }
 408     if ($canoverride) {
 409         $assessment->add_action($workshop->assess_url($assessment->id), get_string('assessmentsettings', 'workshop'));
 410     }
 411
 412     echo $output->render($assessment);
 413
 414     if ($workshop->phase == workshop::PHASE_CLOSED) {
 415         if (strlen(trim($userassessment->feedbackreviewer)) > 0) {
 416             echo $output->render(new workshop_feedback_reviewer($userassessment));
 417         }
 418     }
 419 }
 420
 421 if (has_capability('mod/workshop:viewallassessments', $workshop->context) or ($ownsubmission and $workshop->assessments_available())) {
 422     // other assessments
 423     $strategy       = $workshop->grading_strategy_instance();
 424     $assessments    = $workshop->get_assessments_of_submission($submission->id);
 425     $showreviewer   = has_capability('mod/workshop:viewreviewernames', $workshop->context);
 426     foreach ($assessments as $assessment) {
 427         if ($assessment->reviewerid == $USER->id) {
 428             // own assessment has been displayed already
 429             continue;
 430         }
 431         if (is_null($assessment->grade) and !has_capability('mod/workshop:viewallassessments', $workshop->context)) {
 432             // students do not see peer-assessment that are not graded yet
 433             continue;
 434         }
 435         $mform      = $strategy->get_assessment_form($PAGE->url, 'assessment', $assessment, false);
 436         $options    = array(
 437             'showreviewer'  => $showreviewer,
 438             'showauthor'    => $showauthor,
 439             'showform'      => !is_null($assessment->grade),
 440             'showweight'    => true,
 441         );
 442         $displayassessment = $workshop->prepare_assessment($assessment, $mform, $options);
 443         if ($canoverride) {
 444             $displayassessment->add_action($workshop->assess_url($assessment->id), get_string('assessmentsettings', 'workshop'));
 445         }
 446         echo $output->render($displayassessment);
 447
 448         if ($workshop->phase == workshop::PHASE_CLOSED and has_capability('mod/workshop:viewallassessments', $workshop->context)) {
 449             if (strlen(trim($assessment->feedbackreviewer)) > 0) {
 450                 echo $output->render(new workshop_feedback_reviewer($assessment));
 451             }
 452         }
 453     }
 454 }
 455
 456 if (!$edit and $canoverride) {
 457     // display a form to override the submission grade
 458     $feedbackform->display();
 459 }
 460
 461 // If portfolios are enabled and we are not on the edit/removal confirmation screen, display a button to export this page.
 462 // The export is not offered if the submission is seen as a published one (it has no relation to the current user.
 463 if (!empty($CFG->enableportfolios)) {
 464     if (!$delete and !$edit and !$seenaspublished and $submission->id and ($ownsubmission or $canviewall or $isreviewer)) {
 465         if (has_capability('mod/workshop:exportsubmissions', $workshop->context)) {
 466             require_once($CFG->libdir.'/portfoliolib.php');
 467
 468             $button = new portfolio_add_button();
 469             $button->set_callback_options('mod_workshop_portfolio_caller', array(
 470                 'id' => $workshop->cm->id,
 471                 'submissionid' => $submission->id,
 472             ), 'mod_workshop');
 473             $button->set_formats(PORTFOLIO_FORMAT_RICHHTML);
 474             echo html_writer::start_tag('div', array('class' => 'singlebutton'));
 475             echo $button->to_html(PORTFOLIO_ADD_FULL_FORM, get_string('exportsubmission', 'workshop'));
 476             echo html_writer::end_tag('div');
 477         }
 478     }
 479 }
 480
 481 echo $output->footer();