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