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(dirname(__FILE__).'/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  * 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  *
  49  * @param  stdClass $book
  50  * @return array of id=>chapter
  51  */
  52 function book_preload_chapters($book) {
  53     global $DB;
  54     $chapters = $DB->get_records('book_chapters', array('bookid'=>$book->id), 'pagenum', 'id, pagenum, subchapter, title, hidden');
  55     if (!$chapters) {
  56         return array();
  57     }
  58
  59     $prev = null;
  60     $prevsub = null;
  61
  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
  68     foreach ($chapters as $id => $ch) {
  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) {
  78             if ($ch->hidden) {
  79                 if ($book->numbering == BOOK_NUM_NUMBERS) {
  80                     $ch->number = 'x';
  81                 } else {
  82                     $ch->number = null;
  83                 }
  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;
  93             $ch->subchapters = array();
  94         } else {
  95             $ch->parent = $parent;
  96             $ch->subchapters = null;
  97             $chapters[$parent]->subchapters[$ch->id] = $ch->id;
  98             if ($hidesub) {
  99                 // all subchapters in hidden chapter must be hidden too
 100                 $ch->hidden = 1;
 101             }
 102             if ($ch->hidden) {
 103                 if ($book->numbering == BOOK_NUM_NUMBERS) {
 104                     $ch->number = 'x';
 105                 } else {
 106                     $ch->number = null;
 107                 }
 108             } else {
 109                 $j++;
 110                 $ch->number = $j;
 111             }
 112         }
 113
 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;
 119     }
 120
 121     return $chapters;
 122 }
 123
 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  */
 133 function 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
 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  */
 162 function book_add_fake_block($chapters, $chapter, $book, $cm, $edit) {
 163     global $OUTPUT, $PAGE;
 164
 165     $toc = book_get_toc($chapters, $chapter, $book, $cm, $edit, 0);
 166
 167     $bc = new block_contents();
 168     $bc->title = get_string('toc', 'mod_book');
 169     $bc->attributes['class'] = 'block block_book_toc';
 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
 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
 185  * @return string
 186  */
 187 function book_get_toc($chapters, $chapter, $book, $cm, $edit) {
 188     global $USER, $OUTPUT;
 189
 190     $toc = '';
 191     $nch = 0;   // Chapter number
 192     $ns = 0;    // Subchapter number
 193     $first = 1;
 194
 195     $context = context_module::instance($cm->id);
 196
 197     switch ($book->numbering) {
 198         case BOOK_NUM_NONE:
 199             $toc .= html_writer::start_tag('div', array('class' => 'book_toc_none clearfix'));
 200             break;
 201         case BOOK_NUM_NUMBERS:
 202             $toc .= html_writer::start_tag('div', array('class' => 'book_toc_numbered clearfix'));
 203             break;
 204         case BOOK_NUM_BULLETS:
 205             $toc .= html_writer::start_tag('div', array('class' => 'book_toc_bullets clearfix'));
 206             break;
 207         case BOOK_NUM_INDENTED:
 208             $toc .= html_writer::start_tag('div', array('class' => 'book_toc_indented clearfix'));
 209             break;
 210     }
 211
 212     if ($edit) { // Teacher's TOC
 213         $toc .= html_writer::start_tag('ul');
 214         $i = 0;
 215         foreach ($chapters as $ch) {
 216             $i++;
 217             $title = trim(format_string($ch->title, true, array('context'=>$context)));
 218             if (!$ch->subchapter) {
 219
 220                 if ($first) {
 221                     $toc .= html_writer::start_tag('li', array('class' => 'clearfix'));
 222                 } else {
 223                     $toc .= html_writer::end_tag('ul');
 224                     $toc .= html_writer::end_tag('li');
 225                     $toc .= html_writer::start_tag('li', array('class' => 'clearfix'));
 226                 }
 227
 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                     }
 238                     $title = html_writer::tag('span', $title, array('class' => 'dimmed_text'));
 239                 }
 240             } else {
 241
 242                 if ($first) {
 243                     $toc .= html_writer::start_tag('li', array('class' => 'clearfix'));
 244                     $toc .= html_writer::start_tag('ul');
 245                     $toc .= html_writer::start_tag('li', array('class' => 'clearfix'));
 246                 } else {
 247                     $toc .= html_writer::start_tag('li', array('class' => 'clearfix'));
 248                 }
 249
 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) {
 257                         if (empty($chapters[$ch->parent]->hidden)) {
 258                             $title = "$nch.x $title";
 259                         } else {
 260                             $title = "x.x $title";
 261                         }
 262                     }
 263                     $title = html_writer::tag('span', $title, array('class' => 'dimmed_text'));
 264                 }
 265             }
 266
 267             if ($ch->id == $chapter->id) {
 268                 $toc .= html_writer::tag('strong', $title);
 269             } else {
 270                 $toc .= html_writer::link(new moodle_url('view.php', array('id' => $cm->id, 'chapterid' => $ch->id)), $title, array('title' => s($title)));
 271             }
 272
 273             $toc .= html_writer::start_tag('div', array('class' => 'action-list'));
 274             if ($i != 1) {
 275                 $toc .= html_writer::link(new moodle_url('move.php', array('id' => $cm->id, 'chapterid' => $ch->id, 'up' => '1', 'sesskey' => $USER->sesskey)),
 276                                             $OUTPUT->pix_icon('t/up', get_string('up')), array('title' => get_string('up')));
 277             }
 278             if ($i != count($chapters)) {
 279                 $toc .= html_writer::link(new moodle_url('move.php', array('id' => $cm->id, 'chapterid' => $ch->id, 'up' => '0', 'sesskey' => $USER->sesskey)),
 280                                             $OUTPUT->pix_icon('t/down', get_string('down')), array('title' => get_string('down')));
 281             }
 282             $toc .= html_writer::link(new moodle_url('edit.php', array('cmid' => $cm->id, 'id' => $ch->id)),
 283                                         $OUTPUT->pix_icon('t/edit', get_string('edit')), array('title' => get_string('edit')));
 284             $toc .= html_writer::link(new moodle_url('delete.php', array('id' => $cm->id, 'chapterid' => $ch->id, 'sesskey' => $USER->sesskey)),
 285                                         $OUTPUT->pix_icon('t/delete', get_string('delete')), array('title' => get_string('delete')));
 286             if ($ch->hidden) {
 287                 $toc .= html_writer::link(new moodle_url('show.php', array('id' => $cm->id, 'chapterid' => $ch->id, 'sesskey' => $USER->sesskey)),
 288                                             $OUTPUT->pix_icon('t/show', get_string('show')), array('title' => get_string('show')));
 289             } else {
 290                 $toc .= html_writer::link(new moodle_url('show.php', array('id' => $cm->id, 'chapterid' => $ch->id, 'sesskey' => $USER->sesskey)),
 291                                             $OUTPUT->pix_icon('t/hide', get_string('hide')), array('title' => get_string('hide')));
 292             }
 293             $toc .= html_writer::link(new moodle_url('edit.php', array('cmid' => $cm->id, 'pagenum' => $ch->pagenum, 'subchapter' => $ch->subchapter)),
 294                                             $OUTPUT->pix_icon('add', get_string('addafter', 'mod_book'), 'mod_book'), array('title' => get_string('addafter', 'mod_book')));
 295             $toc .= html_writer::end_tag('div');
 296
 297             if (!$ch->subchapter) {
 298                 $toc .= html_writer::start_tag('ul');
 299             } else {
 300                 $toc .= html_writer::end_tag('li');
 301             }
 302             $first = 0;
 303         }
 304
 305         $toc .= html_writer::end_tag('ul');
 306         $toc .= html_writer::end_tag('li');
 307         $toc .= html_writer::end_tag('ul');
 308
 309     } else { // Normal students view
 310         $toc .= html_writer::start_tag('ul');
 311         foreach ($chapters as $ch) {
 312             $title = trim(format_string($ch->title, true, array('context'=>$context)));
 313             if (!$ch->hidden) {
 314                 if (!$ch->subchapter) {
 315                     $nch++;
 316                     $ns = 0;
 317
 318                     if ($first) {
 319                         $toc .= html_writer::start_tag('li', array('class' => 'clearfix'));
 320                     } else {
 321                         $toc .= html_writer::end_tag('ul');
 322                         $toc .= html_writer::end_tag('li');
 323                         $toc .= html_writer::start_tag('li', array('class' => 'clearfix'));
 324                     }
 325
 326                     if ($book->numbering == BOOK_NUM_NUMBERS) {
 327                           $title = "$nch $title";
 328                     }
 329                 } else {
 330                     $ns++;
 331
 332                     if ($first) {
 333                         $toc .= html_writer::start_tag('li', array('class' => 'clearfix'));
 334                         $toc .= html_writer::start_tag('ul');
 335                         $toc .= html_writer::start_tag('li', array('class' => 'clearfix'));
 336                     } else {
 337                         $toc .= html_writer::start_tag('li', array('class' => 'clearfix'));
 338                     }
 339
 340                     if ($book->numbering == BOOK_NUM_NUMBERS) {
 341                           $title = "$nch.$ns $title";
 342                     }
 343                 }
 344                 if ($ch->id == $chapter->id) {
 345                     $toc .= html_writer::tag('strong', $title);
 346                 } else {
 347                     $toc .= html_writer::link(new moodle_url('view.php', array('id' => $cm->id, 'chapterid' => $ch->id)), $title, array('title' => s($title)));
 348                 }
 349
 350                 if (!$ch->subchapter) {
 351                     $toc .= html_writer::start_tag('ul');
 352                 } else {
 353                     $toc .= html_writer::end_tag('li');
 354                 }
 355
 356                 $first = 0;
 357             }
 358         }
 359
 360         $toc .= html_writer::end_tag('ul');
 361         $toc .= html_writer::end_tag('li');
 362         $toc .= html_writer::end_tag('ul');
 363
 364     }
 365
 366     $toc .= html_writer::end_tag('div');
 367
 368     $toc = str_replace('<ul></ul>', '', $toc); // Cleanup of invalid structures.
 369
 370     return $toc;
 371 }
 372
 373
 374 /**
 375  * File browsing support class
 376  *
 377  * @copyright  2010-2011 Petr Skoda {@link http://skodak.org}
 378  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 379  */
 380 class book_file_info extends file_info {
 381     /** @var stdClass Course object */
 382     protected $course;
 383     /** @var stdClass Course module object */
 384     protected $cm;
 385     /** @var array Available file areas */
 386     protected $areas;
 387     /** @var string File area to browse */
 388     protected $filearea;
 389
 390     /**
 391      * Constructor
 392      *
 393      * @param file_browser $browser file_browser instance
 394      * @param stdClass $course course object
 395      * @param stdClass $cm course module object
 396      * @param stdClass $context module context
 397      * @param array $areas available file areas
 398      * @param string $filearea file area to browse
 399      */
 400     public function __construct($browser, $course, $cm, $context, $areas, $filearea) {
 401         parent::__construct($browser, $context);
 402         $this->course   = $course;
 403         $this->cm       = $cm;
 404         $this->areas    = $areas;
 405         $this->filearea = $filearea;
 406     }
 407
 408     /**
 409      * Returns list of standard virtual file/directory identification.
 410      * The difference from stored_file parameters is that null values
 411      * are allowed in all fields
 412      * @return array with keys contextid, filearea, itemid, filepath and filename
 413      */
 414     public function get_params() {
 415         return array('contextid'=>$this->context->id,
 416                      'component'=>'mod_book',
 417                      'filearea' =>$this->filearea,
 418                      'itemid'   =>null,
 419                      'filepath' =>null,
 420                      'filename' =>null);
 421     }
 422
 423     /**
 424      * Returns localised visible name.
 425      * @return string
 426      */
 427     public function get_visible_name() {
 428         return $this->areas[$this->filearea];
 429     }
 430
 431     /**
 432      * Can I add new files or directories?
 433      * @return bool
 434      */
 435     public function is_writable() {
 436         return false;
 437     }
 438
 439     /**
 440      * Is directory?
 441      * @return bool
 442      */
 443     public function is_directory() {
 444         return true;
 445     }
 446
 447     /**
 448      * Returns list of children.
 449      * @return array of file_info instances
 450      */
 451     public function get_children() {
 452         return $this->get_filtered_children('*', false, true);
 453     }
 454
 455     /**
 456      * Help function to return files matching extensions or their count
 457      *
 458      * @param string|array $extensions, either '*' or array of lowercase extensions, i.e. array('.gif','.jpg')
 459      * @param bool|int $countonly if false returns the children, if an int returns just the
 460      *    count of children but stops counting when $countonly number of children is reached
 461      * @param bool $returnemptyfolders if true returns items that don't have matching files inside
 462      * @return array|int array of file_info instances or the count
 463      */
 464     private function get_filtered_children($extensions = '*', $countonly = false, $returnemptyfolders = false) {
 465         global $DB;
 466         $params = array('contextid' => $this->context->id,
 467             'component' => 'mod_book',
 468             'filearea' => $this->filearea,
 469             'bookid' => $this->cm->instance);
 470         $sql = 'SELECT DISTINCT bc.id, bc.pagenum
 471                     FROM {files} f, {book_chapters} bc
 472                     WHERE f.contextid = :contextid
 473                     AND f.component = :component
 474                     AND f.filearea = :filearea
 475                     AND bc.bookid = :bookid
 476                     AND bc.id = f.itemid';
 477         if (!$returnemptyfolders) {
 478             $sql .= ' AND filename <> :emptyfilename';
 479             $params['emptyfilename'] = '.';
 480         }
 481         list($sql2, $params2) = $this->build_search_files_sql($extensions, 'f');
 482         $sql .= ' '.$sql2;
 483         $params = array_merge($params, $params2);
 484         if ($countonly === false) {
 485             $sql .= ' ORDER BY bc.pagenum';
 486         }
 487
 488         $rs = $DB->get_recordset_sql($sql, $params);
 489         $children = array();
 490         foreach ($rs as $record) {
 491             if ($child = $this->browser->get_file_info($this->context, 'mod_book', $this->filearea, $record->id)) {
 492                 if ($returnemptyfolders || $child->count_non_empty_children($extensions)) {
 493                     $children[] = $child;
 494                 }
 495             }
 496             if ($countonly !== false && count($children) >= $countonly) {
 497                 break;
 498             }
 499         }
 500         $rs->close();
 501         if ($countonly !== false) {
 502             return count($children);
 503         }
 504         return $children;
 505     }
 506
 507     /**
 508      * Returns list of children which are either files matching the specified extensions
 509      * or folders that contain at least one such file.
 510      *
 511      * @param string|array $extensions, either '*' or array of lowercase extensions, i.e. array('.gif','.jpg')
 512      * @return array of file_info instances
 513      */
 514     public function get_non_empty_children($extensions = '*') {
 515         return $this->get_filtered_children($extensions, false);
 516     }
 517
 518     /**
 519      * Returns the number of children which are either files matching the specified extensions
 520      * or folders containing at least one such file.
 521      *
 522      * @param string|array $extensions, for example '*' or array('.gif','.jpg')
 523      * @param int $limit stop counting after at least $limit non-empty children are found
 524      * @return int
 525      */
 526     public function count_non_empty_children($extensions = '*', $limit = 1) {
 527         return $this->get_filtered_children($extensions, $limit);
 528     }
 529
 530     /**
 531      * Returns parent file_info instance
 532      * @return file_info or null for root
 533      */
 534     public function get_parent() {
 535         return $this->browser->get_file_info($this->context);
 536     }
 537 }