0b4887f80ba04b3b5d42018048bc211613696db0
[moodle.git] / mod / book / lib.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/>.
17 /**
18  * Book module core interaction API
19  *
20  * @package    mod_book
21  * @copyright  2004-2011 Petr Skoda {@link http://skodak.org}
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 defined('MOODLE_INTERNAL') || die;
27 /**
28  * Returns list of available numbering types
29  * @return array
30  */
31 function book_get_numbering_types() {
32     global $CFG; // required for the include
34     require_once(__DIR__.'/locallib.php');
36     return array (
37         BOOK_NUM_NONE       => get_string('numbering0', 'mod_book'),
38         BOOK_NUM_NUMBERS    => get_string('numbering1', 'mod_book'),
39         BOOK_NUM_BULLETS    => get_string('numbering2', 'mod_book'),
40         BOOK_NUM_INDENTED   => get_string('numbering3', 'mod_book')
41     );
42 }
44 /**
45  * Returns list of available navigation link types.
46  * @return array
47  */
48 function book_get_nav_types() {
49     require_once(__DIR__.'/locallib.php');
51     return array (
52         BOOK_LINK_TOCONLY   => get_string('navtoc', 'mod_book'),
53         BOOK_LINK_IMAGE     => get_string('navimages', 'mod_book'),
54         BOOK_LINK_TEXT      => get_string('navtext', 'mod_book'),
55     );
56 }
58 /**
59  * Returns list of available navigation link CSS classes.
60  * @return array
61  */
62 function book_get_nav_classes() {
63     return array ('navtoc', 'navimages', 'navtext');
64 }
66 /**
67  * Add book instance.
68  *
69  * @param stdClass $data
70  * @param stdClass $mform
71  * @return int new book instance id
72  */
73 function book_add_instance($data, $mform) {
74     global $DB;
76     $data->timecreated = time();
77     $data->timemodified = $data->timecreated;
78     if (!isset($data->customtitles)) {
79         $data->customtitles = 0;
80     }
82     $id = $DB->insert_record('book', $data);
84     $completiontimeexpected = !empty($data->completionexpected) ? $data->completionexpected : null;
85     \core_completion\api::update_completion_date_event($data->coursemodule, 'book', $id, $completiontimeexpected);
87     return $id;
88 }
90 /**
91  * Update book instance.
92  *
93  * @param stdClass $data
94  * @param stdClass $mform
95  * @return bool true
96  */
97 function book_update_instance($data, $mform) {
98     global $DB;
100     $data->timemodified = time();
101     $data->id = $data->instance;
102     if (!isset($data->customtitles)) {
103         $data->customtitles = 0;
104     }
106     $DB->update_record('book', $data);
108     $book = $DB->get_record('book', array('id'=>$data->id));
109     $DB->set_field('book', 'revision', $book->revision+1, array('id'=>$book->id));
111     $completiontimeexpected = !empty($data->completionexpected) ? $data->completionexpected : null;
112     \core_completion\api::update_completion_date_event($data->coursemodule, 'book', $book->id, $completiontimeexpected);
114     return true;
117 /**
118  * Delete book instance by activity id
119  *
120  * @param int $id
121  * @return bool success
122  */
123 function book_delete_instance($id) {
124     global $DB;
126     if (!$book = $DB->get_record('book', array('id'=>$id))) {
127         return false;
128     }
130     $cm = get_coursemodule_from_instance('book', $id);
131     \core_completion\api::update_completion_date_event($cm->id, 'book', $id, null);
133     $DB->delete_records('book_chapters', array('bookid'=>$book->id));
134     $DB->delete_records('book', array('id'=>$book->id));
136     return true;
139 /**
140  * Given a course and a time, this module should find recent activity
141  * that has occurred in book activities and print it out.
142  *
143  * @param stdClass $course
144  * @param bool $viewfullnames
145  * @param int $timestart
146  * @return bool true if there was output, or false is there was none
147  */
148 function book_print_recent_activity($course, $viewfullnames, $timestart) {
149     return false;  //  True if anything was printed, otherwise false
152 /**
153  * This function is used by the reset_course_userdata function in moodlelib.
154  * @param $data the data submitted from the reset course.
155  * @return array status array
156  */
157 function book_reset_userdata($data) {
158     global $DB;
159     // Any changes to the list of dates that needs to be rolled should be same during course restore and course reset.
160     // See MDL-9367.
162     $status = [];
164     if (!empty($data->reset_book_tags)) {
165         // Loop through the books and remove the tags from the chapters.
166         if ($books = $DB->get_records('book', array('course' => $data->courseid))) {
167             foreach ($books as $book) {
168                 if (!$cm = get_coursemodule_from_instance('book', $book->id)) {
169                     continue;
170                 }
172                 $context = context_module::instance($cm->id);
173                 core_tag_tag::delete_instances('mod_book', null, $context->id);
174             }
175         }
178         $status[] = [
179             'component' => get_string('modulenameplural', 'book'),
180             'item' => get_string('tagsdeleted', 'book'),
181             'error' => false
182         ];
183     }
185     return $status;
188 /**
189  * The elements to add the course reset form.
190  *
191  * @param moodleform $mform
192  */
193 function book_reset_course_form_definition(&$mform) {
194     $mform->addElement('header', 'bookheader', get_string('modulenameplural', 'book'));
195     $mform->addElement('checkbox', 'reset_book_tags', get_string('removeallbooktags', 'book'));
198 /**
199  * No cron in book.
200  *
201  * @return bool
202  */
203 function book_cron () {
204     return true;
207 /**
208  * No grading in book.
209  *
210  * @param int $bookid
211  * @return null
212  */
213 function book_grades($bookid) {
214     return null;
217 /**
218  * This function returns if a scale is being used by one book
219  * it it has support for grading and scales. Commented code should be
220  * modified if necessary. See book, glossary or journal modules
221  * as reference.
222  *
223  * @param int $bookid
224  * @param int $scaleid
225  * @return boolean True if the scale is used by any journal
226  */
227 function book_scale_used($bookid, $scaleid) {
228     return false;
231 /**
232  * Checks if scale is being used by any instance of book
233  *
234  * This is used to find out if scale used anywhere
235  *
236  * @param int $scaleid
237  * @return bool true if the scale is used by any book
238  */
239 function book_scale_used_anywhere($scaleid) {
240     return false;
243 /**
244  * Return read actions.
245  *
246  * Note: This is not used by new logging system. Event with
247  *       crud = 'r' and edulevel = LEVEL_PARTICIPATING will
248  *       be considered as view action.
249  *
250  * @return array
251  */
252 function book_get_view_actions() {
253     global $CFG; // necessary for includes
255     $return = array('view', 'view all');
257     $plugins = core_component::get_plugin_list('booktool');
258     foreach ($plugins as $plugin => $dir) {
259         if (file_exists("$dir/lib.php")) {
260             require_once("$dir/lib.php");
261         }
262         $function = 'booktool_'.$plugin.'_get_view_actions';
263         if (function_exists($function)) {
264             if ($actions = $function()) {
265                 $return = array_merge($return, $actions);
266             }
267         }
268     }
270     return $return;
273 /**
274  * Return write actions.
275  *
276  * Note: This is not used by new logging system. Event with
277  *       crud = ('c' || 'u' || 'd') and edulevel = LEVEL_PARTICIPATING
278  *       will be considered as post action.
279  *
280  * @return array
281  */
282 function book_get_post_actions() {
283     global $CFG; // necessary for includes
285     $return = array('update');
287     $plugins = core_component::get_plugin_list('booktool');
288     foreach ($plugins as $plugin => $dir) {
289         if (file_exists("$dir/lib.php")) {
290             require_once("$dir/lib.php");
291         }
292         $function = 'booktool_'.$plugin.'_get_post_actions';
293         if (function_exists($function)) {
294             if ($actions = $function()) {
295                 $return = array_merge($return, $actions);
296             }
297         }
298     }
300     return $return;
303 /**
304  * Supported features
305  *
306  * @param string $feature FEATURE_xx constant for requested feature
307  * @return mixed True if module supports feature, false if not, null if doesn't know
308  */
309 function book_supports($feature) {
310     switch($feature) {
311         case FEATURE_MOD_ARCHETYPE:           return MOD_ARCHETYPE_RESOURCE;
312         case FEATURE_GROUPS:                  return false;
313         case FEATURE_GROUPINGS:               return false;
314         case FEATURE_MOD_INTRO:               return true;
315         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
316         case FEATURE_GRADE_HAS_GRADE:         return false;
317         case FEATURE_GRADE_OUTCOMES:          return false;
318         case FEATURE_BACKUP_MOODLE2:          return true;
319         case FEATURE_SHOW_DESCRIPTION:        return true;
321         default: return null;
322     }
325 /**
326  * Adds module specific settings to the settings block
327  *
328  * @param settings_navigation $settingsnav The settings navigation object
329  * @param navigation_node $booknode The node to add module settings to
330  * @return void
331  */
332 function book_extend_settings_navigation(settings_navigation $settingsnav, navigation_node $booknode) {
333     global $USER, $PAGE, $OUTPUT;
335     if ($booknode->children->count() > 0) {
336         $firstkey = $booknode->children->get_key_list()[0];
337     } else {
338         $firstkey = null;
339     }
341     $params = $PAGE->url->params();
343     if ($PAGE->cm->modname === 'book' and !empty($params['id']) and !empty($params['chapterid'])
344             and has_capability('mod/book:edit', $PAGE->cm->context)) {
345         if (!empty($USER->editing)) {
346             $string = get_string("turneditingoff");
347             $edit = '0';
348         } else {
349             $string = get_string("turneditingon");
350             $edit = '1';
351         }
352         $url = new moodle_url('/mod/book/view.php', array('id'=>$params['id'], 'chapterid'=>$params['chapterid'], 'edit'=>$edit, 'sesskey'=>sesskey()));
353         $editnode = navigation_node::create($string, $url, navigation_node::TYPE_SETTING);
354         $booknode->add_node($editnode, $firstkey);
355         $PAGE->set_button($OUTPUT->single_button($url, $string));
356     }
358     $plugins = core_component::get_plugin_list('booktool');
359     foreach ($plugins as $plugin => $dir) {
360         if (file_exists("$dir/lib.php")) {
361             require_once("$dir/lib.php");
362         }
363         $function = 'booktool_'.$plugin.'_extend_settings_navigation';
364         if (function_exists($function)) {
365             $function($settingsnav, $booknode);
366         }
367     }
371 /**
372  * Lists all browsable file areas
373  * @param object $course
374  * @param object $cm
375  * @param object $context
376  * @return array
377  */
378 function book_get_file_areas($course, $cm, $context) {
379     $areas = array();
380     $areas['chapter'] = get_string('chapters', 'mod_book');
381     return $areas;
384 /**
385  * File browsing support for book module chapter area.
386  * @param object $browser
387  * @param object $areas
388  * @param object $course
389  * @param object $cm
390  * @param object $context
391  * @param string $filearea
392  * @param int $itemid
393  * @param string $filepath
394  * @param string $filename
395  * @return object file_info instance or null if not found
396  */
397 function book_get_file_info($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename) {
398     global $CFG, $DB;
400     // note: 'intro' area is handled in file_browser automatically
402     if (!has_capability('mod/book:read', $context)) {
403         return null;
404     }
406     if ($filearea !== 'chapter') {
407         return null;
408     }
410     require_once(__DIR__.'/locallib.php');
412     if (is_null($itemid)) {
413         return new book_file_info($browser, $course, $cm, $context, $areas, $filearea);
414     }
416     $fs = get_file_storage();
417     $filepath = is_null($filepath) ? '/' : $filepath;
418     $filename = is_null($filename) ? '.' : $filename;
419     if (!$storedfile = $fs->get_file($context->id, 'mod_book', $filearea, $itemid, $filepath, $filename)) {
420         return null;
421     }
423     // modifications may be tricky - may cause caching problems
424     $canwrite = has_capability('mod/book:edit', $context);
426     $chaptername = $DB->get_field('book_chapters', 'title', array('bookid'=>$cm->instance, 'id'=>$itemid));
427     $chaptername = format_string($chaptername, true, array('context'=>$context));
429     $urlbase = $CFG->wwwroot.'/pluginfile.php';
430     return new file_info_stored($browser, $context, $storedfile, $urlbase, $chaptername, true, true, $canwrite, false);
433 /**
434  * Serves the book attachments. Implements needed access control ;-)
435  *
436  * @param stdClass $course course object
437  * @param cm_info $cm course module object
438  * @param context $context context object
439  * @param string $filearea file area
440  * @param array $args extra arguments
441  * @param bool $forcedownload whether or not force download
442  * @param array $options additional options affecting the file serving
443  * @return bool false if file not found, does not return if found - just send the file
444  */
445 function book_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array()) {
446     global $CFG, $DB;
448     if ($context->contextlevel != CONTEXT_MODULE) {
449         return false;
450     }
452     require_course_login($course, true, $cm);
454     if ($filearea !== 'chapter') {
455         return false;
456     }
458     if (!has_capability('mod/book:read', $context)) {
459         return false;
460     }
462     $chid = (int)array_shift($args);
464     if (!$book = $DB->get_record('book', array('id'=>$cm->instance))) {
465         return false;
466     }
468     if (!$chapter = $DB->get_record('book_chapters', array('id'=>$chid, 'bookid'=>$book->id))) {
469         return false;
470     }
472     if ($chapter->hidden and !has_capability('mod/book:viewhiddenchapters', $context)) {
473         return false;
474     }
476     // Download the contents of a chapter as an html file.
477     if ($args[0] == 'index.html') {
478         $filename = "index.html";
480         // We need to rewrite the pluginfile URLs so the media filters can work.
481         $content = file_rewrite_pluginfile_urls($chapter->content, 'webservice/pluginfile.php', $context->id, 'mod_book', 'chapter',
482                                                 $chapter->id);
483         $formatoptions = new stdClass;
484         $formatoptions->noclean = true;
485         $formatoptions->overflowdiv = true;
486         $formatoptions->context = $context;
488         $content = format_text($content, $chapter->contentformat, $formatoptions);
490         // Remove @@PLUGINFILE@@/.
491         $options = array('reverse' => true);
492         $content = file_rewrite_pluginfile_urls($content, 'webservice/pluginfile.php', $context->id, 'mod_book', 'chapter',
493                                                 $chapter->id, $options);
494         $content = str_replace('@@PLUGINFILE@@/', '', $content);
496         $titles = "";
497         // Format the chapter titles.
498         if (!$book->customtitles) {
499             require_once(__DIR__.'/locallib.php');
500             $chapters = book_preload_chapters($book);
502             if (!$chapter->subchapter) {
503                 $currtitle = book_get_chapter_title($chapter->id, $chapters, $book, $context);
504                 // Note that we can't use the $OUTPUT->heading() in WS_SERVER mode.
505                 $titles = "<h3>$currtitle</h3>";
506             } else {
507                 $currtitle = book_get_chapter_title($chapters[$chapter->id]->parent, $chapters, $book, $context);
508                 $currsubtitle = book_get_chapter_title($chapter->id, $chapters, $book, $context);
509                 // Note that we can't use the $OUTPUT->heading() in WS_SERVER mode.
510                 $titles = "<h3>$currtitle</h3>";
511                 $titles .= "<h4>$currsubtitle</h4>";
512             }
513         }
515         $content = $titles . $content;
517         send_file($content, $filename, 0, 0, true, true);
518     } else {
519         $fs = get_file_storage();
520         $relativepath = implode('/', $args);
521         $fullpath = "/$context->id/mod_book/chapter/$chid/$relativepath";
522         if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
523             return false;
524         }
526         // Nasty hack because we do not have file revisions in book yet.
527         $lifetime = $CFG->filelifetime;
528         if ($lifetime > 60 * 10) {
529             $lifetime = 60 * 10;
530         }
532         // Finally send the file.
533         send_stored_file($file, $lifetime, 0, $forcedownload, $options);
534     }
537 /**
538  * Return a list of page types
539  *
540  * @param string $pagetype current page type
541  * @param stdClass $parentcontext Block's parent context
542  * @param stdClass $currentcontext Current context of block
543  * @return array
544  */
545 function book_page_type_list($pagetype, $parentcontext, $currentcontext) {
546     $module_pagetype = array('mod-book-*'=>get_string('page-mod-book-x', 'mod_book'));
547     return $module_pagetype;
550 /**
551  * Export book resource contents
552  *
553  * @param  stdClass $cm     Course module object
554  * @param  string $baseurl  Base URL for file downloads
555  * @return array of file content
556  */
557 function book_export_contents($cm, $baseurl) {
558     global $DB;
560     $contents = array();
561     $context = context_module::instance($cm->id);
563     $book = $DB->get_record('book', array('id' => $cm->instance), '*', MUST_EXIST);
565     $fs = get_file_storage();
567     $chapters = $DB->get_records('book_chapters', array('bookid' => $book->id), 'pagenum');
569     $structure = array();
570     $currentchapter = 0;
572     foreach ($chapters as $chapter) {
573         if ($chapter->hidden) {
574             continue;
575         }
577         // Generate the book structure.
578         $thischapter = array(
579             "title"     => format_string($chapter->title, true, array('context' => $context)),
580             "href"      => $chapter->id . "/index.html",
581             "level"     => 0,
582             "subitems"  => array()
583         );
585         // Main chapter.
586         if (!$chapter->subchapter) {
587             $currentchapter = $chapter->pagenum;
588             $structure[$currentchapter] = $thischapter;
589         } else {
590             // Subchapter.
591             $thischapter['level'] = 1;
592             $structure[$currentchapter]["subitems"][] = $thischapter;
593         }
595         // Export the chapter contents.
597         // Main content (html).
598         $filename = 'index.html';
599         $chapterindexfile = array();
600         $chapterindexfile['type']         = 'file';
601         $chapterindexfile['filename']     = $filename;
602         // Each chapter in a subdirectory.
603         $chapterindexfile['filepath']     = "/{$chapter->id}/";
604         $chapterindexfile['filesize']     = 0;
605         $chapterindexfile['fileurl']      = moodle_url::make_webservice_pluginfile_url(
606                     $context->id, 'mod_book', 'chapter', $chapter->id, '/', 'index.html')->out(false);
607         $chapterindexfile['timecreated']  = $chapter->timecreated;
608         $chapterindexfile['timemodified'] = $chapter->timemodified;
609         $chapterindexfile['content']      = format_string($chapter->title, true, array('context' => $context));
610         $chapterindexfile['sortorder']    = 0;
611         $chapterindexfile['userid']       = null;
612         $chapterindexfile['author']       = null;
613         $chapterindexfile['license']      = null;
614         $chapterindexfile['tags']         = \core_tag\external\util::get_item_tags('mod_book', 'book_chapters', $chapter->id);
615         $contents[] = $chapterindexfile;
617         // Chapter files (images usually).
618         $files = $fs->get_area_files($context->id, 'mod_book', 'chapter', $chapter->id, 'sortorder DESC, id ASC', false);
619         foreach ($files as $fileinfo) {
620             $file = array();
621             $file['type']         = 'file';
622             $file['filename']     = $fileinfo->get_filename();
623             $file['filepath']     = "/{$chapter->id}" . $fileinfo->get_filepath();
624             $file['filesize']     = $fileinfo->get_filesize();
625             $file['fileurl']      = moodle_url::make_webservice_pluginfile_url(
626                                         $context->id, 'mod_book', 'chapter', $chapter->id,
627                                         $fileinfo->get_filepath(), $fileinfo->get_filename())->out(false);
628             $file['timecreated']  = $fileinfo->get_timecreated();
629             $file['timemodified'] = $fileinfo->get_timemodified();
630             $file['sortorder']    = $fileinfo->get_sortorder();
631             $file['userid']       = $fileinfo->get_userid();
632             $file['author']       = $fileinfo->get_author();
633             $file['license']      = $fileinfo->get_license();
634             $file['mimetype']     = $fileinfo->get_mimetype();
635             $file['isexternalfile'] = $fileinfo->is_external_file();
636             if ($file['isexternalfile']) {
637                 $file['repositorytype'] = $fileinfo->get_repository_type();
638             }
639             $contents[] = $file;
640         }
641     }
643     // First content is the structure in encoded JSON format.
644     $structurefile = array();
645     $structurefile['type']         = 'content';
646     $structurefile['filename']     = 'structure';
647     $structurefile['filepath']     = "/";
648     $structurefile['filesize']     = 0;
649     $structurefile['fileurl']      = null;
650     $structurefile['timecreated']  = $book->timecreated;
651     $structurefile['timemodified'] = $book->timemodified;
652     $structurefile['content']      = json_encode(array_values($structure));
653     $structurefile['sortorder']    = 0;
654     $structurefile['userid']       = null;
655     $structurefile['author']       = null;
656     $structurefile['license']      = null;
658     // Add it as first element.
659     array_unshift($contents, $structurefile);
661     return $contents;
664 /**
665  * Mark the activity completed (if required) and trigger the course_module_viewed event.
666  *
667  * @param  stdClass $book       book object
668  * @param  stdClass $chapter    chapter object
669  * @param  bool $islaschapter   is the las chapter of the book?
670  * @param  stdClass $course     course object
671  * @param  stdClass $cm         course module object
672  * @param  stdClass $context    context object
673  * @since Moodle 3.0
674  */
675 function book_view($book, $chapter, $islastchapter, $course, $cm, $context) {
677     // First case, we are just opening the book.
678     if (empty($chapter)) {
679         \mod_book\event\course_module_viewed::create_from_book($book, $context)->trigger();
681     } else {
682         \mod_book\event\chapter_viewed::create_from_chapter($book, $context, $chapter)->trigger();
684         if ($islastchapter) {
685             // We cheat a bit here in assuming that viewing the last page means the user viewed the whole book.
686             $completion = new completion_info($course);
687             $completion->set_module_viewed($cm);
688         }
689     }
692 /**
693  * Check if the module has any update that affects the current user since a given time.
694  *
695  * @param  cm_info $cm course module data
696  * @param  int $from the time to check updates from
697  * @param  array $filter  if we need to check only specific updates
698  * @return stdClass an object with the different type of areas indicating if they were updated or not
699  * @since Moodle 3.2
700  */
701 function book_check_updates_since(cm_info $cm, $from, $filter = array()) {
702     global $DB;
704     $context = $cm->context;
705     $updates = new stdClass();
706     if (!has_capability('mod/book:read', $context)) {
707         return $updates;
708     }
709     $updates = course_check_module_updates_since($cm, $from, array('content'), $filter);
711     $select = 'bookid = :id AND (timecreated > :since1 OR timemodified > :since2)';
712     $params = array('id' => $cm->instance, 'since1' => $from, 'since2' => $from);
713     if (!has_capability('mod/book:viewhiddenchapters', $context)) {
714         $select .= ' AND hidden = 0';
715     }
716     $updates->entries = (object) array('updated' => false);
717     $entries = $DB->get_records_select('book_chapters', $select, $params, '', 'id');
718     if (!empty($entries)) {
719         $updates->entries->updated = true;
720         $updates->entries->itemids = array_keys($entries);
721     }
723     return $updates;
726 /**
727  * Get icon mapping for font-awesome.
728  */
729 function mod_book_get_fontawesome_icon_map() {
730     return [
731         'mod_book:chapter' => 'fa-bookmark-o',
732         'mod_book:nav_prev' => 'fa-arrow-left',
733         'mod_book:nav_prev_dis' => 'fa-angle-left',
734         'mod_book:nav_sep' => 'fa-minus',
735         'mod_book:add' => 'fa-plus',
736         'mod_book:nav_next' => 'fa-arrow-right',
737         'mod_book:nav_next_dis' => 'fa-angle-right',
738         'mod_book:nav_exit' => 'fa-arrow-up',
739     ];
742 /**
743  * This function receives a calendar event and returns the action associated with it, or null if there is none.
744  *
745  * This is used by block_myoverview in order to display the event appropriately. If null is returned then the event
746  * is not displayed on the block.
747  *
748  * @param calendar_event $event
749  * @param \core_calendar\action_factory $factory
750  * @param int $userid User id to use for all capability checks, etc. Set to 0 for current user (default).
751  * @return \core_calendar\local\event\entities\action_interface|null
752  */
753 function mod_book_core_calendar_provide_event_action(calendar_event $event,
754                                                      \core_calendar\action_factory $factory,
755                                                      int $userid = 0) {
756     global $USER;
758     if (empty($userid)) {
759         $userid = $USER->id;
760     }
762     $cm = get_fast_modinfo($event->courseid, $userid)->instances['book'][$event->instance];
764     if (!$cm->uservisible) {
765         // The module is not visible to the user for any reason.
766         return null;
767     }
769     $context = context_module::instance($cm->id);
771     if (!has_capability('mod/book:read', $context, $userid)) {
772         return null;
773     }
775     $completion = new \completion_info($cm->get_course());
777     $completiondata = $completion->get_data($cm, false, $userid);
779     if ($completiondata->completionstate != COMPLETION_INCOMPLETE) {
780         return null;
781     }
783     return $factory->create_instance(
784         get_string('view'),
785         new \moodle_url('/mod/book/view.php', ['id' => $cm->id]),
786         1,
787         true
788     );