mod/workshop/submission.php

   1 <?php
   2
   3 // This file is part of Moodle - http://moodle.org/
   4 //
   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.
   9 //
  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.
  14 //
  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/>.
  17
  18 /**
  19  * View a single (usually the own) submission, submit own work.
  20  *
  21  * @package    mod
  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
  25  */
  26
  27 require_once(dirname(dirname(dirname(__FILE__))).'/config.php');
  28 require_once(dirname(__FILE__).'/locallib.php');
  29
  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
  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 $workshop = $DB->get_record('workshop', array('id' => $cm->instance), '*', MUST_EXIST);
  44 $workshop = new workshop($workshop, $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     $workshop->log('view submission', $workshop->submission_url($submission->id), $submission->id);
  55
  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();
  67     }
  68 }
  69
  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));
  82
  83 if (empty($submission->id) and !$workshop->creating_submission_allowed($USER->id)) {
  84     $editable = false;
  85 }
  86 if ($submission->id and !$workshop->modifying_submission_allowed($USER->id)) {
  87     $editable = false;
  88 }
  89
  90 if ($canviewall) {
  91     // check this flag against the group membership yet
  92     if (groups_get_activity_groupmode($workshop->cm) == SEPARATEGROUPS) {
  93         // user must have accessallgroups or share at least one group with the submission author
  94         if (!has_capability('moodle/site:accessallgroups', $workshop->context)) {
  95             $usersgroups = groups_get_activity_allowed_groups($workshop->cm);
  96             $authorsgroups = groups_get_all_groups($workshop->course->id, $submission->authorid, $workshop->cm->groupingid, 'g.id');
  97             $sharedgroups = array_intersect_key($usersgroups, $authorsgroups);
  98             if (empty($sharedgroups)) {
  99                 $canviewall = false;
 100             }
 101         }
 102     }
 103 }
 104
 105 if ($editable and $workshop->useexamples and $workshop->examplesmode == workshop::EXAMPLES_BEFORE_SUBMISSION
 106         and !has_capability('mod/workshop:manageexamples', $workshop->context)) {
 107     // check that all required examples have been assessed by the user
 108     $examples = $workshop->get_examples_for_reviewer($USER->id);
 109     foreach ($examples as $exampleid => $example) {
 110         if (is_null($example->grade)) {
 111             $editable = false;
 112             break;
 113         }
 114     }
 115 }
 116 $edit = ($editable and $edit);
 117
 118 $seenaspublished = false; // is the submission seen as a published submission?
 119
 120 if ($submission->id and ($ownsubmission or $canviewall or $isreviewer)) {
 121     // ok you can go
 122 } elseif ($submission->id and $ispublished) {
 123     // ok you can go
 124     $seenaspublished = true;
 125 } elseif (is_null($submission->id) and $cansubmit) {
 126     // ok you can go
 127 } else {
 128     print_error('nopermissions', 'error', $workshop->view_url(), 'view or create submission');
 129 }
 130
 131 if ($assess and $submission->id and !$isreviewer and $canallocate and $workshop->assessing_allowed($USER->id)) {
 132     require_sesskey();
 133     $assessmentid = $workshop->add_allocation($submission, $USER->id);
 134     redirect($workshop->assess_url($assessmentid));
 135 }
 136
 137 if ($edit) {
 138     require_once(dirname(__FILE__).'/submission_form.php');
 139
 140     $maxfiles       = $workshop->nattachments;
 141     $maxbytes       = $workshop->maxbytes;
 142     $contentopts    = array(
 143                         'trusttext' => true,
 144                         'subdirs'   => false,
 145                         'maxfiles'  => $maxfiles,
 146                         'maxbytes'  => $maxbytes,
 147                         'context'   => $workshop->context,
 148                         'return_types' => FILE_INTERNAL | FILE_EXTERNAL
 149                       );
 150
 151     $attachmentopts = array('subdirs' => true, 'maxfiles' => $maxfiles, 'maxbytes' => $maxbytes, 'return_types' => FILE_INTERNAL);
 152     $submission     = file_prepare_standard_editor($submission, 'content', $contentopts, $workshop->context,
 153                                         'mod_workshop', 'submission_content', $submission->id);
 154     $submission     = file_prepare_standard_filemanager($submission, 'attachment', $attachmentopts, $workshop->context,
 155                                         'mod_workshop', 'submission_attachment', $submission->id);
 156
 157     $mform          = new workshop_submission_form($PAGE->url, array('current' => $submission, 'workshop' => $workshop,
 158                                                     'contentopts' => $contentopts, 'attachmentopts' => $attachmentopts));
 159
 160     if ($mform->is_cancelled()) {
 161         redirect($workshop->view_url());
 162
 163     } elseif ($cansubmit and $formdata = $mform->get_data()) {
 164         if ($formdata->example == 0) {
 165             // this was used just for validation, it must be set to zero when dealing with normal submissions
 166             unset($formdata->example);
 167         } else {
 168             throw new coding_exception('Invalid submission form data value: example');
 169         }
 170         $timenow = time();
 171         if (is_null($submission->id)) {
 172             $formdata->workshopid     = $workshop->id;
 173             $formdata->example        = 0;
 174             $formdata->authorid       = $USER->id;
 175             $formdata->timecreated    = $timenow;
 176             $formdata->feedbackauthorformat = editors_get_preferred_format();
 177         }
 178         $formdata->timemodified       = $timenow;
 179         $formdata->title              = trim($formdata->title);
 180         $formdata->content            = '';          // updated later
 181         $formdata->contentformat      = FORMAT_HTML; // updated later
 182         $formdata->contenttrust       = 0;           // updated later
 183         $formdata->late               = 0x0;         // bit mask
 184         if (!empty($workshop->submissionend) and ($workshop->submissionend < time())) {
 185             $formdata->late = $formdata->late | 0x1;
 186         }
 187         if ($workshop->phase == workshop::PHASE_ASSESSMENT) {
 188             $formdata->late = $formdata->late | 0x2;
 189         }
 190         if (is_null($submission->id)) {
 191             $submission->id = $formdata->id = $DB->insert_record('workshop_submissions', $formdata);
 192             $workshop->log('add submission', $workshop->submission_url($submission->id), $submission->id);
 193         } else {
 194             $workshop->log('update submission', $workshop->submission_url($submission->id), $submission->id);
 195             if (empty($formdata->id) or empty($submission->id) or ($formdata->id != $submission->id)) {
 196                 throw new moodle_exception('err_submissionid', 'workshop');
 197             }
 198         }
 199         // save and relink embedded images and save attachments
 200         $formdata = file_postupdate_standard_editor($formdata, 'content', $contentopts, $workshop->context,
 201                                                       'mod_workshop', 'submission_content', $submission->id);
 202         $formdata = file_postupdate_standard_filemanager($formdata, 'attachment', $attachmentopts, $workshop->context,
 203                                                            'mod_workshop', 'submission_attachment', $submission->id);
 204         if (empty($formdata->attachment)) {
 205             // explicit cast to zero integer
 206             $formdata->attachment = 0;
 207         }
 208         // store the updated values or re-save the new submission (re-saving needed because URLs are now rewritten)
 209         $DB->update_record('workshop_submissions', $formdata);
 210
 211         // send submitted content for plagiarism detection
 212         $fs = get_file_storage();
 213         $files = $fs->get_area_files($workshop->context->id, 'mod_workshop', 'submission_attachment', $submission->id);
 214         $eventdata = new stdClass();
 215         $eventdata->modulename   = 'workshop';
 216         $eventdata->cmid         = $cm->id;
 217         $eventdata->itemid       = $submission->id;
 218         $eventdata->courseid     = $course->id;
 219         $eventdata->userid       = $USER->id;
 220         $eventdata->content      = $formdata->content;
 221         if ($files) {
 222             $eventdata->pathnamehashes = array_keys($files);
 223         }
 224         events_trigger('assessable_content_uploaded', $eventdata);
 225
 226         redirect($workshop->submission_url($formdata->id));
 227     }
 228 }
 229
 230 // load the form to override grade and/or publish the submission and process the submitted data eventually
 231 if (!$edit and ($canoverride or $canpublish)) {
 232     $options = array(
 233         'editable' => true,
 234         'editablepublished' => $canpublish,
 235         'overridablegrade' => $canoverride);
 236     $feedbackform = $workshop->get_feedbackauthor_form($PAGE->url, $submission, $options);
 237     if ($data = $feedbackform->get_data()) {
 238         $data = file_postupdate_standard_editor($data, 'feedbackauthor', array(), $workshop->context);
 239         $record = new stdclass();
 240         $record->id = $submission->id;
 241         if ($canoverride) {
 242             $record->gradeover = $workshop->raw_grade_value($data->gradeover, $workshop->grade);
 243             $record->gradeoverby = $USER->id;
 244             $record->feedbackauthor = $data->feedbackauthor;
 245             $record->feedbackauthorformat = $data->feedbackauthorformat;
 246         }
 247         if ($canpublish) {
 248             $record->published = !empty($data->published);
 249         }
 250         $DB->update_record('workshop_submissions', $record);
 251         redirect($workshop->view_url());
 252     }
 253 }
 254
 255 $PAGE->set_title($workshop->name);
 256 $PAGE->set_heading($course->fullname);
 257 if ($edit) {
 258     $PAGE->navbar->add(get_string('mysubmission', 'workshop'), $workshop->submission_url(), navigation_node::TYPE_CUSTOM);
 259     $PAGE->navbar->add(get_string('editingsubmission', 'workshop'));
 260 } elseif ($ownsubmission) {
 261     $PAGE->navbar->add(get_string('mysubmission', 'workshop'));
 262 } else {
 263     $PAGE->navbar->add(get_string('submission', 'workshop'));
 264 }
 265
 266 // Output starts here
 267 $output = $PAGE->get_renderer('mod_workshop');
 268 echo $output->header();
 269 echo $output->heading(format_string($workshop->name), 2);
 270
 271 // show instructions for submitting as thay may contain some list of questions and we need to know them
 272 // while reading the submitted answer
 273 if (trim($workshop->instructauthors)) {
 274     $instructions = file_rewrite_pluginfile_urls($workshop->instructauthors, 'pluginfile.php', $PAGE->context->id,
 275         'mod_workshop', 'instructauthors', 0, workshop::instruction_editors_options($PAGE->context));
 276     print_collapsible_region_start('', 'workshop-viewlet-instructauthors', get_string('instructauthors', 'workshop'));
 277     echo $output->box(format_text($instructions, $workshop->instructauthorsformat, array('overflowdiv'=>true)), array('generalbox', 'instructions'));
 278     print_collapsible_region_end();
 279 }
 280
 281 // if in edit mode, display the form to edit the submission
 282
 283 if ($edit) {
 284     if (!empty($CFG->enableplagiarism)) {
 285         require_once($CFG->libdir.'/plagiarismlib.php');
 286         echo plagiarism_print_disclosure($cm->id);
 287     }
 288     $mform->display();
 289     echo $output->footer();
 290     die();
 291 }
 292
 293 // else display the submission
 294
 295 if ($submission->id) {
 296     if ($seenaspublished) {
 297         $showauthor = has_capability('mod/workshop:viewauthorpublished', $workshop->context);
 298     } else {
 299         $showauthor = has_capability('mod/workshop:viewauthornames', $workshop->context);
 300     }
 301     echo $output->render($workshop->prepare_submission($submission, $showauthor));
 302 } else {
 303     echo $output->box(get_string('noyoursubmission', 'workshop'));
 304 }
 305
 306 if ($editable) {
 307     if ($submission->id) {
 308         $btnurl = new moodle_url($PAGE->url, array('edit' => 'on', 'id' => $submission->id));
 309         $btntxt = get_string('editsubmission', 'workshop');
 310     } else {
 311         $btnurl = new moodle_url($PAGE->url, array('edit' => 'on'));
 312         $btntxt = get_string('createsubmission', 'workshop');
 313     }
 314     echo $output->single_button($btnurl, $btntxt, 'get');
 315 }
 316
 317 if ($submission->id and !$edit and !$isreviewer and $canallocate and $workshop->assessing_allowed($USER->id)) {
 318     $url = new moodle_url($PAGE->url, array('assess' => 1));
 319     echo $output->single_button($url, get_string('assess', 'workshop'), 'post');
 320 }
 321
 322 if (($workshop->phase == workshop::PHASE_CLOSED) and ($ownsubmission or $canviewall)) {
 323     if (!empty($submission->gradeoverby) and strlen(trim($submission->feedbackauthor)) > 0) {
 324         echo $output->render(new workshop_feedback_author($submission));
 325     }
 326 }
 327
 328 // and possibly display the submission's review(s)
 329
 330 if ($isreviewer) {
 331     // user's own assessment
 332     $strategy   = $workshop->grading_strategy_instance();
 333     $mform      = $strategy->get_assessment_form($PAGE->url, 'assessment', $userassessment, false);
 334     $options    = array(
 335         'showreviewer'  => true,
 336         'showauthor'    => $showauthor,
 337         'showform'      => !is_null($userassessment->grade),
 338         'showweight'    => true,
 339     );
 340     $assessment = $workshop->prepare_assessment($userassessment, $mform, $options);
 341     $assessment->title = get_string('assessmentbyyourself', 'workshop');
 342
 343     if ($workshop->assessing_allowed($USER->id)) {
 344         if (is_null($userassessment->grade)) {
 345             $assessment->add_action($workshop->assess_url($assessment->id), get_string('assess', 'workshop'));
 346         } else {
 347             $assessment->add_action($workshop->assess_url($assessment->id), get_string('reassess', 'workshop'));
 348         }
 349     }
 350     if ($canoverride) {
 351         $assessment->add_action($workshop->assess_url($assessment->id), get_string('assessmentsettings', 'workshop'));
 352     }
 353
 354     echo $output->render($assessment);
 355
 356     if ($workshop->phase == workshop::PHASE_CLOSED) {
 357         if (strlen(trim($userassessment->feedbackreviewer)) > 0) {
 358             echo $output->render(new workshop_feedback_reviewer($userassessment));
 359         }
 360     }
 361 }
 362
 363 if (has_capability('mod/workshop:viewallassessments', $workshop->context) or ($ownsubmission and $workshop->assessments_available())) {
 364     // other assessments
 365     $strategy       = $workshop->grading_strategy_instance();
 366     $assessments    = $workshop->get_assessments_of_submission($submission->id);
 367     $showreviewer   = has_capability('mod/workshop:viewreviewernames', $workshop->context);
 368     foreach ($assessments as $assessment) {
 369         if ($assessment->reviewerid == $USER->id) {
 370             // own assessment has been displayed already
 371             continue;
 372         }
 373         if (is_null($assessment->grade) and !has_capability('mod/workshop:viewallassessments', $workshop->context)) {
 374             // students do not see peer-assessment that are not graded yet
 375             continue;
 376         }
 377         $mform      = $strategy->get_assessment_form($PAGE->url, 'assessment', $assessment, false);
 378         $options    = array(
 379             'showreviewer'  => $showreviewer,
 380             'showauthor'    => $showauthor,
 381             'showform'      => !is_null($assessment->grade),
 382             'showweight'    => true,
 383         );
 384         $displayassessment = $workshop->prepare_assessment($assessment, $mform, $options);
 385         if ($canoverride) {
 386             $displayassessment->add_action($workshop->assess_url($assessment->id), get_string('assessmentsettings', 'workshop'));
 387         }
 388         echo $output->render($displayassessment);
 389
 390         if ($workshop->phase == workshop::PHASE_CLOSED and has_capability('mod/workshop:viewallassessments', $workshop->context)) {
 391             if (strlen(trim($assessment->feedbackreviewer)) > 0) {
 392                 echo $output->render(new workshop_feedback_reviewer($assessment));
 393             }
 394         }
 395     }
 396 }
 397
 398 if (!$edit and $canoverride) {
 399     // display a form to override the submission grade
 400     $feedbackform->display();
 401 }
 402
 403 echo $output->footer();