mod/workshop/assessment.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  * Assess a submission or view the single assessment
  20  *
  21  * Assessment id parameter must be passed. The script displays the submission and
  22  * the assessment form. If the current user is the reviewer and the assessing is
  23  * allowed, new assessment can be saved.
  24  * If the assessing is not allowed (for example, the assessment period is over
  25  * or the current user is eg a teacher), the assessment form is opened
  26  * in a non-editable mode.
  27  * The capability 'mod/workshop:peerassess' is intentionally not checked here.
  28  * The user is considered as a reviewer if the corresponding assessment record
  29  * has been prepared for him/her (during the allocation). So even a user without the
  30  * peerassess capability (like a 'teacher', for example) can become a reviewer.
  31  *
  32  * @package    mod
  33  * @subpackage workshop
  34  * @copyright  2009 David Mudrak <david.mudrak@gmail.com>
  35  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  36  */
  37
  38 require_once(dirname(dirname(dirname(__FILE__))).'/config.php');
  39 require_once(dirname(__FILE__).'/locallib.php');
  40
  41 $asid       = required_param('asid', PARAM_INT);  // assessment id
  42 $assessment = $DB->get_record('workshop_assessments', array('id' => $asid), '*', MUST_EXIST);
  43 $submission = $DB->get_record('workshop_submissions', array('id' => $assessment->submissionid, 'example' => 0), '*', MUST_EXIST);
  44 $workshop   = $DB->get_record('workshop', array('id' => $submission->workshopid), '*', MUST_EXIST);
  45 $course     = $DB->get_record('course', array('id' => $workshop->course), '*', MUST_EXIST);
  46 $cm         = get_coursemodule_from_instance('workshop', $workshop->id, $course->id, false, MUST_EXIST);
  47
  48 require_login($course, false, $cm);
  49 if (isguestuser()) {
  50     print_error('guestsarenotallowed');
  51 }
  52 $workshop = new workshop($workshop, $cm, $course);
  53
  54 $PAGE->set_url($workshop->assess_url($assessment->id));
  55 $PAGE->set_title($workshop->name);
  56 $PAGE->set_heading($course->fullname);
  57 $PAGE->navbar->add(get_string('assessingsubmission', 'workshop'));
  58
  59 $canviewallassessments  = has_capability('mod/workshop:viewallassessments', $workshop->context);
  60 $canviewallsubmissions  = has_capability('mod/workshop:viewallsubmissions', $workshop->context);
  61 $cansetassessmentweight = has_capability('mod/workshop:allocate', $workshop->context);
  62 $canoverridegrades      = has_capability('mod/workshop:overridegrades', $workshop->context);
  63 $isreviewer             = ($USER->id == $assessment->reviewerid);
  64 $isauthor               = ($USER->id == $submission->authorid);
  65
  66 if ($canviewallsubmissions) {
  67     // check this flag against the group membership yet
  68     if (groups_get_activity_groupmode($workshop->cm) == SEPARATEGROUPS) {
  69         // user must have accessallgroups or share at least one group with the submission author
  70         if (!has_capability('moodle/site:accessallgroups', $workshop->context)) {
  71             $usersgroups = groups_get_activity_allowed_groups($workshop->cm);
  72             $authorsgroups = groups_get_all_groups($workshop->course->id, $submission->authorid, $workshop->cm->groupingid, 'g.id');
  73             $sharedgroups = array_intersect_key($usersgroups, $authorsgroups);
  74             if (empty($sharedgroups)) {
  75                 $canviewallsubmissions = false;
  76             }
  77         }
  78     }
  79 }
  80
  81 if ($isreviewer or $isauthor or ($canviewallassessments and $canviewallsubmissions)) {
  82     // such a user can continue
  83 } else {
  84     print_error('nopermissions', 'error', $workshop->view_url(), 'view this assessment');
  85 }
  86
  87 if ($isauthor and !$isreviewer and !$canviewallassessments and $workshop->phase != workshop::PHASE_CLOSED) {
  88     // authors can see assessments of their work at the end of workshop only
  89     print_error('nopermissions', 'error', $workshop->view_url(), 'view assessment of own work before workshop is closed');
  90 }
  91
  92 // only the reviewer is allowed to modify the assessment
  93 if ($isreviewer and $workshop->assessing_allowed($USER->id)) {
  94     $assessmenteditable = true;
  95 } else {
  96     $assessmenteditable = false;
  97 }
  98
  99 // check that all required examples have been assessed by the user
 100 if ($assessmenteditable and $workshop->useexamples and $workshop->examplesmode == workshop::EXAMPLES_BEFORE_ASSESSMENT
 101         and !has_capability('mod/workshop:manageexamples', $workshop->context)) {
 102     // the reviewer must have submitted their own submission
 103     $reviewersubmission = $workshop->get_submission_by_author($assessment->reviewerid);
 104     if (!$reviewersubmission) {
 105         // no money, no love
 106         $assessmenteditable = false;
 107         echo $output->header();
 108         echo $output->heading(get_string('exampleneedsubmission', 'workshop'), 2);
 109         echo $output->footer();
 110         exit;
 111     } else {
 112         $examples = $workshop->get_examples_for_reviewer($assessment->reviewerid);
 113         foreach ($examples as $exampleid => $example) {
 114             if (is_null($example->grade)) {
 115                 $assessmenteditable = false;
 116                 echo $output->header();
 117                 echo $output->heading(get_string('exampleneedassessed', 'workshop'), 2);
 118                 echo $output->footer();
 119                 exit;
 120             }
 121         }
 122     }
 123 }
 124
 125 // load the grading strategy logic
 126 $strategy = $workshop->grading_strategy_instance();
 127
 128 if (is_null($assessment->grade) and !$assessmenteditable) {
 129     $mform = null;
 130 } else {
 131     // load the assessment form and process the submitted data eventually
 132     $mform = $strategy->get_assessment_form($PAGE->url, 'assessment', $assessment, $assessmenteditable,
 133                                         array('editableweight' => $cansetassessmentweight));
 134     $mform->set_data(array('weight' => $assessment->weight)); // other values are set by subplugins
 135     if ($mform->is_cancelled()) {
 136         redirect($workshop->view_url());
 137     } elseif ($assessmenteditable and ($data = $mform->get_data())) {
 138         if (is_null($assessment->grade)) {
 139             $workshop->log('add assessment', $workshop->assess_url($assessment->id), $assessment->submissionid);
 140         } else {
 141             $workshop->log('update assessment', $workshop->assess_url($assessment->id), $assessment->submissionid);
 142         }
 143         $rawgrade = $strategy->save_assessment($assessment, $data);
 144         if (isset($data->weight) and $cansetassessmentweight) {
 145             $DB->set_field('workshop_assessments', 'weight', $data->weight, array('id' => $assessment->id));
 146         }
 147         if (!is_null($rawgrade) and isset($data->saveandclose)) {
 148             redirect($workshop->view_url());
 149         } else {
 150             // either it is not possible to calculate the $rawgrade
 151             // or the reviewer has chosen "Save and continue"
 152             redirect($PAGE->url);
 153         }
 154     }
 155 }
 156
 157 // load the form to override gradinggrade and/or set weight and process the submitted data eventually
 158 if ($canoverridegrades or $cansetassessmentweight) {
 159     $options = array(
 160         'editable' => true,
 161         'editableweight' => $cansetassessmentweight,
 162         'overridablegradinggrade' => $canoverridegrades);
 163     $feedbackform = $workshop->get_feedbackreviewer_form($PAGE->url, $assessment, $options);
 164     if ($data = $feedbackform->get_data()) {
 165         $data = file_postupdate_standard_editor($data, 'feedbackreviewer', array(), $workshop->context);
 166         $record = new stdclass();
 167         $record->id = $assessment->id;
 168         if ($cansetassessmentweight) {
 169             $record->weight = $data->weight;
 170         }
 171         if ($canoverridegrades) {
 172             $record->gradinggradeover = $workshop->raw_grade_value($data->gradinggradeover, $workshop->gradinggrade);
 173             $record->gradinggradeoverby = $USER->id;
 174             $record->feedbackreviewer = $data->feedbackreviewer;
 175             $record->feedbackreviewerformat = $data->feedbackreviewerformat;
 176         }
 177         $DB->update_record('workshop_assessments', $record);
 178         redirect($workshop->view_url());
 179     }
 180 }
 181
 182 // output starts here
 183 $output = $PAGE->get_renderer('mod_workshop');      // workshop renderer
 184 echo $output->header();
 185 echo $output->heading(get_string('assessedsubmission', 'workshop'), 2);
 186
 187 $submission = $workshop->get_submission_by_id($submission->id);     // reload so can be passed to the renderer
 188 echo $output->render($workshop->prepare_submission($submission, has_capability('mod/workshop:viewauthornames', $workshop->context)));
 189
 190 // show instructions for assessing as they may contain important information
 191 // for evaluating the assessment
 192 if (trim($workshop->instructreviewers)) {
 193     $instructions = file_rewrite_pluginfile_urls($workshop->instructreviewers, 'pluginfile.php', $PAGE->context->id,
 194         'mod_workshop', 'instructreviewers', 0, workshop::instruction_editors_options($PAGE->context));
 195     print_collapsible_region_start('', 'workshop-viewlet-instructreviewers', get_string('instructreviewers', 'workshop'));
 196     echo $output->box(format_text($instructions, $workshop->instructreviewersformat, array('overflowdiv'=>true)), array('generalbox', 'instructions'));
 197     print_collapsible_region_end();
 198 }
 199
 200 // extend the current assessment record with user details
 201 $assessment = $workshop->get_assessment_by_id($assessment->id);
 202
 203 if ($isreviewer) {
 204     $options    = array(
 205         'showreviewer'  => true,
 206         'showauthor'    => has_capability('mod/workshop:viewauthornames', $workshop->context),
 207         'showform'      => $assessmenteditable or !is_null($assessment->grade),
 208         'showweight'    => true,
 209     );
 210     $assessment = $workshop->prepare_assessment($assessment, $mform, $options);
 211     $assessment->title = get_string('assessmentbyyourself', 'workshop');
 212     echo $output->render($assessment);
 213
 214 } else {
 215     $options    = array(
 216         'showreviewer'  => has_capability('mod/workshop:viewreviewernames', $workshop->context),
 217         'showauthor'    => has_capability('mod/workshop:viewauthornames', $workshop->context),
 218         'showform'      => $assessmenteditable or !is_null($assessment->grade),
 219         'showweight'    => true,
 220     );
 221     $assessment = $workshop->prepare_assessment($assessment, $mform, $options);
 222     echo $output->render($assessment);
 223 }
 224
 225 if (!$assessmenteditable and $canoverridegrades) {
 226     $feedbackform->display();
 227 }
 228
 229 echo $output->footer();