Merge branch 'MDL-57643-master' of git://github.com/jleyva/moodle
[moodle.git] / mod / lesson / continue.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  * Action for processing page answers by users
20  *
21  * @package mod_lesson
22  * @copyright  2009 Sam Hemelryk
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  **/
26 /** Require the specific libraries */
27 require_once("../../config.php");
28 require_once($CFG->dirroot.'/mod/lesson/locallib.php');
30 $id = required_param('id', PARAM_INT);
32 $cm = get_coursemodule_from_id('lesson', $id, 0, false, MUST_EXIST);
33 $course = $DB->get_record('course', array('id' => $cm->course), '*', MUST_EXIST);
34 $lesson = new lesson($DB->get_record('lesson', array('id' => $cm->instance), '*', MUST_EXIST));
36 require_login($course, false, $cm);
37 require_sesskey();
39 // Apply overrides.
40 $lesson->update_effective_access($USER->id);
42 $context = context_module::instance($cm->id);
43 $canmanage = has_capability('mod/lesson:manage', $context);
44 $lessonoutput = $PAGE->get_renderer('mod_lesson');
46 $url = new moodle_url('/mod/lesson/continue.php', array('id'=>$cm->id));
47 $PAGE->set_url($url);
48 $PAGE->set_pagetype('mod-lesson-view');
49 $PAGE->navbar->add(get_string('continue', 'lesson'));
51 // This is the code updates the lesson time for a timed test
52 // get time information for this user
53 if (!$canmanage) {
54     $lesson->displayleft = lesson_displayleftif($lesson);
55     $timer = $lesson->update_timer();
56     if ($lesson->timelimit) {
57         $timeleft = ($timer->starttime + $lesson->timelimit) - time();
58         if ($timeleft <= 0) {
59             // Out of time
60             $lesson->add_message(get_string('eolstudentoutoftime', 'lesson'));
61             redirect(new moodle_url('/mod/lesson/view.php', array('id'=>$cm->id,'pageid'=>LESSON_EOL, 'outoftime'=>'normal')));
62         } else if ($timeleft < 60) {
63             // One minute warning
64             $lesson->add_message(get_string("studentoneminwarning", "lesson"));
65         }
66     }
67 } else {
68     $timer = new stdClass;
69 }
71 // record answer (if necessary) and show response (if none say if answer is correct or not)
72 $page = $lesson->load_page(required_param('pageid', PARAM_INT));
74 $reviewmode = $lesson->is_in_review_mode();
76 // Check the page has answers [MDL-25632]
77 if (count($page->answers) > 0) {
78     $result = $page->record_attempt($context);
79 } else {
80     // The page has no answers so we will just progress to the next page in the
81     // sequence (as set by newpageid).
82     $result = new stdClass;
83     $result->newpageid       = optional_param('newpageid', $page->nextpageid, PARAM_INT);
84     $result->nodefaultresponse  = true;
85 }
87 if (isset($USER->modattempts[$lesson->id])) {
88     // make sure if the student is reviewing, that he/she sees the same pages/page path that he/she saw the first time
89     if ($USER->modattempts[$lesson->id]->pageid == $page->id && $page->nextpageid == 0) {  // remember, this session variable holds the pageid of the last page that the user saw
90         $result->newpageid = LESSON_EOL;
91     } else {
92         $nretakes = $DB->count_records("lesson_grades", array("lessonid"=>$lesson->id, "userid"=>$USER->id));
93         $nretakes--; // make sure we are looking at the right try.
94         $attempts = $DB->get_records("lesson_attempts", array("lessonid"=>$lesson->id, "userid"=>$USER->id, "retry"=>$nretakes), "timeseen", "id, pageid");
95         $found = false;
96         $temppageid = 0;
97         // Make sure that the newpageid always defaults to something valid.
98         $result->newpageid = LESSON_EOL;
99         foreach($attempts as $attempt) {
100             if ($found && $temppageid != $attempt->pageid) { // now try to find the next page, make sure next few attempts do no belong to current page
101                 $result->newpageid = $attempt->pageid;
102                 break;
103             }
104             if ($attempt->pageid == $page->id) {
105                 $found = true; // if found current page
106                 $temppageid = $attempt->pageid;
107             }
108         }
109     }
110 } elseif ($result->newpageid != LESSON_CLUSTERJUMP && $page->id != 0 && $result->newpageid > 0) {
111     // going to check to see if the page that the user is going to view next, is a cluster page.
112     // If so, dont display, go into the cluster.  The $result->newpageid > 0 is used to filter out all of the negative code jumps.
113     $newpage = $lesson->load_page($result->newpageid);
114     if ($newpageid = $newpage->override_next_page($result->newpageid)) {
115         $result->newpageid = $newpageid;
116     }
117 } elseif ($result->newpageid == LESSON_UNSEENBRANCHPAGE) {
118     if ($canmanage) {
119         if ($page->nextpageid == 0) {
120             $result->newpageid = LESSON_EOL;
121         } else {
122             $result->newpageid = $page->nextpageid;
123         }
124     } else {
125         $result->newpageid = lesson_unseen_question_jump($lesson, $USER->id, $page->id);
126     }
127 } elseif ($result->newpageid == LESSON_PREVIOUSPAGE) {
128     $result->newpageid = $page->prevpageid;
129 } elseif ($result->newpageid == LESSON_RANDOMPAGE) {
130     $result->newpageid = lesson_random_question_jump($lesson, $page->id);
131 } elseif ($result->newpageid == LESSON_CLUSTERJUMP) {
132     if ($canmanage) {
133         if ($page->nextpageid == 0) {  // if teacher, go to next page
134             $result->newpageid = LESSON_EOL;
135         } else {
136             $result->newpageid = $page->nextpageid;
137         }
138     } else {
139         $result->newpageid = $lesson->cluster_jump($page->id);
140     }
143 if ($result->nodefaultresponse) {
144     // Don't display feedback
145     redirect(new moodle_url('/mod/lesson/view.php', array('id'=>$cm->id,'pageid'=>$result->newpageid)));
148 /// Set Messages
150 if ($canmanage) {
151     // This is the warning msg for teachers to inform them that cluster and unseen does not work while logged in as a teacher
152     if(lesson_display_teacher_warning($lesson)) {
153         $warningvars = new stdClass();
154         $warningvars->cluster = get_string("clusterjump", "lesson");
155         $warningvars->unseen = get_string("unseenpageinbranch", "lesson");
156         $lesson->add_message(get_string("teacherjumpwarning", "lesson", $warningvars));
157     }
158     // Inform teacher that s/he will not see the timer
159     if ($lesson->timelimit) {
160         $lesson->add_message(get_string("teachertimerwarning", "lesson"));
161     }
163 // Report attempts remaining
164 if ($result->attemptsremaining != 0 && $lesson->review && !$reviewmode) {
165     $lesson->add_message(get_string('attemptsremaining', 'lesson', $result->attemptsremaining));
168 $PAGE->set_url('/mod/lesson/view.php', array('id' => $cm->id, 'pageid' => $page->id));
169 $PAGE->set_subpage($page->id);
171 /// Print the header, heading and tabs
172 lesson_add_fake_blocks($PAGE, $cm, $lesson, $timer);
173 echo $lessonoutput->header($lesson, $cm, 'view', true, $page->id, get_string('continue', 'lesson'));
175 if ($lesson->displayleft) {
176     echo '<a name="maincontent" id="maincontent" title="'.get_string('anchortitle', 'lesson').'"></a>';
178 // This calculates and prints the ongoing score message
179 if ($lesson->ongoing && !$reviewmode) {
180     echo $lessonoutput->ongoing_score($lesson);
182 if (!$reviewmode) {
183     echo $result->feedback;
186 // User is modifying attempts - save button and some instructions
187 if (isset($USER->modattempts[$lesson->id])) {
188     $url = $CFG->wwwroot.'/mod/lesson/view.php';
189     $content = $OUTPUT->box(get_string("gotoendoflesson", "lesson"), 'center');
190     $content .= $OUTPUT->box(get_string("or", "lesson"), 'center');
191     $content .= $OUTPUT->box(get_string("continuetonextpage", "lesson"), 'center');
192     $content .= html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'id', 'value'=>$cm->id));
193     $content .= html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'pageid', 'value'=>LESSON_EOL));
194     $content .= html_writer::empty_tag('input', array('type'=>'submit', 'name'=>'submit', 'value'=>get_string('finish', 'lesson')));
195     echo html_writer::tag('form', "<div>$content</div>", array('method'=>'post', 'action'=>$url));
198 // Review button back
199 if (!$result->correctanswer && !$result->noanswer && !$result->isessayquestion && !$reviewmode && $lesson->review && !$result->maxattemptsreached) {
200     $url = $CFG->wwwroot.'/mod/lesson/view.php';
201     $content = html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'id', 'value'=>$cm->id));
202     $content .= html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'pageid', 'value'=>$page->id));
203     $content .= html_writer::empty_tag('input', array('type'=>'submit', 'name'=>'submit', 'value'=>get_string('reviewquestionback', 'lesson')));
204     echo html_writer::tag('form', "<div class=\"singlebutton\">$content</div>", array('method'=>'post', 'action'=>$url));
207 $url = new moodle_url('/mod/lesson/view.php', array('id'=>$cm->id, 'pageid'=>$result->newpageid));
208 if ($lesson->review && !$result->correctanswer && !$result->noanswer && !$result->isessayquestion && !$result->maxattemptsreached) {
209     // Review button continue
210     echo $OUTPUT->single_button($url, get_string('reviewquestioncontinue', 'lesson'));
211 } else {
212     // Normal continue button
213     echo $OUTPUT->single_button($url, get_string('continue', 'lesson'));
216 echo $lessonoutput->footer();