Merge branch 'MDL-40054_master' of https://github.com/markn86/moodle
[moodle.git] / mod / lesson / essay.php
1 <?php
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/>.
18 /**
19  * Provides the interface for grading essay questions
20  *
21  * @package    mod
22  * @subpackage lesson
23  * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
24  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  **/
27 require_once('../../config.php');
28 require_once($CFG->dirroot.'/mod/lesson/locallib.php');
29 require_once($CFG->dirroot.'/mod/lesson/essay_form.php');
30 require_once($CFG->libdir.'/eventslib.php');
32 $id   = required_param('id', PARAM_INT);             // Course Module ID
33 $mode = optional_param('mode', 'display', PARAM_ALPHA);
35 $cm = get_coursemodule_from_id('lesson', $id, 0, false, MUST_EXIST);
36 $course = $DB->get_record('course', array('id' => $cm->course), '*', MUST_EXIST);
37 $lesson = new lesson($DB->get_record('lesson', array('id' => $cm->instance), '*', MUST_EXIST));
39 require_login($course, false, $cm);
40 $context = context_module::instance($cm->id);
41 require_capability('mod/lesson:edit', $context);
43 $url = new moodle_url('/mod/lesson/essay.php', array('id'=>$id));
44 if ($mode !== 'display') {
45     $url->param('mode', $mode);
46 }
47 $PAGE->set_url($url);
49 $attempt = new stdClass();
50 $user = new stdClass();
51 $attemptid = optional_param('attemptid', 0, PARAM_INT);
53 if ($attemptid > 0) {
54     $attempt = $DB->get_record('lesson_attempts', array('id' => $attemptid));
55     $answer = $DB->get_record('lesson_answers', array('lessonid' => $lesson->id, 'pageid' => $attempt->pageid));
56     $user = $DB->get_record('user', array('id' => $attempt->userid));
57     $scoreoptions = array();
58     if ($lesson->custom) {
59         $i = $answer->score;
60         while ($i >= 0) {
61             $scoreoptions[$i] = (string)$i;
62             $i--;
63         }
64     } else {
65         $scoreoptions[0] = get_string('nocredit', 'lesson');
66         $scoreoptions[1] = get_string('credit', 'lesson');
67     }
68 }
70 /// Handle any preprocessing before header is printed - based on $mode
71 switch ($mode) {
72     case 'grade':
73         // Grading form - get the necessary data
74         require_sesskey();
76         if (empty($attempt)) {
77             print_error('cannotfindattempt', 'lesson');
78         }
79         if (empty($user)) {
80             print_error('cannotfinduser', 'lesson');
81         }
82         if (empty($answer)) {
83             print_error('cannotfindanswer', 'lesson');
84         }
85         break;
87     case 'update':
88         require_sesskey();
90         if (empty($attempt)) {
91             print_error('cannotfindattempt', 'lesson');
92         }
93         if (empty($user)) {
94             print_error('cannotfinduser', 'lesson');
95         }
97         $mform = new essay_grading_form(null, array('scoreoptions'=>$scoreoptions, 'user'=>$user));
98         if ($mform->is_cancelled()) {
99             redirect("$CFG->wwwroot/mod/lesson/essay.php?id=$cm->id");
100         }
101         if ($form = $mform->get_data()) {
102             if (!$grades = $DB->get_records('lesson_grades', array("lessonid"=>$lesson->id, "userid"=>$attempt->userid), 'completed', '*', $attempt->retry, 1)) {
103                 print_error('cannotfindgrade', 'lesson');
104             }
106             $essayinfo = new stdClass;
107             $essayinfo = unserialize($attempt->useranswer);
109             $essayinfo->graded = 1;
110             $essayinfo->score = $form->score;
111             $essayinfo->response = clean_param($form->response, PARAM_RAW);
112             $essayinfo->sent = 0;
113             if (!$lesson->custom && $essayinfo->score == 1) {
114                 $attempt->correct = 1;
115             } else {
116                 $attempt->correct = 0;
117             }
119             $attempt->useranswer = serialize($essayinfo);
121             $DB->update_record('lesson_attempts', $attempt);
123             // Get grade information
124             $grade = current($grades);
125             $gradeinfo = lesson_grade($lesson, $attempt->retry, $attempt->userid);
127             // Set and update
128             $updategrade = new stdClass();
129             $updategrade->id = $grade->id;
130             $updategrade->grade = $gradeinfo->grade;
131             $DB->update_record('lesson_grades', $updategrade);
132             // Log it
133             add_to_log($course->id, 'lesson', 'update grade', "essay.php?id=$cm->id", $lesson->name, $cm->id);
135             $lesson->add_message(get_string('changessaved'), 'notifysuccess');
137             // update central gradebook
138             lesson_update_grades($lesson, $grade->userid);
140             redirect(new moodle_url('/mod/lesson/essay.php', array('id'=>$cm->id)));
141         } else {
142             print_error('invalidformdata');
143         }
144         break;
145     case 'email':
146         // Sending an email(s) to a single user or all
147         require_sesskey();
149         // Get our users (could be singular)
150         if ($userid = optional_param('userid', 0, PARAM_INT)) {
151             $queryadd = " AND userid = ?";
152             if (! $users = $DB->get_records('user', array('id' => $userid))) {
153                 print_error('cannotfinduser', 'lesson');
154             }
155         } else {
156             $queryadd = '';
157             $params = array ("lessonid" => $lesson->id);
158             // Need to use inner view to avoid distinct + text
159             if (!$users = $DB->get_records_sql("
160                 SELECT u.*
161                   FROM {user} u
162                   JOIN (
163                            SELECT DISTINCT userid
164                              FROM {lesson_attempts}
165                             WHERE lessonid = :lessonid
166                        ) ui ON u.id = ui.userid", $params)) {
167                 print_error('cannotfinduser', 'lesson');
168             }
169         }
171         $pages = $lesson->load_all_pages();
172         foreach ($pages as $key=>$page) {
173             if ($page->qtype !== LESSON_PAGE_ESSAY) {
174                 unset($pages[$key]);
175             }
176         }
178         // Get only the attempts that are in response to essay questions
179         list($usql, $params) = $DB->get_in_or_equal(array_keys($pages));
180         if (!empty($queryadd)) {
181             $params[] = $userid;
182         }
183         if (!$attempts = $DB->get_records_select('lesson_attempts', "pageid $usql".$queryadd, $params)) {
184             print_error('nooneansweredthisquestion', 'lesson');
185         }
186         // Get the answers
187         list($answerUsql, $parameters) = $DB->get_in_or_equal(array_keys($pages));
188         array_unshift($parameters, $lesson->id);
189         if (!$answers = $DB->get_records_select('lesson_answers', "lessonid = ? AND pageid $answerUsql", $parameters, '', 'pageid, score')) {
190             print_error('cannotfindanswer', 'lesson');
191         }
192         $options = new stdClass;
193         $options->noclean = true;
195         foreach ($attempts as $attempt) {
196             $essayinfo = unserialize($attempt->useranswer);
197             if ($essayinfo->graded && !$essayinfo->sent) {
198                 // Holds values for the essayemailsubject string for the email message
199                 $a = new stdClass;
201                 // Set the grade
202                 $grades = $DB->get_records('lesson_grades', array("lessonid"=>$lesson->id, "userid"=>$attempt->userid), 'completed', '*', $attempt->retry, 1);
203                 $grade  = current($grades);
204                 $a->newgrade = $grade->grade;
206                 // Set the points
207                 if ($lesson->custom) {
208                     $a->earned = $essayinfo->score;
209                     $a->outof  = $answers[$attempt->pageid]->score;
210                 } else {
211                     $a->earned = $essayinfo->score;
212                     $a->outof  = 1;
213                 }
215                 // Set rest of the message values
216                 $currentpage = $lesson->load_page($attempt->pageid);
217                 $a->question = format_text($currentpage->contents, $currentpage->contentsformat, $options);
218                 $a->response = s($essayinfo->answer);
219                 $a->comment  = s($essayinfo->response);
221                 // Fetch message HTML and plain text formats
222                 $message  = get_string('essayemailmessage2', 'lesson', $a);
223                 $plaintext = format_text_email($message, FORMAT_HTML);
225                 // Subject
226                 $subject = get_string('essayemailsubject', 'lesson', format_string($pages[$attempt->pageid]->title,true));
228                 $eventdata = new stdClass();
229                 $eventdata->modulename       = 'lesson';
230                 $eventdata->userfrom         = $USER;
231                 $eventdata->userto           = $users[$attempt->userid];
232                 $eventdata->subject          = $subject;
233                 $eventdata->fullmessage      = $plaintext;
234                 $eventdata->fullmessageformat = FORMAT_PLAIN;
235                 $eventdata->fullmessagehtml  = $message;
236                 $eventdata->smallmessage     = '';
238                 // Required for messaging framework
239                 $eventdata->component = 'mod_lesson';
240                 $eventdata->name = 'graded_essay';
242                 message_send($eventdata);
243                 $essayinfo->sent = 1;
244                 $attempt->useranswer = serialize($essayinfo);
245                 $DB->update_record('lesson_attempts', $attempt);
246             }
247         }
248         $lesson->add_message(get_string('emailsuccess', 'lesson'), 'notifysuccess');
249         redirect(new moodle_url('/mod/lesson/essay.php', array('id'=>$cm->id)));
250         break;
251     case 'display':  // Default view - get the necessary data
252     default:
253         // Get lesson pages that are essay
254         $pages = $lesson->load_all_pages();
255         foreach ($pages as $key=>$page) {
256             if ($page->qtype !== LESSON_PAGE_ESSAY) {
257                 unset($pages[$key]);
258             }
259         }
260         if (count($pages) > 0) {
261             $params = array ("lessonid" => $lesson->id, "qtype" => LESSON_PAGE_ESSAY);
262             // Get only the attempts that are in response to essay questions
263             list($usql, $parameters) = $DB->get_in_or_equal(array_keys($pages));
264             if ($essayattempts = $DB->get_records_select('lesson_attempts', 'pageid '.$usql, $parameters)) {
265                 // Get all the users who have taken this lesson, order by their last name
266                 $ufields = user_picture::fields('u');
267                 list($sort, $sortparams) = users_order_by_sql('u');
268                 $params = array_merge($params, $sortparams);
269                 if (!empty($cm->groupingid)) {
270                     $params["groupingid"] = $cm->groupingid;
271                     $sql = "SELECT DISTINCT $ufields
272                             FROM {lesson_attempts} a
273                                 INNER JOIN {user} u ON u.id = a.userid
274                                 INNER JOIN {groups_members} gm ON gm.userid = u.id
275                                 INNER JOIN {groupings_groups} gg ON gm.groupid = gg.groupid AND gg.groupingid = :groupingid
276                             WHERE a.lessonid = :lessonid
277                             ORDER BY $sort";
278                 } else {
279                     $sql = "SELECT DISTINCT $ufields
280                             FROM {user} u,
281                                  {lesson_attempts} a
282                             WHERE a.lessonid = :lessonid and
283                                   u.id = a.userid
284                             ORDER BY $sort";
285                 }
286                 if (!$users = $DB->get_records_sql($sql, $params)) {
287                     $mode = 'none'; // not displaying anything
288                     $lesson->add_message(get_string('noonehasanswered', 'lesson'));
289                 }
290             } else {
291                 $mode = 'none'; // not displaying anything
292                 $lesson->add_message(get_string('noonehasanswered', 'lesson'));
293             }
294         } else {
295             $mode = 'none'; // not displaying anything
296             $lesson->add_message(get_string('noessayquestionsfound', 'lesson'));
297         }
298         break;
301 $lessonoutput = $PAGE->get_renderer('mod_lesson');
302 echo $lessonoutput->header($lesson, $cm, 'essay', false, null, get_string('manualgrading', 'lesson'));
304 switch ($mode) {
305     case 'display':
306         // Expects $user, $essayattempts and $pages to be set already
308         // Group all the essays by userid
309         $studentessays = array();
310         foreach ($essayattempts as $essay) {
311             // Not very nice :) but basically
312             //   this organizes the essays so we know how many
313             //   times a student answered an essay per try and per page
314             $studentessays[$essay->userid][$essay->pageid][$essay->retry][] = $essay;
315         }
317         // Setup table
318         $table = new html_table();
319         $table->head = array(get_string('name'), get_string('essays', 'lesson'), get_string('email', 'lesson'));
320         $table->attributes['class'] = 'standardtable generaltable';
321         $table->align = array('left', 'left', 'left');
322         $table->wrap = array('nowrap', 'nowrap', '');
324         // Cycle through all the students
325         foreach (array_keys($studentessays) as $userid) {
326             $studentname = fullname($users[$userid], true);
327             $essaylinks = array();
329             // Number of attempts on the lesson
330             $attempts = $DB->count_records('lesson_grades', array('userid'=>$userid, 'lessonid'=>$lesson->id));
332             // Go through each essay page
333             foreach ($studentessays[$userid] as $page => $tries) {
334                 $count = 0;
336                 // Go through each attempt per page
337                 foreach($tries as $try) {
338                     if ($count == $attempts) {
339                         break;  // Stop displaying essays (attempt not completed)
340                     }
341                     $count++;
343                     // Make sure they didn't answer it more than the max number of attmepts
344                     if (count($try) > $lesson->maxattempts) {
345                         $essay = $try[$lesson->maxattempts-1];
346                     } else {
347                         $essay = end($try);
348                     }
350                     // Start processing the attempt
351                     $essayinfo = unserialize($essay->useranswer);
353                     // link for each essay
354                     $url = new moodle_url('/mod/lesson/essay.php', array('id'=>$cm->id,'mode'=>'grade','attemptid'=>$essay->id,'sesskey'=>sesskey()));
355                     $attributes = array();
356                     // Different colors for all the states of an essay (graded, if sent, not graded)
357                     if (!$essayinfo->graded) {
358                         $attributes['class'] = "graded";
359                     } elseif (!$essayinfo->sent) {
360                         $attributes['class'] = "sent";
361                     } else {
362                         $attributes['class'] = "ungraded";
363                     }
364                     $essaylinks[] = html_writer::link($url, userdate($essay->timeseen, get_string('strftimedatetime')).' '.format_string($pages[$essay->pageid]->title,true), $attributes);
365                 }
366             }
367             // email link for this user
368             $url = new moodle_url('/mod/lesson/essay.php', array('id'=>$cm->id,'mode'=>'email','userid'=>$userid,'sesskey'=>sesskey()));
369             $emaillink = html_writer::link($url, get_string('emailgradedessays', 'lesson'));
371             $table->data[] = array($OUTPUT->user_picture($users[$userid], array('courseid'=>$course->id)).$studentname, implode("<br />", $essaylinks), $emaillink);
372         }
374         // email link for all users
375         $url = new moodle_url('/mod/lesson/essay.php', array('id'=>$cm->id,'mode'=>'email','sesskey'=>sesskey()));
376         $emailalllink = html_writer::link($url, get_string('emailallgradedessays', 'lesson'));
378         $table->data[] = array(' ', ' ', $emailalllink);
380         echo html_writer::table($table);
381         break;
382     case 'grade':
383         // Trigger the essay grade viewed event.
384         $event = \mod_lesson\event\essay_attempt_viewed::create(array(
385             'objectid' => $attempt->id,
386             'relateduserid' => $attempt->userid,
387             'context' => $context,
388             'courseid' => $course->id,
389         ));
390         $event->add_record_snapshot('lesson_attempts', $attempt);
391         $event->trigger();
393         // Grading form
394         // Expects the following to be set: $attemptid, $answer, $user, $page, $attempt
395         $essayinfo = unserialize($attempt->useranswer);
396         $currentpage = $lesson->load_page($attempt->pageid);
398         $mform = new essay_grading_form(null, array('scoreoptions'=>$scoreoptions, 'user'=>$user));
399         $data = new stdClass;
400         $data->id = $cm->id;
401         $data->attemptid = $attemptid;
402         $data->score = $essayinfo->score;
403         $data->question = format_string($currentpage->contents, $currentpage->contentsformat);
404         $data->studentanswer = format_string($essayinfo->answer, $essayinfo->answerformat);
405         $data->response = $essayinfo->response;
406         $mform->set_data($data);
408         $mform->display();
409         break;
412 echo $OUTPUT->footer();