view.php 7.55 KB
Newer Older
1
<?php
2
// This file is part of Moodle - http://moodle.org/
Petr Skoda's avatar
Petr Skoda committed
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
//
// 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/>.

/**
 * Book view page
 *
20
21
 * @package    mod_book
 * @copyright  2004-2011 Petr Skoda {@link http://skodak.org}
Petr Skoda's avatar
Petr Skoda committed
22
23
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
Petr Skoda's avatar
Petr Skoda committed
24

Petr Skoda's avatar
Petr Skoda committed
25
26
require(dirname(__FILE__).'/../../config.php');
require_once(dirname(__FILE__).'/locallib.php');
Petr Skoda's avatar
Petr Skoda committed
27
require_once($CFG->libdir.'/completionlib.php');
Petr Skoda's avatar
Petr Skoda committed
28

Petr Skoda's avatar
Petr Skoda committed
29
30
$id        = optional_param('id', 0, PARAM_INT);        // Course Module ID
$bid       = optional_param('b', 0, PARAM_INT);         // Book id
Petr Skoda's avatar
Petr Skoda committed
31
$chapterid = optional_param('chapterid', 0, PARAM_INT); // Chapter ID
32
$edit      = optional_param('edit', -1, PARAM_BOOL);    // Edit mode
Petr Skoda's avatar
Petr Skoda committed
33
34
35
36

// =========================================================================
// security checks START - teachers edit; students view
// =========================================================================
Petr Skoda's avatar
Petr Skoda committed
37
38
39
40
41
42
if ($id) {
    $cm = get_coursemodule_from_id('book', $id, 0, false, MUST_EXIST);
    $course = $DB->get_record('course', array('id'=>$cm->course), '*', MUST_EXIST);
    $book = $DB->get_record('book', array('id'=>$cm->instance), '*', MUST_EXIST);
} else {
    $book = $DB->get_record('book', array('id'=>$bid), '*', MUST_EXIST);
43
    $cm = get_coursemodule_from_instance('book', $book->id, 0, false, MUST_EXIST);
Petr Skoda's avatar
Petr Skoda committed
44
45
46
    $course = $DB->get_record('course', array('id'=>$cm->course), '*', MUST_EXIST);
    $id = $cm->id;
}
Petr Skoda's avatar
Petr Skoda committed
47

48
49
require_course_login($course, true, $cm);

50
$context = context_module::instance($cm->id);
51
52
require_capability('mod/book:read', $context);

53
54
$allowedit  = has_capability('mod/book:edit', $context);
$viewhidden = has_capability('mod/book:viewhiddenchapters', $context);
55
56

if ($allowedit) {
Petr Skoda's avatar
Petr Skoda committed
57
    if ($edit != -1 and confirm_sesskey()) {
Petr Skoda's avatar
Petr Skoda committed
58
59
60
61
62
63
64
65
66
67
68
69
        $USER->editing = $edit;
    } else {
        if (isset($USER->editing)) {
            $edit = $USER->editing;
        } else {
            $edit = 0;
        }
    }
} else {
    $edit = 0;
}

70
// read chapters
71
$chapters = book_preload_chapters($book);
Petr Skoda's avatar
Petr Skoda committed
72

73
if ($allowedit and !$chapters) {
74
    redirect('edit.php?cmid='.$cm->id); // No chapters - add new one.
Petr Skoda's avatar
Petr Skoda committed
75
}
76
77
// Check chapterid and read chapter data
if ($chapterid == '0') { // Go to first chapter if no given.
78
79
80
81
82
    $params = array(
        'context' => $context,
        'objectid' => $book->id
    );
    $event = \mod_book\event\course_module_viewed::create($params);
83
84
    $event->add_record_snapshot('course_modules', $cm);
    $event->add_record_snapshot('course', $course);
85
86
87
    $event->add_record_snapshot('book', $book);
    $event->trigger();

88
    foreach ($chapters as $ch) {
Petr Skoda's avatar
Petr Skoda committed
89
        if ($edit) {
Petr Skoda's avatar
Petr Skoda committed
90
91
92
93
94
95
96
97
98
99
            $chapterid = $ch->id;
            break;
        }
        if (!$ch->hidden) {
            $chapterid = $ch->id;
            break;
        }
    }
}

100
$courseurl = new moodle_url('/course/view.php', array('id' => $course->id));
101

102
103
104
105
106
107
108
109
// No content in the book.
if (!$chapterid) {
    $PAGE->set_url('/mod/book/view.php', array('id' => $id));
    notice(get_string('nocontent', 'mod_book'), $courseurl->out(false));
}
// Chapter doesnt exist or it is hidden for students
if ((!$chapter = $DB->get_record('book_chapters', array('id' => $chapterid, 'bookid' => $book->id))) or ($chapter->hidden and !$viewhidden)) {
    print_error('errorchapter', 'mod_book', $courseurl);
110
}
111

Petr Skoda's avatar
Petr Skoda committed
112
$PAGE->set_url('/mod/book/view.php', array('id'=>$id, 'chapterid'=>$chapterid));
Petr Skoda's avatar
Petr Skoda committed
113
114


115
// Unset all page parameters.
Petr Skoda's avatar
Petr Skoda committed
116
unset($id);
Petr Skoda's avatar
Petr Skoda committed
117
unset($bid);
Petr Skoda's avatar
Petr Skoda committed
118
119
unset($chapterid);

120
// Security checks END.
Petr Skoda's avatar
Petr Skoda committed
121

122
123
124
125
126
127
128
$params = array(
    'context' => $context,
    'objectid' => $chapter->id
);
$event = \mod_book\event\chapter_viewed::create($params);
$event->add_record_snapshot('book_chapters', $chapter);
$event->trigger();
Petr Skoda's avatar
Petr Skoda committed
129

130
// Read standard strings.
131
132
133
$strbooks = get_string('modulenameplural', 'mod_book');
$strbook  = get_string('modulename', 'mod_book');
$strtoc   = get_string('toc', 'mod_book');
Petr Skoda's avatar
Petr Skoda committed
134

135
// prepare header
136
137
$pagetitle = $book->name . ": " . $chapter->title;
$PAGE->set_title($pagetitle);
138
$PAGE->set_heading($course->fullname);
139
140
141

book_add_fake_block($chapters, $chapter, $book, $cm, $edit);

142
// prepare chapter navigation icons
Petr Skoda's avatar
Petr Skoda committed
143
144
$previd = null;
$nextid = null;
Petr Skoda's avatar
Petr Skoda committed
145
$last = null;
Petr Skoda's avatar
Petr Skoda committed
146
foreach ($chapters as $ch) {
Petr Skoda's avatar
Petr Skoda committed
147
    if (!$edit and $ch->hidden) {
Petr Skoda's avatar
Petr Skoda committed
148
        continue;
Petr Skoda's avatar
Petr Skoda committed
149
    }
Petr Skoda's avatar
Petr Skoda committed
150
151
152
    if ($last == $chapter->id) {
        $nextid = $ch->id;
        break;
Petr Skoda's avatar
Petr Skoda committed
153
    }
Petr Skoda's avatar
Petr Skoda committed
154
    if ($ch->id != $chapter->id) {
Petr Skoda's avatar
Petr Skoda committed
155
156
        $previd = $ch->id;
    }
Petr Skoda's avatar
Petr Skoda committed
157
    $last = $ch->id;
Petr Skoda's avatar
Petr Skoda committed
158
}
Petr Skoda's avatar
Petr Skoda committed
159

160
161
162
163
$navprevicon = right_to_left() ? 'nav_next' : 'nav_prev';
$navnexticon = right_to_left() ? 'nav_prev' : 'nav_next';
$navprevdisicon = right_to_left() ? 'nav_next_dis' : 'nav_prev_dis';

Petr Skoda's avatar
Petr Skoda committed
164
165
$chnavigation = '';
if ($previd) {
166
    $chnavigation .= '<a title="'.get_string('navprev', 'book').'" href="view.php?id='.$cm->id.
167
            '&amp;chapterid='.$previd.'"><img src="'.$OUTPUT->pix_url($navprevicon, 'mod_book').'" class="icon" alt="'.get_string('navprev', 'book').'"/></a>';
Petr Skoda's avatar
Petr Skoda committed
168
} else {
169
    $chnavigation .= '<img src="'.$OUTPUT->pix_url($navprevdisicon, 'mod_book').'" class="icon" alt="" />';
Petr Skoda's avatar
Petr Skoda committed
170
171
}
if ($nextid) {
172
    $chnavigation .= '<a title="'.get_string('navnext', 'book').'" href="view.php?id='.$cm->id.
173
            '&amp;chapterid='.$nextid.'"><img src="'.$OUTPUT->pix_url($navnexticon, 'mod_book').'" class="icon" alt="'.get_string('navnext', 'book').'" /></a>';
Petr Skoda's avatar
Petr Skoda committed
174
} else {
175
176
    $sec = $DB->get_field('course_sections', 'section', array('id' => $cm->section));
    $returnurl = course_get_url($course, $sec);
177
    $chnavigation .= '<a title="'.get_string('navexit', 'book').'" href="'.$returnurl.'"><img src="'.$OUTPUT->pix_url('nav_exit', 'mod_book').
178
            '" class="icon" alt="'.get_string('navexit', 'book').'" /></a>';
Petr Skoda's avatar
Petr Skoda committed
179
180
181
182

    // we are cheating a bit here, viewing the last page means user has viewed the whole book
    $completion = new completion_info($course);
    $completion->set_module_viewed($cm);
Petr Skoda's avatar
Petr Skoda committed
183
184
185
186
187
188
}

// =====================================================
// Book display HTML code
// =====================================================

189
echo $OUTPUT->header();
190
echo $OUTPUT->heading($book->name);
191

Petr Skoda's avatar
Petr Skoda committed
192
// upper nav
Petr Skoda's avatar
Petr Skoda committed
193
echo '<div class="navtop">'.$chnavigation.'</div>';
Petr Skoda's avatar
Petr Skoda committed
194
195

// chapter itself
196
197
198
$hidden = $chapter->hidden ? ' dimmed_text' : null;
echo $OUTPUT->box_start('generalbox book_content' . $hidden);

Petr Skoda's avatar
Petr Skoda committed
199
if (!$book->customtitles) {
200
201
    if (!$chapter->subchapter) {
        $currtitle = book_get_chapter_title($chapter->id, $chapters, $book, $context);
202
        echo $OUTPUT->heading($currtitle, 3);
203
204
205
    } else {
        $currtitle = book_get_chapter_title($chapters[$chapter->id]->parent, $chapters, $book, $context);
        $currsubtitle = book_get_chapter_title($chapter->id, $chapters, $book, $context);
206
207
        echo $OUTPUT->heading($currtitle, 3);
        echo $OUTPUT->heading($currsubtitle, 4);
208
    }
Petr Skoda's avatar
Petr Skoda committed
209
210
}
$chaptertext = file_rewrite_pluginfile_urls($chapter->content, 'pluginfile.php', $context->id, 'mod_book', 'chapter', $chapter->id);
211
echo format_text($chaptertext, $chapter->contentformat, array('noclean'=>true, 'overflowdiv'=>true, 'context'=>$context));
Petr Skoda's avatar
Petr Skoda committed
212

Petr Skoda's avatar
Petr Skoda committed
213
214
echo $OUTPUT->box_end();

215
// lower navigation
Petr Skoda's avatar
Petr Skoda committed
216
echo '<div class="navbottom">'.$chnavigation.'</div>';
Petr Skoda's avatar
Petr Skoda committed
217

Petr Skoda's avatar
Petr Skoda committed
218
echo $OUTPUT->footer();