MDL-36628 usability: New icons for book module
[moodle.git] / mod / book / locallib.php
CommitLineData
e355240d 1<?php
b15ef0b0 2// This file is part of Moodle - http://moodle.org/
e355240d
PS
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/>.
16
17/**
18 * Book module local lib functions
19 *
3542c4f4
EL
20 * @package mod_book
21 * @copyright 2010-2011 Petr Skoda {@link http://skodak.org}
e355240d
PS
22 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 */
24
25defined('MOODLE_INTERNAL') || die;
26
29656fe2 27require_once(dirname(__FILE__).'/lib.php');
f6ca19ae
PS
28require_once($CFG->libdir.'/filelib.php');
29
2cd972c1
SH
30/**
31 * The following defines are used to define how the chapters and subchapters of a book should be displayed in that table of contents.
32 * BOOK_NUM_NONE No special styling will applied and the editor will be able to do what ever thay want in the title
33 * BOOK_NUM_NUMBERS Chapters and subchapters are numbered (1, 1.1, 1.2, 2, ...)
34 * BOOK_NUM_BULLETS Subchapters are indented and displayed with bullets
35 * BOOK_NUM_INDENTED Subchapters are indented
36 */
45573d5a
PS
37define('BOOK_NUM_NONE', '0');
38define('BOOK_NUM_NUMBERS', '1');
39define('BOOK_NUM_BULLETS', '2');
40define('BOOK_NUM_INDENTED', '3');
41
2c1e98e6 42/**
ad1c11bd
PS
43 * Preload book chapters and fix toc structure if necessary.
44 *
45 * Returns array of chapters with standard 'pagenum', 'id, pagenum, subchapter, title, hidden'
46 * and extra 'parent, number, subchapters, prev, next'.
47 * Please note the content/text of chapters is not included.
48 *
b962f030 49 * @param stdClass $book
ad1c11bd 50 * @return array of id=>chapter
2c1e98e6 51 */
b1a9b01e 52function book_preload_chapters($book) {
2c1e98e6 53 global $DB;
b1a9b01e 54 $chapters = $DB->get_records('book_chapters', array('bookid'=>$book->id), 'pagenum', 'id, pagenum, subchapter, title, hidden');
ad1c11bd
PS
55 if (!$chapters) {
56 return array();
57 }
58
59 $prev = null;
60 $prevsub = null;
2c1e98e6 61
ad1c11bd
PS
62 $first = true;
63 $hidesub = true;
64 $parent = null;
65 $pagenum = 0; // chapter sort
66 $i = 0; // main chapter num
67 $j = 0; // subchapter num
29656fe2 68 foreach ($chapters as $id => $ch) {
ad1c11bd
PS
69 $oldch = clone($ch);
70 $pagenum++;
71 $ch->pagenum = $pagenum;
72 if ($first) {
73 // book can not start with a subchapter
74 $ch->subchapter = 0;
75 $first = false;
76 }
77 if (!$ch->subchapter) {
ad1c11bd 78 if ($ch->hidden) {
b1a9b01e
PS
79 if ($book->numbering == BOOK_NUM_NUMBERS) {
80 $ch->number = 'x';
81 } else {
82 $ch->number = null;
83 }
ad1c11bd
PS
84 } else {
85 $i++;
86 $ch->number = $i;
87 }
88 $j = 0;
89 $prevsub = null;
90 $hidesub = $ch->hidden;
91 $parent = $ch->id;
92 $ch->parent = null;
2cd972c1 93 $ch->subchapters = array();
ad1c11bd 94 } else {
ad1c11bd 95 $ch->parent = $parent;
2cd972c1 96 $ch->subchapters = null;
ad1c11bd
PS
97 $chapters[$parent]->subchapters[$ch->id] = $ch->id;
98 if ($hidesub) {
99 // all subchapters in hidden chapter must be hidden too
bc953600 100 $ch->hidden = 1;
e355240d 101 }
ad1c11bd 102 if ($ch->hidden) {
b1a9b01e
PS
103 if ($book->numbering == BOOK_NUM_NUMBERS) {
104 $ch->number = 'x';
105 } else {
106 $ch->number = null;
107 }
ad1c11bd
PS
108 } else {
109 $j++;
110 $ch->number = $j;
23b02c4f 111 }
e355240d 112 }
fb909757 113
ad1c11bd
PS
114 if ($oldch->subchapter != $ch->subchapter or $oldch->pagenum != $ch->pagenum or $oldch->hidden != $ch->hidden) {
115 // update only if something changed
116 $DB->update_record('book_chapters', $ch);
117 }
118 $chapters[$id] = $ch;
e355240d 119 }
ad1c11bd
PS
120
121 return $chapters;
e355240d
PS
122}
123
3542c4f4
EL
124/**
125 * Returns the title for a given chapter
126 *
127 * @param int $chid
128 * @param array $chapters
129 * @param stdClass $book
130 * @param context_module $context
131 * @return string
132 */
b1a9b01e
PS
133function book_get_chapter_title($chid, $chapters, $book, $context) {
134 $ch = $chapters[$chid];
135 $title = trim(format_string($ch->title, true, array('context'=>$context)));
136 $numbers = array();
137 if ($book->numbering == BOOK_NUM_NUMBERS) {
138 if ($ch->parent and $chapters[$ch->parent]->number) {
139 $numbers[] = $chapters[$ch->parent]->number;
140 }
141 if ($ch->number) {
142 $numbers[] = $ch->number;
143 }
144 }
145
146 if ($numbers) {
147 $title = implode('.', $numbers).' '.$title;
148 }
149
150 return $title;
151}
152
3542c4f4
EL
153/**
154 * Add the book TOC sticky block to the 1st region available
155 *
156 * @param array $chapters
157 * @param stdClass $chapter
158 * @param stdClass $book
159 * @param stdClass $cm
160 * @param bool $edit
161 */
ad1c11bd
PS
162function book_add_fake_block($chapters, $chapter, $book, $cm, $edit) {
163 global $OUTPUT, $PAGE;
164
8cb50b2a 165 $toc = book_get_toc($chapters, $chapter, $book, $cm, $edit, 0);
ad1c11bd 166
ad1c11bd
PS
167 $bc = new block_contents();
168 $bc->title = get_string('toc', 'mod_book');
169 $bc->attributes['class'] = 'block';
170 $bc->content = $toc;
171
172 $regions = $PAGE->blocks->get_regions();
173 $firstregion = reset($regions);
174 $PAGE->blocks->add_fake_block($bc, $firstregion);
175}
176
ee952cbb
PS
177/**
178 * Generate toc structure
179 *
180 * @param array $chapters
181 * @param stdClass $chapter
182 * @param stdClass $book
183 * @param stdClass $cm
184 * @param bool $edit
ee952cbb
PS
185 * @return string
186 */
187function book_get_toc($chapters, $chapter, $book, $cm, $edit) {
188 global $USER, $OUTPUT;
189
fb909757 190 $toc = '';
3542c4f4
EL
191 $nch = 0; // Chapter number
192 $ns = 0; // Subchapter number
ee952cbb
PS
193 $first = 1;
194
1fc9e895 195 $context = context_module::instance($cm->id);
ee952cbb
PS
196
197 switch ($book->numbering) {
29656fe2 198 case BOOK_NUM_NONE:
5b7e511e 199 $toc .= html_writer::start_tag('div', array('class' => 'book_toc_none'));
29656fe2
EL
200 break;
201 case BOOK_NUM_NUMBERS:
5b7e511e 202 $toc .= html_writer::start_tag('div', array('class' => 'book_toc_numbered'));
29656fe2
EL
203 break;
204 case BOOK_NUM_BULLETS:
5b7e511e 205 $toc .= html_writer::start_tag('div', array('class' => 'book_toc_bullets'));
29656fe2
EL
206 break;
207 case BOOK_NUM_INDENTED:
5b7e511e 208 $toc .= html_writer::start_tag('div', array('class' => 'book_toc_indented'));
29656fe2 209 break;
ee952cbb
PS
210 }
211
3542c4f4 212 if ($edit) { // Teacher's TOC
5b7e511e 213 $toc .= html_writer::start_tag('ul');
f6ca19ae 214 $i = 0;
29656fe2 215 foreach ($chapters as $ch) {
f6ca19ae 216 $i++;
dc888a31 217 $title = trim(format_string($ch->title, true, array('context'=>$context)));
f6ca19ae 218 if (!$ch->subchapter) {
5b7e511e
TT
219
220 if ($first) {
221 $toc .= html_writer::start_tag('li');
222 } else {
223 $toc .= html_writer::end_tag('ul');
224 $toc .= html_writer::end_tag('li');
225 $toc .= html_writer::start_tag('li');
226 }
227
f6ca19ae
PS
228 if (!$ch->hidden) {
229 $nch++;
230 $ns = 0;
231 if ($book->numbering == BOOK_NUM_NUMBERS) {
232 $title = "$nch $title";
233 }
234 } else {
235 if ($book->numbering == BOOK_NUM_NUMBERS) {
236 $title = "x $title";
237 }
5b7e511e 238 $title = html_writer::tag('span', $title, array('class' => 'dimmed_text'));
f6ca19ae 239 }
f6ca19ae 240 } else {
5b7e511e
TT
241
242 if ($first) {
243 $toc .= html_writer::start_tag('li');
244 $toc .= html_writer::start_tag('ul');
245 $toc .= html_writer::start_tag('li');
246 } else {
247 $toc .= html_writer::start_tag('li');
248 }
249
f6ca19ae
PS
250 if (!$ch->hidden) {
251 $ns++;
252 if ($book->numbering == BOOK_NUM_NUMBERS) {
253 $title = "$nch.$ns $title";
254 }
255 } else {
256 if ($book->numbering == BOOK_NUM_NUMBERS) {
b0b30cb6
AA
257 if (empty($chapters[$ch->parent]->hidden)) {
258 $title = "$nch.x $title";
259 } else {
260 $title = "x.x $title";
261 }
f6ca19ae 262 }
5b7e511e 263 $title = html_writer::tag('span', $title, array('class' => 'dimmed_text'));
f6ca19ae
PS
264 }
265 }
266
267 if ($ch->id == $chapter->id) {
5b7e511e 268 $toc .= html_writer::tag('strong', $title);
f6ca19ae 269 } else {
5b7e511e 270 $toc .= html_writer::link(new moodle_url('view.php', array('id' => $cm->id, 'chapterid' => $ch->id)), $title, array('title' => s($title)));
f6ca19ae
PS
271 }
272 $toc .= '&nbsp;&nbsp;';
273 if ($i != 1) {
5b7e511e
TT
274 $toc .= html_writer::link(new moodle_url('move.php', array('id' => $cm->id, 'chapterid' => $ch->id, 'up' => '1', 'sesskey' => $USER->sesskey)),
275 $OUTPUT->pix_icon('t/up', get_string('up')), array('title' => get_string('up')));
f6ca19ae
PS
276 }
277 if ($i != count($chapters)) {
5b7e511e
TT
278 $toc .= html_writer::link(new moodle_url('move.php', array('id' => $cm->id, 'chapterid' => $ch->id, 'up' => '0', 'sesskey' => $USER->sesskey)),
279 $OUTPUT->pix_icon('t/down', get_string('down')), array('title' => get_string('down')));
f6ca19ae 280 }
5b7e511e
TT
281 $toc .= html_writer::link(new moodle_url('edit.php', array('cmid' => $cm->id, 'id' => $ch->id)),
282 $OUTPUT->pix_icon('t/edit', get_string('edit')), array('title' => get_string('edit')));
283 $toc .= html_writer::link(new moodle_url('delete.php', array('id' => $cm->id, 'chapterid' => $ch->id, 'sesskey' => $USER->sesskey)),
284 $OUTPUT->pix_icon('t/delete', get_string('delete')), array('title' => get_string('delete')));
f6ca19ae 285 if ($ch->hidden) {
5b7e511e
TT
286 $toc .= html_writer::link(new moodle_url('show.php', array('id' => $cm->id, 'chapterid' => $ch->id, 'sesskey' => $USER->sesskey)),
287 $OUTPUT->pix_icon('t/show', get_string('show')), array('title' => get_string('show')));
f6ca19ae 288 } else {
5b7e511e
TT
289 $toc .= html_writer::link(new moodle_url('show.php', array('id' => $cm->id, 'chapterid' => $ch->id, 'sesskey' => $USER->sesskey)),
290 $OUTPUT->pix_icon('t/hide', get_string('hide')), array('title' => get_string('hide')));
f6ca19ae 291 }
5b7e511e
TT
292 $toc .= html_writer::link(new moodle_url('edit.php', array('cmid' => $cm->id, 'pagenum' => $ch->pagenum, 'subchapter' => $ch->subchapter)),
293 $OUTPUT->pix_icon('add', get_string('addafter', 'mod_book'), 'mod_book'), array('title' => get_string('addafter', 'mod_book')));
f6ca19ae 294
5b7e511e
TT
295
296 if (!$ch->subchapter) {
297 $toc .= html_writer::start_tag('ul');
298 } else {
299 $toc .= html_writer::end_tag('li');
300 }
f6ca19ae
PS
301 $first = 0;
302 }
5b7e511e
TT
303
304 $toc .= html_writer::end_tag('ul');
305 $toc .= html_writer::end_tag('li');
306 $toc .= html_writer::end_tag('ul');
307
3542c4f4 308 } else { // Normal students view
5b7e511e 309 $toc .= html_writer::start_tag('ul');
29656fe2 310 foreach ($chapters as $ch) {
dc888a31 311 $title = trim(format_string($ch->title, true, array('context'=>$context)));
f6ca19ae
PS
312 if (!$ch->hidden) {
313 if (!$ch->subchapter) {
314 $nch++;
315 $ns = 0;
5b7e511e
TT
316
317 if ($first) {
318 $toc .= html_writer::start_tag('li');
319 } else {
320 $toc .= html_writer::end_tag('ul');
321 $toc .= html_writer::end_tag('li');
322 $toc .= html_writer::start_tag('li');
323 }
324
f6ca19ae
PS
325 if ($book->numbering == BOOK_NUM_NUMBERS) {
326 $title = "$nch $title";
327 }
f6ca19ae
PS
328 } else {
329 $ns++;
5b7e511e
TT
330
331 if ($first) {
332 $toc .= html_writer::start_tag('li');
333 $toc .= html_writer::start_tag('ul');
334 $toc .= html_writer::start_tag('li');
335 } else {
336 $toc .= html_writer::start_tag('li');
337 }
338
f6ca19ae
PS
339 if ($book->numbering == BOOK_NUM_NUMBERS) {
340 $title = "$nch.$ns $title";
341 }
342 }
343 if ($ch->id == $chapter->id) {
5b7e511e 344 $toc .= html_writer::tag('strong', $title);
f6ca19ae 345 } else {
5b7e511e 346 $toc .= html_writer::link(new moodle_url('view.php', array('id' => $cm->id, 'chapterid' => $ch->id)), $title, array('title' => s($title)));
f6ca19ae 347 }
5b7e511e
TT
348
349 if (!$ch->subchapter) {
350 $toc .= html_writer::start_tag('ul');
351 } else {
352 $toc .= html_writer::end_tag('li');
353 }
354
f6ca19ae
PS
355 $first = 0;
356 }
357 }
5b7e511e
TT
358
359 $toc .= html_writer::end_tag('ul');
360 $toc .= html_writer::end_tag('li');
361 $toc .= html_writer::end_tag('ul');
362
f6ca19ae
PS
363 }
364
5b7e511e 365 $toc .= html_writer::end_tag('div');
f6ca19ae 366
3542c4f4 367 $toc = str_replace('<ul></ul>', '', $toc); // Cleanup of invalid structures.
f6ca19ae 368
ee952cbb 369 return $toc;
f6ca19ae 370}
dd9b772b
PS
371
372
373/**
374 * File browsing support class
3542c4f4
EL
375 *
376 * @copyright 2010-2011 Petr Skoda {@link http://skodak.org}
377 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
dd9b772b
PS
378 */
379class book_file_info extends file_info {
3542c4f4 380 /** @var stdClass Course object */
dd9b772b 381 protected $course;
3542c4f4 382 /** @var stdClass Course module object */
dd9b772b 383 protected $cm;
3542c4f4 384 /** @var array Available file areas */
dd9b772b 385 protected $areas;
3542c4f4 386 /** @var string File area to browse */
dd9b772b
PS
387 protected $filearea;
388
3542c4f4
EL
389 /**
390 * Constructor
391 *
392 * @param file_browser $browser file_browser instance
393 * @param stdClass $course course object
394 * @param stdClass $cm course module object
395 * @param stdClass $context module context
396 * @param array $areas available file areas
397 * @param string $filearea file area to browse
398 */
dd9b772b
PS
399 public function __construct($browser, $course, $cm, $context, $areas, $filearea) {
400 parent::__construct($browser, $context);
401 $this->course = $course;
402 $this->cm = $cm;
403 $this->areas = $areas;
404 $this->filearea = $filearea;
405 }
406
407 /**
408 * Returns list of standard virtual file/directory identification.
409 * The difference from stored_file parameters is that null values
410 * are allowed in all fields
411 * @return array with keys contextid, filearea, itemid, filepath and filename
412 */
413 public function get_params() {
414 return array('contextid'=>$this->context->id,
415 'component'=>'mod_book',
416 'filearea' =>$this->filearea,
417 'itemid' =>null,
418 'filepath' =>null,
419 'filename' =>null);
420 }
421
422 /**
423 * Returns localised visible name.
424 * @return string
425 */
426 public function get_visible_name() {
427 return $this->areas[$this->filearea];
428 }
429
430 /**
431 * Can I add new files or directories?
432 * @return bool
433 */
434 public function is_writable() {
435 return false;
436 }
437
438 /**
439 * Is directory?
440 * @return bool
441 */
442 public function is_directory() {
443 return true;
444 }
445
446 /**
447 * Returns list of children.
448 * @return array of file_info instances
449 */
450 public function get_children() {
b8de2621
MG
451 return $this->get_filtered_children('*', false, true);
452 }
453
454 /**
455 * Help function to return files matching extensions or their count
456 *
457 * @param string|array $extensions, either '*' or array of lowercase extensions, i.e. array('.gif','.jpg')
43aadf04
MG
458 * @param bool|int $countonly if false returns the children, if an int returns just the
459 * count of children but stops counting when $countonly number of children is reached
b8de2621
MG
460 * @param bool $returnemptyfolders if true returns items that don't have matching files inside
461 * @return array|int array of file_info instances or the count
462 */
463 private function get_filtered_children($extensions = '*', $countonly = false, $returnemptyfolders = false) {
dd9b772b 464 global $DB;
b8de2621
MG
465 $params = array('contextid' => $this->context->id,
466 'component' => 'mod_book',
467 'filearea' => $this->filearea,
468 'bookid' => $this->cm->instance);
469 $sql = 'SELECT DISTINCT bc.id, bc.pagenum
470 FROM {files} f, {book_chapters} bc
471 WHERE f.contextid = :contextid
472 AND f.component = :component
473 AND f.filearea = :filearea
474 AND bc.bookid = :bookid
475 AND bc.id = f.itemid';
476 if (!$returnemptyfolders) {
477 $sql .= ' AND filename <> :emptyfilename';
478 $params['emptyfilename'] = '.';
479 }
480 list($sql2, $params2) = $this->build_search_files_sql($extensions, 'f');
481 $sql .= ' '.$sql2;
482 $params = array_merge($params, $params2);
43aadf04 483 if ($countonly === false) {
b8de2621
MG
484 $sql .= ' ORDER BY bc.pagenum';
485 }
dd9b772b 486
b8de2621 487 $rs = $DB->get_recordset_sql($sql, $params);
dd9b772b 488 $children = array();
b8de2621
MG
489 foreach ($rs as $record) {
490 if ($child = $this->browser->get_file_info($this->context, 'mod_book', $this->filearea, $record->id)) {
491 if ($returnemptyfolders || $child->count_non_empty_children($extensions)) {
492 $children[] = $child;
493 }
494 }
43aadf04 495 if ($countonly !== false && count($children) >= $countonly) {
b8de2621 496 break;
dd9b772b
PS
497 }
498 }
b8de2621 499 $rs->close();
43aadf04 500 if ($countonly !== false) {
b8de2621
MG
501 return count($children);
502 }
dd9b772b
PS
503 return $children;
504 }
505
b8de2621
MG
506 /**
507 * Returns list of children which are either files matching the specified extensions
508 * or folders that contain at least one such file.
509 *
510 * @param string|array $extensions, either '*' or array of lowercase extensions, i.e. array('.gif','.jpg')
511 * @return array of file_info instances
512 */
513 public function get_non_empty_children($extensions = '*') {
514 return $this->get_filtered_children($extensions, false);
515 }
516
517 /**
518 * Returns the number of children which are either files matching the specified extensions
519 * or folders containing at least one such file.
520 *
b8de2621 521 * @param string|array $extensions, for example '*' or array('.gif','.jpg')
43aadf04 522 * @param int $limit stop counting after at least $limit non-empty children are found
b8de2621
MG
523 * @return int
524 */
43aadf04
MG
525 public function count_non_empty_children($extensions = '*', $limit = 1) {
526 return $this->get_filtered_children($extensions, $limit);
b8de2621
MG
527 }
528
dd9b772b
PS
529 /**
530 * Returns parent file_info instance
531 * @return file_info or null for root
532 */
533 public function get_parent() {
534 return $this->browser->get_file_info($this->context);
535 }
536}