0a187a67c2a1ecebceda80e457796d1cb20231f5
[moodle.git] / mod / wiki / lib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle. If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Library of functions and constants for module wiki
20  *
21  * It contains the great majority of functions defined by Moodle
22  * that are mandatory to develop a module.
23  *
24  * @package mod_wiki
25  * @copyright 2009 Marc Alier, Jordi Piguillem marc.alier@upc.edu
26  * @copyright 2009 Universitat Politecnica de Catalunya http://www.upc.edu
27  *
28  * @author Jordi Piguillem
29  * @author Marc Alier
30  * @author David Jimenez
31  * @author Josep Arus
32  * @author Kenneth Riba
33  *
34  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
35  */
37 defined('MOODLE_INTERNAL') || die();
39 /**
40  * Given an object containing all the necessary data,
41  * (defined by the form in mod.html) this function
42  * will create a new instance and return the id number
43  * of the new instance.
44  *
45  * @param object $instance An object from the form in mod.html
46  * @return int The id of the newly inserted wiki record
47  **/
48 function wiki_add_instance($wiki) {
49     global $DB;
51     $wiki->timemodified = time();
52     # May have to add extra stuff in here #
53     if (empty($wiki->forceformat)) {
54         $wiki->forceformat = 0;
55     }
57     $id = $DB->insert_record('wiki', $wiki);
59     $completiontimeexpected = !empty($wiki->completionexpected) ? $wiki->completionexpected : null;
60     \core_completion\api::update_completion_date_event($wiki->coursemodule, 'wiki', $id, $completiontimeexpected);
62     return $id;
63 }
65 /**
66  * Given an object containing all the necessary data,
67  * (defined by the form in mod.html) this function
68  * will update an existing instance with new data.
69  *
70  * @param object $instance An object from the form in mod.html
71  * @return boolean Success/Fail
72  **/
73 function wiki_update_instance($wiki) {
74     global $DB;
76     $wiki->timemodified = time();
77     $wiki->id = $wiki->instance;
78     if (empty($wiki->forceformat)) {
79         $wiki->forceformat = 0;
80     }
82     $completiontimeexpected = !empty($wiki->completionexpected) ? $wiki->completionexpected : null;
83     \core_completion\api::update_completion_date_event($wiki->coursemodule, 'wiki', $wiki->id, $completiontimeexpected);
85     # May have to add extra stuff in here #
87     return $DB->update_record('wiki', $wiki);
88 }
90 /**
91  * Given an ID of an instance of this module,
92  * this function will permanently delete the instance
93  * and any data that depends on it.
94  *
95  * @param int $id Id of the module instance
96  * @return boolean Success/Failure
97  **/
98 function wiki_delete_instance($id) {
99     global $DB;
101     if (!$wiki = $DB->get_record('wiki', array('id' => $id))) {
102         return false;
103     }
105     $result = true;
107     # Get subwiki information #
108     $subwikis = $DB->get_records('wiki_subwikis', array('wikiid' => $wiki->id));
110     foreach ($subwikis as $subwiki) {
111         # Get existing links, and delete them #
112         if (!$DB->delete_records('wiki_links', array('subwikiid' => $subwiki->id), IGNORE_MISSING)) {
113             $result = false;
114         }
116         # Get existing pages #
117         if ($pages = $DB->get_records('wiki_pages', array('subwikiid' => $subwiki->id))) {
118             foreach ($pages as $page) {
119                 # Get locks, and delete them #
120                 if (!$DB->delete_records('wiki_locks', array('pageid' => $page->id), IGNORE_MISSING)) {
121                     $result = false;
122                 }
124                 # Get versions, and delete them #
125                 if (!$DB->delete_records('wiki_versions', array('pageid' => $page->id), IGNORE_MISSING)) {
126                     $result = false;
127                 }
128             }
130             # Delete pages #
131             if (!$DB->delete_records('wiki_pages', array('subwikiid' => $subwiki->id), IGNORE_MISSING)) {
132                 $result = false;
133             }
134         }
136         # Get existing synonyms, and delete them #
137         if (!$DB->delete_records('wiki_synonyms', array('subwikiid' => $subwiki->id), IGNORE_MISSING)) {
138             $result = false;
139         }
141         # Delete any subwikis #
142         if (!$DB->delete_records('wiki_subwikis', array('id' => $subwiki->id), IGNORE_MISSING)) {
143             $result = false;
144         }
145     }
147     $cm = get_coursemodule_from_instance('wiki', $id);
148     \core_completion\api::update_completion_date_event($cm->id, 'wiki', $wiki->id, null);
150     # Delete any dependent records here #
151     if (!$DB->delete_records('wiki', array('id' => $wiki->id))) {
152         $result = false;
153     }
155     return $result;
158 /**
159  * Implements callback to reset course
160  *
161  * @param stdClass $data
162  * @return boolean|array
163  */
164 function wiki_reset_userdata($data) {
165     global $CFG,$DB;
166     require_once($CFG->dirroot . '/mod/wiki/pagelib.php');
167     require_once($CFG->dirroot . "/mod/wiki/locallib.php");
169     $componentstr = get_string('modulenameplural', 'wiki');
170     $status = array();
172     //get the wiki(s) in this course.
173     if (!$wikis = $DB->get_records('wiki', array('course' => $data->courseid))) {
174         return false;
175     }
176     if (empty($data->reset_wiki_comments) && empty($data->reset_wiki_tags) && empty($data->reset_wiki_pages)) {
177         return $status;
178     }
180     foreach ($wikis as $wiki) {
181         if (!$cm = get_coursemodule_from_instance('wiki', $wiki->id, $data->courseid)) {
182             continue;
183         }
184         $context = context_module::instance($cm->id);
186         // Remove tags or all pages.
187         if (!empty($data->reset_wiki_pages) || !empty($data->reset_wiki_tags)) {
189             // Get subwiki information.
190             $subwikis = wiki_get_subwikis($wiki->id);
192             foreach ($subwikis as $subwiki) {
193                 // Get existing pages.
194                 if ($pages = wiki_get_page_list($subwiki->id)) {
195                     // If the wiki page isn't selected then we are only removing tags.
196                     if (empty($data->reset_wiki_pages)) {
197                         // Go through each page and delete the tags.
198                         foreach ($pages as $page) {
199                             core_tag_tag::remove_all_item_tags('mod_wiki', 'wiki_pages', $page->id);
200                         }
201                     } else {
202                         // Otherwise we are removing pages and tags.
203                         wiki_delete_pages($context, $pages, $subwiki->id);
204                     }
205                 }
206                 if (!empty($data->reset_wiki_pages)) {
207                     // Delete any subwikis.
208                     $DB->delete_records('wiki_subwikis', array('id' => $subwiki->id), IGNORE_MISSING);
210                     // Delete any attached files.
211                     $fs = get_file_storage();
212                     $fs->delete_area_files($context->id, 'mod_wiki', 'attachments');
213                 }
214             }
216             if (!empty($data->reset_wiki_pages)) {
217                 $status[] = array('component' => $componentstr, 'item' => get_string('deleteallpages', 'wiki'),
218                     'error' => false);
219             }
220             if (!empty($data->reset_wiki_tags)) {
221                 $status[] = array('component' => $componentstr, 'item' => get_string('tagsdeleted', 'wiki'), 'error' => false);
222             }
223         }
225         // Remove all comments.
226         if (!empty($data->reset_wiki_comments) || !empty($data->reset_wiki_pages)) {
227             $DB->delete_records_select('comments', "contextid = ? AND commentarea='wiki_page'", array($context->id));
228             if (!empty($data->reset_wiki_comments)) {
229                 $status[] = array('component' => $componentstr, 'item' => get_string('deleteallcomments'), 'error' => false);
230             }
231         }
232     }
234     // Any changes to the list of dates that needs to be rolled should be same during course restore and course reset.
235     // See MDL-9367.
236     shift_course_mod_dates('wiki', array('editbegin', 'editend'), $data->timeshift, $data->courseid);
238     return $status;
242 function wiki_reset_course_form_definition(&$mform) {
243     $mform->addElement('header', 'wikiheader', get_string('modulenameplural', 'wiki'));
244     $mform->addElement('advcheckbox', 'reset_wiki_pages', get_string('deleteallpages', 'wiki'));
245     $mform->addElement('advcheckbox', 'reset_wiki_tags', get_string('removeallwikitags', 'wiki'));
246     $mform->addElement('advcheckbox', 'reset_wiki_comments', get_string('deleteallcomments'));
249 /**
250  * Indicates API features that the wiki supports.
251  *
252  * @uses FEATURE_GROUPS
253  * @uses FEATURE_GROUPINGS
254  * @uses FEATURE_MOD_INTRO
255  * @uses FEATURE_COMPLETION_TRACKS_VIEWS
256  * @uses FEATURE_COMPLETION_HAS_RULES
257  * @uses FEATURE_GRADE_HAS_GRADE
258  * @uses FEATURE_GRADE_OUTCOMES
259  * @param string $feature
260  * @return mixed True if yes (some features may use other values)
261  */
262 function wiki_supports($feature) {
263     switch ($feature) {
264     case FEATURE_GROUPS:
265         return true;
266     case FEATURE_GROUPINGS:
267         return true;
268     case FEATURE_MOD_INTRO:
269         return true;
270     case FEATURE_COMPLETION_TRACKS_VIEWS:
271         return true;
272     case FEATURE_GRADE_HAS_GRADE:
273         return false;
274     case FEATURE_GRADE_OUTCOMES:
275         return false;
276     case FEATURE_RATE:
277         return false;
278     case FEATURE_BACKUP_MOODLE2:
279         return true;
280     case FEATURE_SHOW_DESCRIPTION:
281         return true;
282     case FEATURE_COMMENT:
283         return true;
285     default:
286         return null;
287     }
290 /**
291  * Given a course and a time, this module should find recent activity
292  * that has occurred in wiki activities and print it out.
293  * Return true if there was output, or false is there was none.
294  *
295  * @global $CFG
296  * @global $DB
297  * @uses CONTEXT_MODULE
298  * @uses VISIBLEGROUPS
299  * @param object $course
300  * @param bool $viewfullnames capability
301  * @param int $timestart
302  * @return boolean
303  **/
304 function wiki_print_recent_activity($course, $viewfullnames, $timestart) {
305     global $CFG, $DB, $OUTPUT;
307     $sql = "SELECT p.id, p.timemodified, p.subwikiid, sw.wikiid, w.wikimode, sw.userid, sw.groupid
308             FROM {wiki_pages} p
309                 JOIN {wiki_subwikis} sw ON sw.id = p.subwikiid
310                 JOIN {wiki} w ON w.id = sw.wikiid
311             WHERE p.timemodified > ? AND w.course = ?
312             ORDER BY p.timemodified ASC";
313     if (!$pages = $DB->get_records_sql($sql, array($timestart, $course->id))) {
314         return false;
315     }
316     require_once($CFG->dirroot . "/mod/wiki/locallib.php");
318     $wikis = array();
320     $modinfo = get_fast_modinfo($course);
322     $subwikivisible = array();
323     foreach ($pages as $page) {
324         if (!isset($subwikivisible[$page->subwikiid])) {
325             $subwiki = (object)array('id' => $page->subwikiid, 'wikiid' => $page->wikiid,
326                 'groupid' => $page->groupid, 'userid' => $page->userid);
327             $wiki = (object)array('id' => $page->wikiid, 'course' => $course->id, 'wikimode' => $page->wikimode);
328             $subwikivisible[$page->subwikiid] = wiki_user_can_view($subwiki, $wiki);
329         }
330         if ($subwikivisible[$page->subwikiid]) {
331             $wikis[] = $page;
332         }
333     }
334     unset($subwikivisible);
335     unset($pages);
337     if (!$wikis) {
338         return false;
339     }
340     echo $OUTPUT->heading(get_string("updatedwikipages", 'wiki') . ':', 3);
341     foreach ($wikis as $wiki) {
342         $cm = $modinfo->instances['wiki'][$wiki->wikiid];
343         $link = $CFG->wwwroot . '/mod/wiki/view.php?pageid=' . $wiki->id;
344         print_recent_activity_note($wiki->timemodified, $wiki, $cm->name, $link, false, $viewfullnames);
345     }
347     return true; //  True if anything was printed, otherwise false
349 /**
350  * Function to be run periodically according to the moodle cron
351  * This function searches for things that need to be done, such
352  * as sending out mail, toggling flags etc ...
353  *
354  * @uses $CFG
355  * @return boolean
356  * @todo Finish documenting this function
357  **/
358 function wiki_cron() {
359     global $CFG;
361     return true;
364 /**
365  * Must return an array of grades for a given instance of this module,
366  * indexed by user.  It also returns a maximum allowed grade.
367  *
368  * Example:
369  *    $return->grades = array of grades;
370  *    $return->maxgrade = maximum allowed grade;
371  *
372  *    return $return;
373  *
374  * @param int $wikiid ID of an instance of this module
375  * @return mixed Null or object with an array of grades and with the maximum grade
376  **/
377 function wiki_grades($wikiid) {
378     return null;
381 /**
382  * This function returns if a scale is being used by one wiki
383  * it it has support for grading and scales. Commented code should be
384  * modified if necessary. See forum, glossary or journal modules
385  * as reference.
386  *
387  * @param int $wikiid ID of an instance of this module
388  * @return mixed
389  * @todo Finish documenting this function
390  **/
391 function wiki_scale_used($wikiid, $scaleid) {
392     $return = false;
394     //$rec = get_record("wiki","id","$wikiid","scale","-$scaleid");
395     //
396     //if (!empty($rec)  && !empty($scaleid)) {
397     //    $return = true;
398     //}
400     return $return;
403 /**
404  * Checks if scale is being used by any instance of wiki.
405  * This function was added in 1.9
406  *
407  * This is used to find out if scale used anywhere
408  * @param $scaleid int
409  * @return boolean True if the scale is used by any wiki
410  */
411 function wiki_scale_used_anywhere($scaleid) {
412     global $DB;
414     //if ($scaleid and $DB->record_exists('wiki', array('grade' => -$scaleid))) {
415     //    return true;
416     //} else {
417     //    return false;
418     //}
420     return false;
423 /**
424  * file serving callback
425  *
426  * @copyright Josep Arus
427  * @package  mod_wiki
428  * @category files
429  * @param stdClass $course course object
430  * @param stdClass $cm course module object
431  * @param stdClass $context context object
432  * @param string $filearea file area
433  * @param array $args extra arguments
434  * @param bool $forcedownload whether or not force download
435  * @param array $options additional options affecting the file serving
436  * @return bool false if the file was not found, just send the file otherwise and do not return anything
437  */
438 function wiki_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array()) {
439     global $CFG;
441     if ($context->contextlevel != CONTEXT_MODULE) {
442         return false;
443     }
445     require_login($course, true, $cm);
447     require_once($CFG->dirroot . "/mod/wiki/locallib.php");
449     if ($filearea == 'attachments') {
450         $swid = (int) array_shift($args);
452         if (!$subwiki = wiki_get_subwiki($swid)) {
453             return false;
454         }
456         require_capability('mod/wiki:viewpage', $context);
458         $relativepath = implode('/', $args);
460         $fullpath = "/$context->id/mod_wiki/attachments/$swid/$relativepath";
462         $fs = get_file_storage();
463         if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
464             return false;
465         }
467         send_stored_file($file, null, 0, $options);
468     }
471 function wiki_search_form($cm, $search = '', $subwiki = null) {
472     global $CFG, $OUTPUT;
474     $output = '<div class="wikisearch">';
475     $output .= '<form method="post" action="' . $CFG->wwwroot . '/mod/wiki/search.php" style="display:inline">';
476     $output .= '<fieldset class="invisiblefieldset">';
477     $output .= '<legend class="accesshide">'. get_string('searchwikis', 'wiki') .'</legend>';
478     $output .= '<label class="accesshide" for="searchwiki">' . get_string("searchterms", "wiki") . '</label>';
479     $output .= '<input id="searchwiki" name="searchstring" type="text" size="18" value="' . s($search, true) . '" alt="search" />';
480     $output .= '<input name="courseid" type="hidden" value="' . $cm->course . '" />';
481     $output .= '<input name="cmid" type="hidden" value="' . $cm->id . '" />';
482     if (!empty($subwiki->id)) {
483         $output .= '<input name="subwikiid" type="hidden" value="' . $subwiki->id . '" />';
484     }
485     $output .= '<input name="searchwikicontent" type="hidden" value="1" />';
486     $output .= '<input value="' . get_string('searchwikis', 'wiki') . '" type="submit" />';
487     $output .= '</fieldset>';
488     $output .= '</form>';
489     $output .= '</div>';
491     return $output;
493 function wiki_extend_navigation(navigation_node $navref, $course, $module, $cm) {
494     global $CFG, $PAGE, $USER;
496     require_once($CFG->dirroot . '/mod/wiki/locallib.php');
498     $context = context_module::instance($cm->id);
499     $url = $PAGE->url;
500     $userid = 0;
501     if ($module->wikimode == 'individual') {
502         $userid = $USER->id;
503     }
505     if (!$wiki = wiki_get_wiki($cm->instance)) {
506         return false;
507     }
509     if (!$gid = groups_get_activity_group($cm)) {
510         $gid = 0;
511     }
512     if (!$subwiki = wiki_get_subwiki_by_group($cm->instance, $gid, $userid)) {
513         return null;
514     } else {
515         $swid = $subwiki->id;
516     }
518     $pageid = $url->param('pageid');
519     $cmid = $url->param('id');
520     if (empty($pageid) && !empty($cmid)) {
521         // wiki main page
522         $page = wiki_get_page_by_title($swid, $wiki->firstpagetitle);
523         $pageid = $page->id;
524     }
526     if (wiki_can_create_pages($context)) {
527         $link = new moodle_url('/mod/wiki/create.php', array('action' => 'new', 'swid' => $swid));
528         $node = $navref->add(get_string('newpage', 'wiki'), $link, navigation_node::TYPE_SETTING);
529     }
531     if (is_numeric($pageid)) {
533         if (has_capability('mod/wiki:viewpage', $context)) {
534             $link = new moodle_url('/mod/wiki/view.php', array('pageid' => $pageid));
535             $node = $navref->add(get_string('view', 'wiki'), $link, navigation_node::TYPE_SETTING);
536         }
538         if (wiki_user_can_edit($subwiki)) {
539             $link = new moodle_url('/mod/wiki/edit.php', array('pageid' => $pageid));
540             $node = $navref->add(get_string('edit', 'wiki'), $link, navigation_node::TYPE_SETTING);
541         }
543         if (has_capability('mod/wiki:viewcomment', $context)) {
544             $link = new moodle_url('/mod/wiki/comments.php', array('pageid' => $pageid));
545             $node = $navref->add(get_string('comments', 'wiki'), $link, navigation_node::TYPE_SETTING);
546         }
548         if (has_capability('mod/wiki:viewpage', $context)) {
549             $link = new moodle_url('/mod/wiki/history.php', array('pageid' => $pageid));
550             $node = $navref->add(get_string('history', 'wiki'), $link, navigation_node::TYPE_SETTING);
551         }
553         if (has_capability('mod/wiki:viewpage', $context)) {
554             $link = new moodle_url('/mod/wiki/map.php', array('pageid' => $pageid));
555             $node = $navref->add(get_string('map', 'wiki'), $link, navigation_node::TYPE_SETTING);
556         }
558         if (has_capability('mod/wiki:viewpage', $context)) {
559             $link = new moodle_url('/mod/wiki/files.php', array('pageid' => $pageid));
560             $node = $navref->add(get_string('files', 'wiki'), $link, navigation_node::TYPE_SETTING);
561         }
563         if (has_capability('mod/wiki:managewiki', $context)) {
564             $link = new moodle_url('/mod/wiki/admin.php', array('pageid' => $pageid));
565             $node = $navref->add(get_string('admin', 'wiki'), $link, navigation_node::TYPE_SETTING);
566         }
567     }
569 /**
570  * Returns all other caps used in wiki module
571  *
572  * @return array
573  */
574 function wiki_get_extra_capabilities() {
575     return array('moodle/comment:view', 'moodle/comment:post', 'moodle/comment:delete');
578 /**
579  * Running addtional permission check on plugin, for example, plugins
580  * may have switch to turn on/off comments option, this callback will
581  * affect UI display, not like pluginname_comment_validate only throw
582  * exceptions.
583  * Capability check has been done in comment->check_permissions(), we
584  * don't need to do it again here.
585  *
586  * @package  mod_wiki
587  * @category comment
588  *
589  * @param stdClass $comment_param {
590  *              context  => context the context object
591  *              courseid => int course id
592  *              cm       => stdClass course module object
593  *              commentarea => string comment area
594  *              itemid      => int itemid
595  * }
596  * @return array
597  */
598 function wiki_comment_permissions($comment_param) {
599     return array('post'=>true, 'view'=>true);
602 /**
603  * Validate comment parameter before perform other comments actions
604  *
605  * @param stdClass $comment_param {
606  *              context  => context the context object
607  *              courseid => int course id
608  *              cm       => stdClass course module object
609  *              commentarea => string comment area
610  *              itemid      => int itemid
611  * }
612  *
613  * @package  mod_wiki
614  * @category comment
615  *
616  * @return boolean
617  */
618 function wiki_comment_validate($comment_param) {
619     global $DB, $CFG;
620     require_once($CFG->dirroot . '/mod/wiki/locallib.php');
621     // validate comment area
622     if ($comment_param->commentarea != 'wiki_page') {
623         throw new comment_exception('invalidcommentarea');
624     }
625     // validate itemid
626     if (!$record = $DB->get_record('wiki_pages', array('id'=>$comment_param->itemid))) {
627         throw new comment_exception('invalidcommentitemid');
628     }
629     if (!$subwiki = wiki_get_subwiki($record->subwikiid)) {
630         throw new comment_exception('invalidsubwikiid');
631     }
632     if (!$wiki = wiki_get_wiki_from_pageid($comment_param->itemid)) {
633         throw new comment_exception('invalidid', 'data');
634     }
635     if (!$course = $DB->get_record('course', array('id'=>$wiki->course))) {
636         throw new comment_exception('coursemisconf');
637     }
638     if (!$cm = get_coursemodule_from_instance('wiki', $wiki->id, $course->id)) {
639         throw new comment_exception('invalidcoursemodule');
640     }
641     $context = context_module::instance($cm->id);
642     // group access
643     if ($subwiki->groupid) {
644         $groupmode = groups_get_activity_groupmode($cm, $course);
645         if ($groupmode == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $context)) {
646             if (!groups_is_member($subwiki->groupid)) {
647                 throw new comment_exception('notmemberofgroup');
648             }
649         }
650     }
651     // validate context id
652     if ($context->id != $comment_param->context->id) {
653         throw new comment_exception('invalidcontext');
654     }
655     // validation for comment deletion
656     if (!empty($comment_param->commentid)) {
657         if ($comment = $DB->get_record('comments', array('id'=>$comment_param->commentid))) {
658             if ($comment->commentarea != 'wiki_page') {
659                 throw new comment_exception('invalidcommentarea');
660             }
661             if ($comment->contextid != $context->id) {
662                 throw new comment_exception('invalidcontext');
663             }
664             if ($comment->itemid != $comment_param->itemid) {
665                 throw new comment_exception('invalidcommentitemid');
666             }
667         } else {
668             throw new comment_exception('invalidcommentid');
669         }
670     }
671     return true;
674 /**
675  * Return a list of page types
676  * @param string $pagetype current page type
677  * @param stdClass $parentcontext Block's parent context
678  * @param stdClass $currentcontext Current context of block
679  */
680 function wiki_page_type_list($pagetype, $parentcontext, $currentcontext) {
681     $module_pagetype = array(
682         'mod-wiki-*'=>get_string('page-mod-wiki-x', 'wiki'),
683         'mod-wiki-view'=>get_string('page-mod-wiki-view', 'wiki'),
684         'mod-wiki-comments'=>get_string('page-mod-wiki-comments', 'wiki'),
685         'mod-wiki-history'=>get_string('page-mod-wiki-history', 'wiki'),
686         'mod-wiki-map'=>get_string('page-mod-wiki-map', 'wiki')
687     );
688     return $module_pagetype;
691 /**
692  * Mark the activity completed (if required) and trigger the course_module_viewed event.
693  *
694  * @param  stdClass $wiki       Wiki object.
695  * @param  stdClass $course     Course object.
696  * @param  stdClass $cm         Course module object.
697  * @param  stdClass $context    Context object.
698  * @since Moodle 3.1
699  */
700 function wiki_view($wiki, $course, $cm, $context) {
701     // Trigger course_module_viewed event.
702     $params = array(
703         'context' => $context,
704         'objectid' => $wiki->id
705     );
706     $event = \mod_wiki\event\course_module_viewed::create($params);
707     $event->add_record_snapshot('course_modules', $cm);
708     $event->add_record_snapshot('course', $course);
709     $event->add_record_snapshot('wiki', $wiki);
710     $event->trigger();
712     // Completion.
713     $completion = new completion_info($course);
714     $completion->set_module_viewed($cm);
717 /**
718  * Mark the activity completed (if required) and trigger the page_viewed event.
719  *
720  * @param  stdClass $wiki       Wiki object.
721  * @param  stdClass $page       Page object.
722  * @param  stdClass $course     Course object.
723  * @param  stdClass $cm         Course module object.
724  * @param  stdClass $context    Context object.
725  * @param  int $uid             Optional User ID.
726  * @param  array $other         Optional Other params: title, wiki ID, group ID, groupanduser, prettyview.
727  * @param  stdClass $subwiki    Optional Subwiki.
728  * @since Moodle 3.1
729  */
730 function wiki_page_view($wiki, $page, $course, $cm, $context, $uid = null, $other = null, $subwiki = null) {
732     // Trigger course_module_viewed event.
733     $params = array(
734         'context' => $context,
735         'objectid' => $page->id
736     );
737     if ($uid != null) {
738         $params['relateduserid'] = $uid;
739     }
740     if ($other != null) {
741         $params['other'] = $other;
742     }
744     $event = \mod_wiki\event\page_viewed::create($params);
746     $event->add_record_snapshot('wiki_pages', $page);
747     $event->add_record_snapshot('course_modules', $cm);
748     $event->add_record_snapshot('course', $course);
749     $event->add_record_snapshot('wiki', $wiki);
750     if ($subwiki != null) {
751         $event->add_record_snapshot('wiki_subwikis', $subwiki);
752     }
753     $event->trigger();
755     // Completion.
756     $completion = new completion_info($course);
757     $completion->set_module_viewed($cm);
760 /**
761  * Check if the module has any update that affects the current user since a given time.
762  *
763  * @param  cm_info $cm course module data
764  * @param  int $from the time to check updates from
765  * @param  array $filter  if we need to check only specific updates
766  * @return stdClass an object with the different type of areas indicating if they were updated or not
767  * @since Moodle 3.2
768  */
769 function wiki_check_updates_since(cm_info $cm, $from, $filter = array()) {
770     global $DB, $CFG;
771     require_once($CFG->dirroot . '/mod/wiki/locallib.php');
773     $updates = new stdClass();
774     if (!has_capability('mod/wiki:viewpage', $cm->context)) {
775         return $updates;
776     }
777     $updates = course_check_module_updates_since($cm, $from, array('attachments'), $filter);
779     // Check only pages updated in subwikis the user can access.
780     $updates->pages = (object) array('updated' => false);
781     $wiki = $DB->get_record($cm->modname, array('id' => $cm->instance), '*', MUST_EXIST);
782     if ($subwikis = wiki_get_visible_subwikis($wiki, $cm, $cm->context)) {
783         $subwikisids = array();
784         foreach ($subwikis as $subwiki) {
785             $subwikisids[] = $subwiki->id;
786         }
787         list($subwikissql, $params) = $DB->get_in_or_equal($subwikisids, SQL_PARAMS_NAMED);
788         $select = 'subwikiid ' . $subwikissql . ' AND (timemodified > :since1 OR timecreated > :since2)';
789         $params['since1'] = $from;
790         $params['since2'] = $from;
791         $pages = $DB->get_records_select('wiki_pages', $select, $params, '', 'id');
792         if (!empty($pages)) {
793             $updates->pages->updated = true;
794             $updates->pages->itemids = array_keys($pages);
795         }
796     }
797     return $updates;
800 /**
801  * Get icon mapping for font-awesome.
802  */
803 function mod_wiki_get_fontawesome_icon_map() {
804     return [
805         'mod_wiki:attachment' => 'fa-paperclip',
806     ];
809 /**
810  * This function receives a calendar event and returns the action associated with it, or null if there is none.
811  *
812  * This is used by block_myoverview in order to display the event appropriately. If null is returned then the event
813  * is not displayed on the block.
814  *
815  * @param calendar_event $event
816  * @param \core_calendar\action_factory $factory
817  * @return \core_calendar\local\event\entities\action_interface|null
818  */
819 function mod_wiki_core_calendar_provide_event_action(calendar_event $event,
820                                                     \core_calendar\action_factory $factory) {
821     $cm = get_fast_modinfo($event->courseid)->instances['wiki'][$event->instance];
823     $completion = new \completion_info($cm->get_course());
825     $completiondata = $completion->get_data($cm, false);
827     if ($completiondata->completionstate != COMPLETION_INCOMPLETE) {
828         return null;
829     }
831     return $factory->create_instance(
832         get_string('view'),
833         new \moodle_url('/mod/wiki/view.php', ['id' => $cm->id]),
834         1,
835         true
836     );