forked from skodak/moodle-mod_book
-
Notifications
You must be signed in to change notification settings - Fork 0
/
locallib.php
404 lines (366 loc) · 13.7 KB
/
locallib.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
<?php
// This file is part of Book module for 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/>.
/**
* Book module local lib functions
*
* @package mod
* @subpackage book
* @copyright 2010-2011 Petr Skoda {@link http://skodak.org}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die;
require_once($CFG->dirroot.'/mod/book/lib.php');
require_once($CFG->libdir.'/filelib.php');
define('BOOK_NUM_NONE', '0');
define('BOOK_NUM_NUMBERS', '1');
define('BOOK_NUM_BULLETS', '2');
define('BOOK_NUM_INDENTED', '3');
/**
* Preload book chapters and fix toc structure if necessary.
*
* Returns array of chapters with standard 'pagenum', 'id, pagenum, subchapter, title, hidden'
* and extra 'parent, number, subchapters, prev, next'.
* Please note the content/text of chapters is not included.
*
* @param stdClass $book
* @return array of id=>chapter
*/
function book_preload_chapters($book) {
global $DB;
$chapters = $DB->get_records('book_chapters', array('bookid'=>$book->id), 'pagenum', 'id, pagenum, subchapter, title, hidden');
if (!$chapters) {
return array();
}
$prev = null;
$prevsub = null;
$first = true;
$hidesub = true;
$parent = null;
$pagenum = 0; // chapter sort
$i = 0; // main chapter num
$j = 0; // subchapter num
foreach($chapters as $id=>$ch) {
$oldch = clone($ch);
$pagenum++;
$ch->pagenum = $pagenum;
if ($first) {
// book can not start with a subchapter
$ch->subchapter = 0;
$first = false;
}
if (!$ch->subchapter) {
$ch->prev = $prev;
$ch->next = null;
if ($prev) {
$chapters[$prev]->next = $ch->id;
}
if ($ch->hidden) {
if ($book->numbering == BOOK_NUM_NUMBERS) {
$ch->number = 'x';
} else {
$ch->number = null;
}
} else {
$i++;
$ch->number = $i;
}
$j = 0;
$prevsub = null;
$hidesub = $ch->hidden;
$parent = $ch->id;
$ch->parent = null;
$ch->subchpaters = array();
} else {
$ch->prev = $prevsub;
$ch->next = null;
if ($prevsub) {
$chapters[$prevsub]->next = $ch->id;
}
$ch->parent = $parent;
$ch->subchpaters = null;
$chapters[$parent]->subchapters[$ch->id] = $ch->id;
if ($hidesub) {
// all subchapters in hidden chapter must be hidden too
$ch->hidden = 1;
}
if ($ch->hidden) {
if ($book->numbering == BOOK_NUM_NUMBERS) {
$ch->number = 'x';
} else {
$ch->number = null;
}
} else {
$j++;
$ch->number = $j;
}
}
if ($oldch->subchapter != $ch->subchapter or $oldch->pagenum != $ch->pagenum or $oldch->hidden != $ch->hidden) {
// update only if something changed
$DB->update_record('book_chapters', $ch);
}
$chapters[$id] = $ch;
}
return $chapters;
}
function book_get_chapter_title($chid, $chapters, $book, $context) {
$ch = $chapters[$chid];
$title = trim(format_string($ch->title, true, array('context'=>$context)));
$numbers = array();
if ($book->numbering == BOOK_NUM_NUMBERS) {
if ($ch->parent and $chapters[$ch->parent]->number) {
$numbers[] = $chapters[$ch->parent]->number;
}
if ($ch->number) {
$numbers[] = $ch->number;
}
}
if ($numbers) {
$title = implode('.', $numbers).' '.$title;
}
return $title;
}
/**
* General logging to table
* @param string $str1
* @param string $str2
* @param int $level
* @return void
*/
function book_log($str1, $str2, $level = 0) {
switch ($level) {
case 1:
echo '<tr><td><span class="dimmed_text">'.$str1.'</span></td><td><span class="dimmed_text">'.$str2.'</span></td></tr>';
break;
case 2:
echo '<tr><td><span style="color: rgb(255, 0, 0);">'.$str1.'</span></td><td><span style="color: rgb(255, 0, 0);">'.$str2.'</span></td></tr>';
break;
default:
echo '<tr><td>'.$str1.'</class></td><td>'.$str2.'</td></tr>';
break;
}
}
function book_add_fake_block($chapters, $chapter, $book, $cm, $edit) {
global $OUTPUT, $PAGE;
$toc = book_get_toc($chapters, $chapter, $book, $cm, $edit, 0);
if ($edit) {
$toc .= '<div class="book_faq">';
$toc .= $OUTPUT->help_icon('faq', 'mod_book', get_string('faq', 'mod_book'));
$toc .= '</div>';
}
$bc = new block_contents();
$bc->title = get_string('toc', 'mod_book');
$bc->attributes['class'] = 'block';
$bc->content = $toc;
$regions = $PAGE->blocks->get_regions();
$firstregion = reset($regions);
$PAGE->blocks->add_fake_block($bc, $firstregion);
}
/**
* Generate toc structure
*
* @param array $chapters
* @param stdClass $chapter
* @param stdClass $book
* @param stdClass $cm
* @param bool $edit
* @return string
*/
function book_get_toc($chapters, $chapter, $book, $cm, $edit) {
global $USER, $OUTPUT;
$toc = ''; //representation of toc (HTML)
$nch = 0; //chapter number
$ns = 0; //subchapter number
$first = 1;
$context = get_context_instance(CONTEXT_MODULE, $cm->id);
switch ($book->numbering) {
case BOOK_NUM_NONE:
$toc .= '<div class="book_toc_none">';
break;
case BOOK_NUM_NUMBERS:
$toc .= '<div class="book_toc_numbered">';
break;
case BOOK_NUM_BULLETS:
$toc .= '<div class="book_toc_bullets">';
break;
case BOOK_NUM_INDENTED:
$toc .= '<div class="book_toc_indented">';
break;
}
if ($edit) { ///teacher's TOC
$toc .= '<ul>';
$i = 0;
foreach($chapters as $ch) {
$i++;
$title = trim(format_string($ch->title, true, array('context'=>$context)));
if (!$ch->subchapter) {
$toc .= ($first) ? '<li>' : '</ul></li><li>';
if (!$ch->hidden) {
$nch++;
$ns = 0;
if ($book->numbering == BOOK_NUM_NUMBERS) {
$title = "$nch $title";
}
} else {
if ($book->numbering == BOOK_NUM_NUMBERS) {
$title = "x $title";
}
$title = '<span class="dimmed_text">'.$title.'</span>';
}
} else {
$toc .= ($first) ? '<li><ul><li>' : '<li>';
if (!$ch->hidden) {
$ns++;
if ($book->numbering == BOOK_NUM_NUMBERS) {
$title = "$nch.$ns $title";
}
} else {
if ($book->numbering == BOOK_NUM_NUMBERS) {
$title = "x.x $title";
}
$title = '<span class="dimmed_text">'.$title.'</span>';
}
}
if ($ch->id == $chapter->id) {
$toc .= '<strong>'.$title.'</strong>';
} else {
$toc .= '<a title="'.s($title).'" href="view.php?id='.$cm->id.'&chapterid='.$ch->id.'">'.$title.'</a>';
}
$toc .= ' ';
if ($i != 1) {
$toc .= ' <a title="'.get_string('up').'" href="move.php?id='.$cm->id.'&chapterid='.$ch->id.'&up=1&sesskey='.$USER->sesskey.'"><img src="'.$OUTPUT->pix_url('t/up').'" class="iconsmall" alt="'.get_string('up').'" /></a>';
}
if ($i != count($chapters)) {
$toc .= ' <a title="'.get_string('down').'" href="move.php?id='.$cm->id.'&chapterid='.$ch->id.'&up=0&sesskey='.$USER->sesskey.'"><img src="'.$OUTPUT->pix_url('t/down').'" class="iconsmall" alt="'.get_string('down').'" /></a>';
}
$toc .= ' <a title="'.get_string('edit').'" href="edit.php?cmid='.$cm->id.'&id='.$ch->id.'"><img src="'.$OUTPUT->pix_url('t/edit').'" class="iconsmall" alt="'.get_string('edit').'" /></a>';
$toc .= ' <a title="'.get_string('delete').'" href="delete.php?id='.$cm->id.'&chapterid='.$ch->id.'&sesskey='.$USER->sesskey.'"><img src="'.$OUTPUT->pix_url('t/delete').'" class="iconsmall" alt="'.get_string('delete').'" /></a>';
if ($ch->hidden) {
$toc .= ' <a title="'.get_string('show').'" href="show.php?id='.$cm->id.'&chapterid='.$ch->id.'&sesskey='.$USER->sesskey.'"><img src="'.$OUTPUT->pix_url('t/show').'" class="iconsmall" alt="'.get_string('show').'" /></a>';
} else {
$toc .= ' <a title="'.get_string('hide').'" href="show.php?id='.$cm->id.'&chapterid='.$ch->id.'&sesskey='.$USER->sesskey.'"><img src="'.$OUTPUT->pix_url('t/hide').'" class="iconsmall" alt="'.get_string('hide').'" /></a>';
}
$toc .= ' <a title="'.get_string('addafter', 'mod_book').'" href="edit.php?cmid='.$cm->id.'&pagenum='.$ch->pagenum.'&subchapter='.$ch->subchapter.'"><img src="'.$OUTPUT->pix_url('add', 'mod_book').'" class="iconsmall" alt="'.get_string('addafter', 'mod_book').'" /></a>';
$toc .= (!$ch->subchapter) ? '<ul>' : '</li>';
$first = 0;
}
$toc .= '</ul></li></ul>';
} else { //normal students view
$toc .= '<ul>';
foreach($chapters as $ch) {
$title = trim(format_string($ch->title, true, array('context'=>$context)));
if (!$ch->hidden) {
if (!$ch->subchapter) {
$nch++;
$ns = 0;
$toc .= ($first) ? '<li>' : '</ul></li><li>';
if ($book->numbering == BOOK_NUM_NUMBERS) {
$title = "$nch $title";
}
} else {
$ns++;
$toc .= ($first) ? '<li><ul><li>' : '<li>';
if ($book->numbering == BOOK_NUM_NUMBERS) {
$title = "$nch.$ns $title";
}
}
if ($ch->id == $chapter->id) {
$toc .= '<strong>'.$title.'</strong>';
} else {
$toc .= '<a title="'.s($title).'" href="view.php?id='.$cm->id.'&chapterid='.$ch->id.'">'.$title.'</a>';
}
$toc .= (!$ch->subchapter) ? '<ul>' : '</li>';
$first = 0;
}
}
$toc .= '</ul></li></ul>';
}
$toc .= '</div>';
$toc = str_replace('<ul></ul>', '', $toc); //cleanup of invalid structures
return $toc;
}
/**
* File browsing support class
*/
class book_file_info extends file_info {
protected $course;
protected $cm;
protected $areas;
protected $filearea;
public function __construct($browser, $course, $cm, $context, $areas, $filearea) {
parent::__construct($browser, $context);
$this->course = $course;
$this->cm = $cm;
$this->areas = $areas;
$this->filearea = $filearea;
}
/**
* Returns list of standard virtual file/directory identification.
* The difference from stored_file parameters is that null values
* are allowed in all fields
* @return array with keys contextid, filearea, itemid, filepath and filename
*/
public function get_params() {
return array('contextid'=>$this->context->id,
'component'=>'mod_book',
'filearea' =>$this->filearea,
'itemid' =>null,
'filepath' =>null,
'filename' =>null);
}
/**
* Returns localised visible name.
* @return string
*/
public function get_visible_name() {
return $this->areas[$this->filearea];
}
/**
* Can I add new files or directories?
* @return bool
*/
public function is_writable() {
return false;
}
/**
* Is directory?
* @return bool
*/
public function is_directory() {
return true;
}
/**
* Returns list of children.
* @return array of file_info instances
*/
public function get_children() {
global $DB;
$children = array();
$chapters = $DB->get_records('book_chapters', array('bookid'=>$this->cm->instance), 'pagenum', 'id, pagenum');
foreach ($chapters as $itemid=>$unused) {
if ($child = $this->browser->get_file_info($this->context, 'mod_book', $this->filearea, $itemid)) {
$children[] = $child;
}
}
return $children;
}
/**
* Returns parent file_info instance
* @return file_info or null for root
*/
public function get_parent() {
return $this->browser->get_file_info($this->context);
}
}