MDL-40060 mod_book: Replace add_to_log with events
[moodle.git] / mod / book / view.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Book view page
19  *
20  * @package    mod_book
21  * @copyright  2004-2011 Petr Skoda {@link http://skodak.org}
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 require(dirname(__FILE__).'/../../config.php');
26 require_once(dirname(__FILE__).'/locallib.php');
27 require_once($CFG->libdir.'/completionlib.php');
29 $id        = optional_param('id', 0, PARAM_INT);        // Course Module ID
30 $bid       = optional_param('b', 0, PARAM_INT);         // Book id
31 $chapterid = optional_param('chapterid', 0, PARAM_INT); // Chapter ID
32 $edit      = optional_param('edit', -1, PARAM_BOOL);    // Edit mode
34 // =========================================================================
35 // security checks START - teachers edit; students view
36 // =========================================================================
37 if ($id) {
38     $cm = get_coursemodule_from_id('book', $id, 0, false, MUST_EXIST);
39     $course = $DB->get_record('course', array('id'=>$cm->course), '*', MUST_EXIST);
40     $book = $DB->get_record('book', array('id'=>$cm->instance), '*', MUST_EXIST);
41 } else {
42     $book = $DB->get_record('book', array('id'=>$bid), '*', MUST_EXIST);
43     $cm = get_coursemodule_from_instance('book', $book->id, 0, false, MUST_EXIST);
44     $course = $DB->get_record('course', array('id'=>$cm->course), '*', MUST_EXIST);
45     $id = $cm->id;
46 }
48 require_course_login($course, true, $cm);
50 $context = context_module::instance($cm->id);
51 require_capability('mod/book:read', $context);
53 $allowedit  = has_capability('mod/book:edit', $context);
54 $viewhidden = has_capability('mod/book:viewhiddenchapters', $context);
56 if ($allowedit) {
57     if ($edit != -1 and confirm_sesskey()) {
58         $USER->editing = $edit;
59     } else {
60         if (isset($USER->editing)) {
61             $edit = $USER->editing;
62         } else {
63             $edit = 0;
64         }
65     }
66 } else {
67     $edit = 0;
68 }
70 // read chapters
71 $chapters = book_preload_chapters($book);
73 if ($allowedit and !$chapters) {
74     redirect('edit.php?cmid='.$cm->id); // No chapters - add new one.
75 }
76 // Check chapterid and read chapter data
77 if ($chapterid == '0') { // Go to first chapter if no given.
78     $params = array(
79         'context' => $context,
80         'objectid' => $book->id
81     );
82     $event = \mod_book\event\course_module_viewed::create($params);
83     $event->add_record_snapshot('book', $book);
84     $event->trigger();
86     foreach ($chapters as $ch) {
87         if ($edit) {
88             $chapterid = $ch->id;
89             break;
90         }
91         if (!$ch->hidden) {
92             $chapterid = $ch->id;
93             break;
94         }
95     }
96 }
98 $courseurl = new moodle_url('/course/view.php', array('id' => $course->id));
100 // No content in the book.
101 if (!$chapterid) {
102     $PAGE->set_url('/mod/book/view.php', array('id' => $id));
103     notice(get_string('nocontent', 'mod_book'), $courseurl->out(false));
105 // Chapter doesnt exist or it is hidden for students
106 if ((!$chapter = $DB->get_record('book_chapters', array('id' => $chapterid, 'bookid' => $book->id))) or ($chapter->hidden and !$viewhidden)) {
107     print_error('errorchapter', 'mod_book', $courseurl);
110 $PAGE->set_url('/mod/book/view.php', array('id'=>$id, 'chapterid'=>$chapterid));
113 // Unset all page parameters.
114 unset($id);
115 unset($bid);
116 unset($chapterid);
118 // Security checks END.
120 $params = array(
121     'context' => $context,
122     'objectid' => $chapter->id
123 );
124 $event = \mod_book\event\chapter_viewed::create($params);
125 $event->add_record_snapshot('book_chapters', $chapter);
126 $event->trigger();
128 // Read standard strings.
129 $strbooks = get_string('modulenameplural', 'mod_book');
130 $strbook  = get_string('modulename', 'mod_book');
131 $strtoc   = get_string('toc', 'mod_book');
133 // prepare header
134 $pagetitle = $book->name . ": " . $chapter->title;
135 $PAGE->set_title($pagetitle);
136 $PAGE->set_heading($course->fullname);
138 book_add_fake_block($chapters, $chapter, $book, $cm, $edit);
140 // prepare chapter navigation icons
141 $previd = null;
142 $nextid = null;
143 $last = null;
144 foreach ($chapters as $ch) {
145     if (!$edit and $ch->hidden) {
146         continue;
147     }
148     if ($last == $chapter->id) {
149         $nextid = $ch->id;
150         break;
151     }
152     if ($ch->id != $chapter->id) {
153         $previd = $ch->id;
154     }
155     $last = $ch->id;
158 $navprevicon = right_to_left() ? 'nav_next' : 'nav_prev';
159 $navnexticon = right_to_left() ? 'nav_prev' : 'nav_next';
160 $navprevdisicon = right_to_left() ? 'nav_next_dis' : 'nav_prev_dis';
162 $chnavigation = '';
163 if ($previd) {
164     $chnavigation .= '<a title="'.get_string('navprev', 'book').'" href="view.php?id='.$cm->id.
165             '&amp;chapterid='.$previd.'"><img src="'.$OUTPUT->pix_url($navprevicon, 'mod_book').'" class="icon" alt="'.get_string('navprev', 'book').'"/></a>';
166 } else {
167     $chnavigation .= '<img src="'.$OUTPUT->pix_url($navprevdisicon, 'mod_book').'" class="icon" alt="" />';
169 if ($nextid) {
170     $chnavigation .= '<a title="'.get_string('navnext', 'book').'" href="view.php?id='.$cm->id.
171             '&amp;chapterid='.$nextid.'"><img src="'.$OUTPUT->pix_url($navnexticon, 'mod_book').'" class="icon" alt="'.get_string('navnext', 'book').'" /></a>';
172 } else {
173     $sec = $DB->get_field('course_sections', 'section', array('id' => $cm->section));
174     $returnurl = course_get_url($course, $sec);
175     $chnavigation .= '<a title="'.get_string('navexit', 'book').'" href="'.$returnurl.'"><img src="'.$OUTPUT->pix_url('nav_exit', 'mod_book').
176             '" class="icon" alt="'.get_string('navexit', 'book').'" /></a>';
178     // we are cheating a bit here, viewing the last page means user has viewed the whole book
179     $completion = new completion_info($course);
180     $completion->set_module_viewed($cm);
183 // =====================================================
184 // Book display HTML code
185 // =====================================================
187 echo $OUTPUT->header();
188 echo $OUTPUT->heading($book->name);
190 // upper nav
191 echo '<div class="navtop">'.$chnavigation.'</div>';
193 // chapter itself
194 $hidden = $chapter->hidden ? ' dimmed_text' : null;
195 echo $OUTPUT->box_start('generalbox book_content' . $hidden);
197 if (!$book->customtitles) {
198     if (!$chapter->subchapter) {
199         $currtitle = book_get_chapter_title($chapter->id, $chapters, $book, $context);
200         echo $OUTPUT->heading($currtitle, 3);
201     } else {
202         $currtitle = book_get_chapter_title($chapters[$chapter->id]->parent, $chapters, $book, $context);
203         $currsubtitle = book_get_chapter_title($chapter->id, $chapters, $book, $context);
204         echo $OUTPUT->heading($currtitle, 3);
205         echo $OUTPUT->heading($currsubtitle, 4);
206     }
208 $chaptertext = file_rewrite_pluginfile_urls($chapter->content, 'pluginfile.php', $context->id, 'mod_book', 'chapter', $chapter->id);
209 echo format_text($chaptertext, $chapter->contentformat, array('noclean'=>true, 'overflowdiv'=>true, 'context'=>$context));
211 echo $OUTPUT->box_end();
213 // lower navigation
214 echo '<div class="navbottom">'.$chnavigation.'</div>';
216 echo $OUTPUT->footer();