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