Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
<?php

// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/**
 * Provides the interface for grading essay questions
 *
 * @package mod_lesson
 * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 **/

require_once('../../config.php');
require_once($CFG->dirroot.'/mod/lesson/locallib.php');
require_once($CFG->dirroot.'/mod/lesson/pagetypes/essay.php');
require_once($CFG->dirroot.'/mod/lesson/essay_form.php');

$id   = required_param('id', PARAM_INT);             // Course Module ID
$mode = optional_param('mode', 'display', PARAM_ALPHA);

$cm = get_coursemodule_from_id('lesson', $id, 0, false, MUST_EXIST);
$course = $DB->get_record('course', array('id' => $cm->course), '*', MUST_EXIST);
$dblesson = $DB->get_record('lesson', array('id' => $cm->instance), '*', MUST_EXIST);
$lesson = new lesson($dblesson);

require_login($course, false, $cm);
$context = context_module::instance($cm->id);
require_capability('mod/lesson:grade', $context);

$url = new moodle_url('/mod/lesson/essay.php', array('id'=>$id));
if ($mode !== 'display') {
    $url->param('mode', $mode);
}
$PAGE->set_url($url);
$PAGE->set_secondary_active_tab('modulepage');

$currentgroup = groups_get_activity_group($cm, true);

$attempt = new stdClass();
$user = new stdClass();
$attemptid = optional_param('attemptid', 0, PARAM_INT);

$formattextdefoptions = new stdClass();
$formattextdefoptions->noclean = true;
$formattextdefoptions->para = false;
$formattextdefoptions->context = $context;

if ($attemptid > 0) {
    $attempt = $DB->get_record('lesson_attempts', array('id' => $attemptid));
    $answer = $DB->get_record('lesson_answers', array('lessonid' => $lesson->id, 'pageid' => $attempt->pageid));
    $user = $DB->get_record('user', array('id' => $attempt->userid));
    // Apply overrides.
    $lesson->update_effective_access($user->id);
    $scoreoptions = array();
    if ($lesson->custom) {
        $i = $answer->score;
        while ($i >= 0) {
            $scoreoptions[$i] = (string)$i;
            $i--;
        }
    } else {
        $scoreoptions[0] = get_string('nocredit', 'lesson');
        $scoreoptions[1] = get_string('credit', 'lesson');
    }
}

/// Handle any preprocessing before header is printed - based on $mode
switch ($mode) {
    case 'grade':
        // Grading form - get the necessary data
        require_sesskey();

        if (empty($attempt)) {
< print_error('cannotfindattempt', 'lesson');
> throw new \moodle_exception('cannotfindattempt', 'lesson');
} if (empty($user)) {
< print_error('cannotfinduser', 'lesson');
> throw new \moodle_exception('cannotfinduser', 'lesson');
} if (empty($answer)) {
< print_error('cannotfindanswer', 'lesson');
> throw new \moodle_exception('cannotfindanswer', 'lesson');
} break; case 'update': require_sesskey(); if (empty($attempt)) {
< print_error('cannotfindattempt', 'lesson');
> throw new \moodle_exception('cannotfindattempt', 'lesson');
} if (empty($user)) {
< print_error('cannotfinduser', 'lesson');
> throw new \moodle_exception('cannotfinduser', 'lesson');
} $editoroptions = array('noclean' => true, 'maxfiles' => EDITOR_UNLIMITED_FILES, 'maxbytes' => $CFG->maxbytes, 'context' => $context); $essayinfo = lesson_page_type_essay::extract_useranswer($attempt->useranswer); $essayinfo = file_prepare_standard_editor($essayinfo, 'response', $editoroptions, $context, 'mod_lesson', 'essay_responses', $attempt->id); $mform = new essay_grading_form(null, array('scoreoptions' => $scoreoptions, 'user' => $user)); $mform->set_data($essayinfo); if ($mform->is_cancelled()) { redirect("$CFG->wwwroot/mod/lesson/essay.php?id=$cm->id"); } if ($form = $mform->get_data()) { if (!$grades = $DB->get_records('lesson_grades', array("lessonid"=>$lesson->id, "userid"=>$attempt->userid), 'completed', '*', $attempt->retry, 1)) {
< print_error('cannotfindgrade', 'lesson');
> throw new \moodle_exception('cannotfindgrade', 'lesson');
} $essayinfo->graded = 1; $essayinfo->score = $form->score; $form = file_postupdate_standard_editor($form, 'response', $editoroptions, $context, 'mod_lesson', 'essay_responses', $attempt->id); $essayinfo->response = $form->response; $essayinfo->responseformat = $form->responseformat; $essayinfo->sent = 0; if (!$lesson->custom && $essayinfo->score == 1) { $attempt->correct = 1; } else { $attempt->correct = 0; } $attempt->useranswer = serialize($essayinfo); $DB->update_record('lesson_attempts', $attempt); // Get grade information $grade = current($grades); $gradeinfo = lesson_grade($lesson, $attempt->retry, $attempt->userid); // Set and update $updategrade = new stdClass(); $updategrade->id = $grade->id; $updategrade->grade = $gradeinfo->grade; $DB->update_record('lesson_grades', $updategrade); $params = array( 'context' => $context, 'objectid' => $grade->id, 'courseid' => $course->id, 'relateduserid' => $attempt->userid, 'other' => array( 'lessonid' => $lesson->id, 'attemptid' => $attemptid ) ); $event = \mod_lesson\event\essay_assessed::create($params); $event->add_record_snapshot('lesson', $dblesson); $event->trigger(); $lesson->add_message(get_string('changessaved'), 'notifysuccess'); // update central gradebook lesson_update_grades($lesson, $grade->userid); redirect(new moodle_url('/mod/lesson/essay.php', array('id'=>$cm->id))); } else {
< print_error('invalidformdata');
> throw new \moodle_exception('invalidformdata');
} break; case 'email': // Sending an email(s) to a single user or all require_sesskey(); // Get our users (could be singular) if ($userid = optional_param('userid', 0, PARAM_INT)) { $queryadd = " AND userid = ?"; if (! $users = $DB->get_records('user', array('id' => $userid))) {
< print_error('cannotfinduser', 'lesson');
> throw new \moodle_exception('cannotfinduser', 'lesson');
} } else { $queryadd = ''; // If group selected, only send to group members. list($esql, $params) = get_enrolled_sql($context, '', $currentgroup, true); list($sort, $sortparams) = users_order_by_sql('u'); $params['lessonid'] = $lesson->id; // Need to use inner view to avoid distinct + text if (!$users = $DB->get_records_sql(" SELECT u.* FROM {user} u JOIN ( SELECT DISTINCT userid FROM {lesson_attempts} WHERE lessonid = :lessonid ) ui ON u.id = ui.userid JOIN ($esql) ue ON ue.id = u.id ORDER BY $sort", $params)) {
< print_error('cannotfinduser', 'lesson');
> throw new \moodle_exception('cannotfinduser', 'lesson');
} } $pages = $lesson->load_all_pages(); foreach ($pages as $key=>$page) { if ($page->qtype != LESSON_PAGE_ESSAY) { unset($pages[$key]); } } // Get only the attempts that are in response to essay questions list($usql, $params) = $DB->get_in_or_equal(array_keys($pages)); if (!empty($queryadd)) { $params[] = $userid; } if (!$attempts = $DB->get_records_select('lesson_attempts', "pageid $usql".$queryadd, $params)) {
< print_error('nooneansweredthisquestion', 'lesson');
> throw new \moodle_exception('nooneansweredthisquestion', 'lesson');
} // Get the answers list($answerUsql, $parameters) = $DB->get_in_or_equal(array_keys($pages)); array_unshift($parameters, $lesson->id); if (!$answers = $DB->get_records_select('lesson_answers', "lessonid = ? AND pageid $answerUsql", $parameters, '', 'pageid, score')) {
< print_error('cannotfindanswer', 'lesson');
> throw new \moodle_exception('cannotfindanswer', 'lesson');
} $userpicture = new user_picture($USER); $userpicture->size = 1; // Use f1 size. foreach ($attempts as $attempt) { $essayinfo = lesson_page_type_essay::extract_useranswer($attempt->useranswer); if ($essayinfo->graded && !$essayinfo->sent) { // Holds values for the essayemailsubject string for the email message $a = new stdClass; // Set the grade $grades = $DB->get_records('lesson_grades', array("lessonid"=>$lesson->id, "userid"=>$attempt->userid), 'completed', '*', $attempt->retry, 1); $grade = current($grades); $a->newgrade = $grade->grade; // Set the points if ($lesson->custom) { $a->earned = $essayinfo->score; $a->outof = $answers[$attempt->pageid]->score; } else { $a->earned = $essayinfo->score; $a->outof = 1; } // Set rest of the message values $currentpage = $lesson->load_page($attempt->pageid); $a->question = format_text($currentpage->contents, $currentpage->contentsformat, $formattextdefoptions); $answer = file_rewrite_pluginfile_urls($essayinfo->answer, 'pluginfile.php', $context->id, 'mod_lesson', 'essay_answers', $attempt->id); $a->response = format_text($answer, $essayinfo->answerformat, array('context' => $context, 'para' => true)); $a->comment = $essayinfo->response; $a->comment = file_rewrite_pluginfile_urls($a->comment, 'pluginfile.php', $context->id, 'mod_lesson', 'essay_responses', $attempt->id); $a->comment = format_text($a->comment, $essayinfo->responseformat, $formattextdefoptions); $a->lesson = format_string($lesson->name, true); // Fetch message HTML and plain text formats $message = get_string('essayemailmessage2', 'lesson', $a); $plaintext = format_text_email($message, FORMAT_HTML); $smallmessage = get_string('essayemailmessagesmall', 'lesson', $a); $smallmessage = format_text_email($smallmessage, FORMAT_HTML); // Subject $subject = get_string('essayemailsubject', 'lesson'); // Context url. $contexturl = new moodle_url('/grade/report/user/index.php', array('id' => $course->id)); $eventdata = new \core\message\message(); $eventdata->courseid = $course->id; $eventdata->modulename = 'lesson'; $eventdata->userfrom = $USER; $eventdata->userto = $users[$attempt->userid]; $eventdata->subject = $subject; $eventdata->fullmessage = $plaintext; $eventdata->fullmessageformat = FORMAT_PLAIN; $eventdata->fullmessagehtml = $message; $eventdata->smallmessage = $smallmessage; $eventdata->contexturl = $contexturl->out(false); $userpicture->includetoken = $attempt->userid; // Generate an out-of-session token for the destinatary. $eventdata->customdata = [ 'cmid' => $cm->id, 'instance' => $lesson->id, 'retake' => $lesson->id, 'notificationiconurl' => $userpicture->get_url($PAGE)->out(false), ]; // Required for messaging framework $eventdata->component = 'mod_lesson'; $eventdata->name = 'graded_essay'; message_send($eventdata); $essayinfo->sent = 1; $attempt->useranswer = serialize($essayinfo); $DB->update_record('lesson_attempts', $attempt); } } $lesson->add_message(get_string('emailsuccess', 'lesson'), 'notifysuccess'); redirect(new moodle_url('/mod/lesson/essay.php', array('id'=>$cm->id))); break; case 'display': // Default view - get the necessary data default: // Get lesson pages that are essay $pages = $lesson->load_all_pages(); foreach ($pages as $key=>$page) { if ($page->qtype != LESSON_PAGE_ESSAY) { unset($pages[$key]); } } if (count($pages) > 0) { // Get only the attempts that are in response to essay questions list($usql, $parameters) = $DB->get_in_or_equal(array_keys($pages), SQL_PARAMS_NAMED); // If group selected, only get group members attempts. list($esql, $params) = get_enrolled_sql($context, '', $currentgroup, true); $parameters = array_merge($params, $parameters); $sql = "SELECT a.* FROM {lesson_attempts} a JOIN ($esql) ue ON a.userid = ue.id WHERE pageid $usql"; if ($essayattempts = $DB->get_records_sql($sql, $parameters)) { $userfieldsapi = \core_user\fields::for_userpic(); $ufields = $userfieldsapi->get_sql('u', false, '', '', false)->selects; // Get all the users who have taken this lesson. list($sort, $sortparams) = users_order_by_sql('u'); $params['lessonid'] = $lesson->id; $sql = "SELECT DISTINCT $ufields FROM {user} u JOIN {lesson_attempts} a ON u.id = a.userid JOIN ($esql) ue ON ue.id = a.userid WHERE a.lessonid = :lessonid ORDER BY $sort"; if (!$users = $DB->get_records_sql($sql, $params)) { $mode = 'none'; // not displaying anything if (!empty($currentgroup)) { $groupname = groups_get_group_name($currentgroup); $lesson->add_message(get_string('noonehasansweredgroup', 'lesson', $groupname)); } else { $lesson->add_message(get_string('noonehasanswered', 'lesson')); } } } else { $mode = 'none'; // not displaying anything if (!empty($currentgroup)) { $groupname = groups_get_group_name($currentgroup); $lesson->add_message(get_string('noonehasansweredgroup', 'lesson', $groupname)); } else { $lesson->add_message(get_string('noonehasanswered', 'lesson')); } } } else { $mode = 'none'; // not displaying anything $lesson->add_message(get_string('noessayquestionsfound', 'lesson')); } break; } $lessonoutput = $PAGE->get_renderer('mod_lesson'); echo $lessonoutput->header($lesson, $cm, 'essay', false, null, get_string('manualgrading', 'lesson')); switch ($mode) { case 'display': groups_print_activity_menu($cm, $url); // Expects $user, $essayattempts and $pages to be set already // Group all the essays by userid $studentessays = array(); foreach ($essayattempts as $essay) { // Not very nice :) but basically // this organizes the essays so we know how many // times a student answered an essay per try and per page $studentessays[$essay->userid][$essay->pageid][$essay->retry][] = $essay; } // Setup table $table = new html_table(); $table->head = array(get_string('name'), get_string('essays', 'lesson'), get_string('status'), get_string('email', 'lesson')); $table->attributes['class'] = 'standardtable generaltable'; $table->align = array('left', 'left', 'left'); $table->wrap = array('nowrap', 'nowrap', ''); // Cycle through all the students foreach (array_keys($studentessays) as $userid) { $studentname = fullname($users[$userid], true); $essaylinks = array(); $essaystatuses = array(); // Number of attempts on the lesson $attempts = $lesson->count_user_retries($userid); // Go through each essay page foreach ($studentessays[$userid] as $page => $tries) { $count = 0; // Go through each attempt per page foreach($tries as $try) { if ($count == $attempts) { break; // Stop displaying essays (attempt not completed) } $count++; // Make sure they didn't answer it more than the max number of attempts. $essay = $lesson->get_last_attempt($try); // Start processing the attempt $essayinfo = lesson_page_type_essay::extract_useranswer($essay->useranswer); // link for each essay $url = new moodle_url('/mod/lesson/essay.php', array('id'=>$cm->id,'mode'=>'grade','attemptid'=>$essay->id,'sesskey'=>sesskey())); $linktitle = userdate($essay->timeseen, get_string('strftimedatetime')).' '. format_string($pages[$essay->pageid]->title, true); // Different colors for all the states of an essay (graded, if sent, not graded) if (!$essayinfo->graded) { $class = "badge badge-warning"; $status = get_string('notgraded', 'lesson'); } elseif (!$essayinfo->sent) { $class = "badge badge-success"; $status = get_string('graded', 'lesson'); } else { $class = "badge badge-success"; $status = get_string('sent', 'lesson'); } $attributes = array('tabindex' => 0); $essaylinks[] = html_writer::link($url, $linktitle); $essaystatuses[] = html_writer::span($status, $class, $attributes); } } // email link for this user $url = new moodle_url('/mod/lesson/essay.php', array('id'=>$cm->id,'mode'=>'email','userid'=>$userid,'sesskey'=>sesskey())); $emaillink = html_writer::link($url, get_string('emailgradedessays', 'lesson')); $table->data[] = array($OUTPUT->user_picture($users[$userid], array('courseid' => $course->id)) . $studentname, implode("<br />", $essaylinks), implode("<br />", $essaystatuses), $emaillink); } // email link for all users $url = new moodle_url('/mod/lesson/essay.php', array('id'=>$cm->id,'mode'=>'email','sesskey'=>sesskey())); $emailalllink = html_writer::link($url, get_string('emailallgradedessays', 'lesson')); $table->data[] = array(' ', ' ', ' ', $emailalllink); echo html_writer::table($table); break; case 'grade': // Trigger the essay grade viewed event. $event = \mod_lesson\event\essay_attempt_viewed::create(array( 'objectid' => $attempt->id, 'relateduserid' => $attempt->userid, 'context' => $context, 'courseid' => $course->id, )); $event->add_record_snapshot('lesson_attempts', $attempt); $event->trigger(); // Grading form // Expects the following to be set: $attemptid, $answer, $user, $page, $attempt $essayinfo = lesson_page_type_essay::extract_useranswer($attempt->useranswer); $answer = file_rewrite_pluginfile_urls($essayinfo->answer, 'pluginfile.php', $context->id, 'mod_lesson', 'essay_answers', $attempt->id); $currentpage = $lesson->load_page($attempt->pageid); $mform = new essay_grading_form(null, array('scoreoptions'=>$scoreoptions, 'user'=>$user)); $data = new stdClass; $data->id = $cm->id; $data->attemptid = $attemptid; $data->score = $essayinfo->score; $data->question = format_text($currentpage->contents, $currentpage->contentsformat, $formattextdefoptions); $data->studentanswer = format_text($answer, $essayinfo->answerformat, array('context' => $context, 'para' => true)); $data->response = $essayinfo->response; $data->responseformat = $essayinfo->responseformat; $editoroptions = array('noclean' => true, 'maxfiles' => EDITOR_UNLIMITED_FILES, 'maxbytes' => $CFG->maxbytes, 'context' => $context); $data = file_prepare_standard_editor($data, 'response', $editoroptions, $context, 'mod_lesson', 'essay_responses', $attempt->id); $mform->set_data($data); $mform->display(); break; default: groups_print_activity_menu($cm, $url); break; } echo $OUTPUT->footer();