MDL-55130 wiki: Reduce data usage when only renew lock is needed.
[moodle.git] / mod / wiki / locallib.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  * This contains functions and classes that will be used by scripts in wiki module
20  *
21  * @package mod_wiki
22  * @copyright 2009 Marc Alier, Jordi Piguillem marc.alier@upc.edu
23  * @copyright 2009 Universitat Politecnica de Catalunya http://www.upc.edu
24  *
25  * @author Jordi Piguillem
26  * @author Marc Alier
27  * @author David Jimenez
28  * @author Josep Arus
29  * @author Daniel Serrano
30  * @author Kenneth Riba
31  *
32  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
33  */
35 require_once($CFG->dirroot . '/mod/wiki/lib.php');
36 require_once($CFG->dirroot . '/mod/wiki/parser/parser.php');
37 require_once($CFG->libdir . '/filelib.php');
39 define('WIKI_REFRESH_CACHE_TIME', 30); // @TODO: To be deleted.
40 define('FORMAT_CREOLE', '37');
41 define('FORMAT_NWIKI', '38');
42 define('NO_VALID_RATE', '-999');
43 define('IMPROVEMENT', '+');
44 define('EQUAL', '=');
45 define('WORST', '-');
47 define('LOCK_TIMEOUT', 30);
49 /**
50  * Get a wiki instance
51  * @param int $wikiid the instance id of wiki
52  */
53 function wiki_get_wiki($wikiid) {
54     global $DB;
56     return $DB->get_record('wiki', array('id' => $wikiid));
57 }
59 /**
60  * Get sub wiki instances with same wiki id
61  * @param int $wikiid
62  */
63 function wiki_get_subwikis($wikiid) {
64     global $DB;
65     return $DB->get_records('wiki_subwikis', array('wikiid' => $wikiid));
66 }
68 /**
69  * Get a sub wiki instance by wiki id and group id
70  * @param int $wikiid
71  * @param int $groupid
72  * @return object
73  */
74 function wiki_get_subwiki_by_group($wikiid, $groupid, $userid = 0) {
75     global $DB;
76     return $DB->get_record('wiki_subwikis', array('wikiid' => $wikiid, 'groupid' => $groupid, 'userid' => $userid));
77 }
79 /**
80  * Get a sub wiki instace by instance id
81  * @param int $subwikiid
82  * @return object
83  */
84 function wiki_get_subwiki($subwikiid) {
85     global $DB;
86     return $DB->get_record('wiki_subwikis', array('id' => $subwikiid));
88 }
90 /**
91  * Add a new sub wiki instance
92  * @param int $wikiid
93  * @param int $groupid
94  * @return int $insertid
95  */
96 function wiki_add_subwiki($wikiid, $groupid, $userid = 0) {
97     global $DB;
99     $record = new StdClass();
100     $record->wikiid = $wikiid;
101     $record->groupid = $groupid;
102     $record->userid = $userid;
104     $insertid = $DB->insert_record('wiki_subwikis', $record);
105     return $insertid;
108 /**
109  * Get a wiki instance by pageid
110  * @param int $pageid
111  * @return object
112  */
113 function wiki_get_wiki_from_pageid($pageid) {
114     global $DB;
116     $sql = "SELECT w.*
117             FROM {wiki} w, {wiki_subwikis} s, {wiki_pages} p
118             WHERE p.id = ? AND
119             p.subwikiid = s.id AND
120             s.wikiid = w.id";
122     return $DB->get_record_sql($sql, array($pageid));
125 /**
126  * Get a wiki page by pageid
127  * @param int $pageid
128  * @return object
129  */
130 function wiki_get_page($pageid) {
131     global $DB;
132     return $DB->get_record('wiki_pages', array('id' => $pageid));
135 /**
136  * Get latest version of wiki page
137  * @param int $pageid
138  * @return object
139  */
140 function wiki_get_current_version($pageid) {
141     global $DB;
143     // @TODO: Fix this query
144     $sql = "SELECT *
145             FROM {wiki_versions}
146             WHERE pageid = ?
147             ORDER BY version DESC";
148     $records = $DB->get_records_sql($sql, array($pageid), 0, 1);
149     return array_pop($records);
153 /**
154  * Alias of wiki_get_current_version
155  * @TODO, does the exactly same thing as wiki_get_current_version, should be removed
156  * @param int $pageid
157  * @return object
158  */
159 function wiki_get_last_version($pageid) {
160     return wiki_get_current_version($pageid);
163 /**
164  * Get page section
165  * @param int $pageid
166  * @param string $section
167  */
168 function wiki_get_section_page($page, $section) {
170     $version = wiki_get_current_version($page->id);
171     return wiki_parser_proxy::get_section($version->content, $version->contentformat, $section);
174 /**
175  * Get a wiki page by page title
176  * @param int $swid, sub wiki id
177  * @param string $title
178  * @return object
179  */
180 function wiki_get_page_by_title($swid, $title) {
181     global $DB;
182     return $DB->get_record('wiki_pages', array('subwikiid' => $swid, 'title' => $title));
185 /**
186  * Get a version record by record id
187  * @param int $versionid, the version id
188  * @return object
189  */
190 function wiki_get_version($versionid) {
191     global $DB;
192     return $DB->get_record('wiki_versions', array('id' => $versionid));
195 /**
196  * Get first page of wiki instace
197  * @param int $subwikiid
198  * @param int $module, wiki instance object
199  */
200 function wiki_get_first_page($subwikid, $module = null) {
201     global $DB, $USER;
203     $sql = "SELECT p.*
204             FROM {wiki} w, {wiki_subwikis} s, {wiki_pages} p
205             WHERE s.id = ? AND
206             s.wikiid = w.id AND
207             w.firstpagetitle = p.title AND
208             p.subwikiid = s.id";
209     return $DB->get_record_sql($sql, array($subwikid));
212 function wiki_save_section($wikipage, $sectiontitle, $sectioncontent, $userid) {
214     $wiki = wiki_get_wiki_from_pageid($wikipage->id);
215     $cm = get_coursemodule_from_instance('wiki', $wiki->id);
216     $context = context_module::instance($cm->id);
218     if (has_capability('mod/wiki:editpage', $context)) {
219         $version = wiki_get_current_version($wikipage->id);
220         $content = wiki_parser_proxy::get_section($version->content, $version->contentformat, $sectiontitle, true);
222         $newcontent = $content[0] . $sectioncontent . $content[2];
224         return wiki_save_page($wikipage, $newcontent, $userid);
225     } else {
226         return false;
227     }
230 /**
231  * Save page content
232  * @param object $wikipage
233  * @param string $newcontent
234  * @param int $userid
235  */
236 function wiki_save_page($wikipage, $newcontent, $userid) {
237     global $DB;
239     $wiki = wiki_get_wiki_from_pageid($wikipage->id);
240     $cm = get_coursemodule_from_instance('wiki', $wiki->id);
241     $context = context_module::instance($cm->id);
243     if (has_capability('mod/wiki:editpage', $context)) {
244         $version = wiki_get_current_version($wikipage->id);
246         $version->content = $newcontent;
247         $version->userid = $userid;
248         $version->version++;
249         $version->timecreated = time();
250         $version->id = $DB->insert_record('wiki_versions', $version);
252         $wikipage->timemodified = $version->timecreated;
253         $wikipage->userid = $userid;
254         $return = wiki_refresh_cachedcontent($wikipage, $newcontent);
255         $event = \mod_wiki\event\page_updated::create(
256                 array(
257                     'context' => $context,
258                     'objectid' => $wikipage->id,
259                     'relateduserid' => $userid,
260                     'other' => array(
261                         'newcontent' => $newcontent
262                         )
263                     ));
264         $event->add_record_snapshot('wiki', $wiki);
265         $event->add_record_snapshot('wiki_pages', $wikipage);
266         $event->add_record_snapshot('wiki_versions', $version);
267         $event->trigger();
268         return $return;
269     } else {
270         return false;
271     }
274 function wiki_refresh_cachedcontent($page, $newcontent = null) {
275     global $DB;
277     $version = wiki_get_current_version($page->id);
278     if (empty($version)) {
279         return null;
280     }
281     if (!isset($newcontent)) {
282         $newcontent = $version->content;
283     }
285     $options = array('swid' => $page->subwikiid, 'pageid' => $page->id);
286     $parseroutput = wiki_parse_content($version->contentformat, $newcontent, $options);
287     $page->cachedcontent = $parseroutput['toc'] . $parseroutput['parsed_text'];
288     $page->timerendered = time();
289     $DB->update_record('wiki_pages', $page);
291     wiki_refresh_page_links($page, $parseroutput['link_count']);
293     return array('page' => $page, 'sections' => $parseroutput['repeated_sections'], 'version' => $version->version);
296 /**
297  * Restore a page with specified version.
298  *
299  * @param stdClass $wikipage wiki page record
300  * @param stdClass $version wiki page version to restore
301  * @param context_module $context context of wiki module
302  * @return stdClass restored page
303  */
304 function wiki_restore_page($wikipage, $version, $context) {
305     $return = wiki_save_page($wikipage, $version->content, $version->userid);
306     $event = \mod_wiki\event\page_version_restored::create(
307             array(
308                 'context' => $context,
309                 'objectid' => $version->id,
310                 'other' => array(
311                     'pageid' => $wikipage->id
312                     )
313                 ));
314     $event->add_record_snapshot('wiki_versions', $version);
315     $event->trigger();
316     return $return['page'];
319 function wiki_refresh_page_links($page, $links) {
320     global $DB;
322     $DB->delete_records('wiki_links', array('frompageid' => $page->id));
323     foreach ($links as $linkname => $linkinfo) {
325         $newlink = new stdClass();
326         $newlink->subwikiid = $page->subwikiid;
327         $newlink->frompageid = $page->id;
329         if ($linkinfo['new']) {
330             $newlink->tomissingpage = $linkname;
331         } else {
332             $newlink->topageid = $linkinfo['pageid'];
333         }
335         try {
336             $DB->insert_record('wiki_links', $newlink);
337         } catch (dml_exception $e) {
338             debugging($e->getMessage());
339         }
341     }
344 /**
345  * Create a new wiki page, if the page exists, return existing pageid
346  * @param int $swid
347  * @param string $title
348  * @param string $format
349  * @param int $userid
350  */
351 function wiki_create_page($swid, $title, $format, $userid) {
352     global $DB;
353     $subwiki = wiki_get_subwiki($swid);
354     $cm = get_coursemodule_from_instance('wiki', $subwiki->wikiid);
355     $context = context_module::instance($cm->id);
356     require_capability('mod/wiki:editpage', $context);
357     // if page exists
358     if ($page = wiki_get_page_by_title($swid, $title)) {
359         return $page->id;
360     }
362     // Creating a new empty version
363     $version = new stdClass();
364     $version->content = '';
365     $version->contentformat = $format;
366     $version->version = 0;
367     $version->timecreated = time();
368     $version->userid = $userid;
370     $versionid = null;
371     $versionid = $DB->insert_record('wiki_versions', $version);
373     // Createing a new empty page
374     $page = new stdClass();
375     $page->subwikiid = $swid;
376     $page->title = $title;
377     $page->cachedcontent = '';
378     $page->timecreated = $version->timecreated;
379     $page->timemodified = $version->timecreated;
380     $page->timerendered = $version->timecreated;
381     $page->userid = $userid;
382     $page->pageviews = 0;
383     $page->readonly = 0;
385     $pageid = $DB->insert_record('wiki_pages', $page);
387     // Setting the pageid
388     $version->id = $versionid;
389     $version->pageid = $pageid;
390     $DB->update_record('wiki_versions', $version);
392     $event = \mod_wiki\event\page_created::create(
393             array(
394                 'context' => $context,
395                 'objectid' => $pageid
396                 )
397             );
398     $event->trigger();
400     wiki_make_cache_expire($page->title);
401     return $pageid;
404 function wiki_make_cache_expire($pagename) {
405     global $DB;
407     $sql = "UPDATE {wiki_pages}
408             SET timerendered = 0
409             WHERE id IN ( SELECT l.frompageid
410                 FROM {wiki_links} l
411                 WHERE l.tomissingpage = ?
412             )";
413     $DB->execute ($sql, array($pagename));
416 /**
417  * Get a specific version of page
418  * @param int $pageid
419  * @param int $version
420  */
421 function wiki_get_wiki_page_version($pageid, $version) {
422     global $DB;
423     return $DB->get_record('wiki_versions', array('pageid' => $pageid, 'version' => $version));
426 /**
427  * Get version list
428  * @param int $pageid
429  * @param int $limitfrom
430  * @param int $limitnum
431  */
432 function wiki_get_wiki_page_versions($pageid, $limitfrom, $limitnum) {
433     global $DB;
434     return $DB->get_records('wiki_versions', array('pageid' => $pageid), 'version DESC', '*', $limitfrom, $limitnum);
437 /**
438  * Count the number of page version
439  * @param int $pageid
440  */
441 function wiki_count_wiki_page_versions($pageid) {
442     global $DB;
443     return $DB->count_records('wiki_versions', array('pageid' => $pageid));
446 /**
447  * Get linked from page
448  * @param int $pageid
449  */
450 function wiki_get_linked_to_pages($pageid) {
451     global $DB;
452     return $DB->get_records('wiki_links', array('frompageid' => $pageid));
455 /**
456  * Get linked from page
457  * @param int $pageid
458  */
459 function wiki_get_linked_from_pages($pageid) {
460     global $DB;
461     return $DB->get_records('wiki_links', array('topageid' => $pageid));
464 /**
465  * Get pages which user have been edited
466  * @param int $swid
467  * @param int $userid
468  */
469 function wiki_get_contributions($swid, $userid) {
470     global $DB;
472     $sql = "SELECT v.*
473             FROM {wiki_versions} v, {wiki_pages} p
474             WHERE p.subwikiid = ? AND
475             v.pageid = p.id AND
476             v.userid = ?";
478     return $DB->get_records_sql($sql, array($swid, $userid));
481 /**
482  * Get missing or empty pages in wiki
483  * @param int $swid sub wiki id
484  */
485 function wiki_get_missing_or_empty_pages($swid) {
486     global $DB;
488     $sql = "SELECT DISTINCT p.title, p.id, p.subwikiid
489             FROM {wiki} w, {wiki_subwikis} s, {wiki_pages} p
490             WHERE s.wikiid = w.id and
491             s.id = ? and
492             w.firstpagetitle != p.title and
493             p.subwikiid = ? and
494             1 =  (SELECT count(*)
495                 FROM {wiki_versions} v
496                 WHERE v.pageid = p.id)
497             UNION
498             SELECT DISTINCT l.tomissingpage as title, 0 as id, l.subwikiid
499             FROM {wiki_links} l
500             WHERE l.subwikiid = ? and
501             l.topageid = 0";
503     return $DB->get_records_sql($sql, array($swid, $swid, $swid));
506 /**
507  * Get pages list in wiki
508  * @param int $swid sub wiki id
509  * @param string $sort How to sort the pages. By default, title ASC.
510  */
511 function wiki_get_page_list($swid, $sort = 'title ASC') {
512     global $DB;
513     $records = $DB->get_records('wiki_pages', array('subwikiid' => $swid), $sort);
514     return $records;
517 /**
518  * Return a list of orphaned wikis for one specific subwiki
519  * @global object
520  * @param int $swid sub wiki id
521  */
522 function wiki_get_orphaned_pages($swid) {
523     global $DB;
525     $sql = "SELECT p.id, p.title
526             FROM {wiki_pages} p, {wiki} w , {wiki_subwikis} s
527             WHERE p.subwikiid = ?
528             AND s.id = ?
529             AND w.id = s.wikiid
530             AND p.title != w.firstpagetitle
531             AND p.id NOT IN (SELECT topageid FROM {wiki_links} WHERE subwikiid = ?)";
533     return $DB->get_records_sql($sql, array($swid, $swid, $swid));
536 /**
537  * Search wiki title
538  * @param int $swid sub wiki id
539  * @param string $search
540  */
541 function wiki_search_title($swid, $search) {
542     global $DB;
544     return $DB->get_records_select('wiki_pages', "subwikiid = ? AND title LIKE ?", array($swid, '%'.$search.'%'));
547 /**
548  * Search wiki content
549  * @param int $swid sub wiki id
550  * @param string $search
551  */
552 function wiki_search_content($swid, $search) {
553     global $DB;
555     return $DB->get_records_select('wiki_pages', "subwikiid = ? AND cachedcontent LIKE ?", array($swid, '%'.$search.'%'));
558 /**
559  * Search wiki title and content
560  * @param int $swid sub wiki id
561  * @param string $search
562  */
563 function wiki_search_all($swid, $search) {
564     global $DB;
566     return $DB->get_records_select('wiki_pages', "subwikiid = ? AND (cachedcontent LIKE ? OR title LIKE ?)", array($swid, '%'.$search.'%', '%'.$search.'%'));
569 /**
570  * Get user data
571  */
572 function wiki_get_user_info($userid) {
573     global $DB;
574     return $DB->get_record('user', array('id' => $userid));
577 /**
578  * Increase page view nubmer
579  * @param int $page, database record
580  */
581 function wiki_increment_pageviews($page) {
582     global $DB;
584     $page->pageviews++;
585     $DB->update_record('wiki_pages', $page);
588 //----------------------------------------------------------
589 //----------------------------------------------------------
591 /**
592  * Text format supported by wiki module
593  */
594 function wiki_get_formats() {
595     return array('html', 'creole', 'nwiki');
598 /**
599  * Parses a string with the wiki markup language in $markup.
600  *
601  * @return Array or false when something wrong has happened.
602  *
603  * Returned array contains the following fields:
604  *     'parsed_text' => String. Contains the parsed wiki content.
605  *     'unparsed_text' => String. Constains the original wiki content.
606  *     'link_count' => Array of array('destination' => ..., 'new' => "is new?"). Contains the internal wiki links found in the wiki content.
607  *      'deleted_sections' => the list of deleted sections.
608  *              '' =>
609  *
610  * @author Josep Arús Pous
611  **/
612 function wiki_parse_content($markup, $pagecontent, $options = array()) {
613     global $PAGE;
615     $subwiki = wiki_get_subwiki($options['swid']);
616     $cm = get_coursemodule_from_instance("wiki", $subwiki->wikiid);
617     $context = context_module::instance($cm->id);
619     $parser_options = array(
620         'link_callback' => '/mod/wiki/locallib.php:wiki_parser_link',
621         'link_callback_args' => array('swid' => $options['swid']),
622         'table_callback' => '/mod/wiki/locallib.php:wiki_parser_table',
623         'real_path_callback' => '/mod/wiki/locallib.php:wiki_parser_real_path',
624         'real_path_callback_args' => array(
625             'context' => $context,
626             'component' => 'mod_wiki',
627             'filearea' => 'attachments',
628             'subwikiid'=> $subwiki->id,
629             'pageid' => $options['pageid']
630         ),
631         'pageid' => $options['pageid'],
632         'pretty_print' => (isset($options['pretty_print']) && $options['pretty_print']),
633         'printable' => (isset($options['printable']) && $options['printable'])
634     );
636     return wiki_parser_proxy::parse($pagecontent, $markup, $parser_options);
639 /**
640  * This function is the parser callback to parse wiki links.
641  *
642  * It returns the necesary information to print a link.
643  *
644  * NOTE: Empty pages and non-existent pages must be print in red color.
645  *
646  * !!!!!! IMPORTANT !!!!!!
647  * It is critical that you call format_string on the content before it is used.
648  *
649  * @param string|page_wiki $link name of a page
650  * @param array $options
651  * @return array Array('content' => string, 'url' => string, 'new' => bool, 'link_info' => array)
652  *
653  * @TODO Doc return and options
654  */
655 function wiki_parser_link($link, $options = null) {
656     global $CFG;
658     if (is_object($link)) {
659         $parsedlink = array('content' => $link->title, 'url' => $CFG->wwwroot . '/mod/wiki/view.php?pageid=' . $link->id, 'new' => false, 'link_info' => array('link' => $link->title, 'pageid' => $link->id, 'new' => false));
661         $version = wiki_get_current_version($link->id);
662         if ($version->version == 0) {
663             $parsedlink['new'] = true;
664         }
665         return $parsedlink;
666     } else {
667         $swid = $options['swid'];
669         if ($page = wiki_get_page_by_title($swid, $link)) {
670             $parsedlink = array('content' => $link, 'url' => $CFG->wwwroot . '/mod/wiki/view.php?pageid=' . $page->id, 'new' => false, 'link_info' => array('link' => $link, 'pageid' => $page->id, 'new' => false));
672             $version = wiki_get_current_version($page->id);
673             if ($version->version == 0) {
674                 $parsedlink['new'] = true;
675             }
677             return $parsedlink;
679         } else {
680             return array('content' => $link, 'url' => $CFG->wwwroot . '/mod/wiki/create.php?swid=' . $swid . '&amp;title=' . urlencode($link) . '&amp;action=new', 'new' => true, 'link_info' => array('link' => $link, 'new' => true, 'pageid' => 0));
681         }
682     }
685 /**
686  * Returns the table fully parsed (HTML)
687  *
688  * @return HTML for the table $table
689  * @author Josep Arús Pous
690  *
691  **/
692 function wiki_parser_table($table) {
693     global $OUTPUT;
695     $htmltable = new html_table();
697     $headers = $table[0];
698     $htmltable->head = array();
699     foreach ($headers as $h) {
700         $htmltable->head[] = $h[1];
701     }
703     array_shift($table);
704     $htmltable->data = array();
705     foreach ($table as $row) {
706         $row_data = array();
707         foreach ($row as $r) {
708             $row_data[] = $r[1];
709         }
710         $htmltable->data[] = $row_data;
711     }
713     return html_writer::table($htmltable);
716 /**
717  * Returns an absolute path link, unless there is no such link.
718  *
719  * @param string $url Link's URL or filename
720  * @param stdClass $context filearea params
721  * @param string $component The component the file is associated with
722  * @param string $filearea The filearea the file is stored in
723  * @param int $swid Sub wiki id
724  *
725  * @return string URL for files full path
726  */
728 function wiki_parser_real_path($url, $context, $component, $filearea, $swid) {
729     global $CFG;
731     if (preg_match("/^(?:http|ftp)s?\:\/\//", $url)) {
732         return $url;
733     } else {
735         $file = 'pluginfile.php';
736         if (!$CFG->slasharguments) {
737             $file = $file . '?file=';
738         }
739         $baseurl = "$CFG->wwwroot/$file/{$context->id}/$component/$filearea/$swid/";
740         // it is a file in current file area
741         return $baseurl . $url;
742     }
745 /**
746  * Returns the token used by a wiki language to represent a given tag or "object" (bold -> **)
747  *
748  * @return A string when it has only one token at the beginning (f. ex. lists). An array composed by 2 strings when it has 2 tokens, one at the beginning and one at the end (f. ex. italics). Returns false otherwise.
749  * @author Josep Arús Pous
750  **/
751 function wiki_parser_get_token($markup, $name) {
753     return wiki_parser_proxy::get_token($name, $markup);
756 /**
757  * Checks if current user can view a subwiki
758  *
759  * @param stdClass $subwiki usually record from {wiki_subwikis}. Must contain fields 'wikiid', 'groupid', 'userid'.
760  *     If it also contains fields 'course' and 'groupmode' from table {wiki} it will save extra DB query.
761  * @param stdClass $wiki optional wiki object if known
762  * @return bool
763  */
764 function wiki_user_can_view($subwiki, $wiki = null) {
765     global $USER;
767     if (empty($wiki) || $wiki->id != $subwiki->wikiid) {
768         $wiki = wiki_get_wiki($subwiki->wikiid);
769     }
770     $modinfo = get_fast_modinfo($wiki->course);
771     if (!isset($modinfo->instances['wiki'][$subwiki->wikiid])) {
772         // Module does not exist.
773         return false;
774     }
775     $cm = $modinfo->instances['wiki'][$subwiki->wikiid];
776     if (!$cm->uservisible) {
777         // The whole module is not visible to the current user.
778         return false;
779     }
780     $context = context_module::instance($cm->id);
782     // Working depending on activity groupmode
783     switch (groups_get_activity_groupmode($cm)) {
784     case NOGROUPS:
786         if ($wiki->wikimode == 'collaborative') {
787             // Collaborative Mode:
788             // There is one wiki for all the class.
789             //
790             // Only view capbility needed
791             return has_capability('mod/wiki:viewpage', $context);
792         } else if ($wiki->wikimode == 'individual') {
793             // Individual Mode:
794             // Each person owns a wiki.
795             if ($subwiki->userid == $USER->id) {
796                 // Only the owner of the wiki can view it
797                 return has_capability('mod/wiki:viewpage', $context);
798             } else { // User has special capabilities
799                 // User must have:
800                 //      mod/wiki:viewpage capability
801                 // and
802                 //      mod/wiki:managewiki capability
803                 $view = has_capability('mod/wiki:viewpage', $context);
804                 $manage = has_capability('mod/wiki:managewiki', $context);
806                 return $view && $manage;
807             }
808         } else {
809             //Error
810             return false;
811         }
812     case SEPARATEGROUPS:
813         // Collaborative and Individual Mode
814         //
815         // Collaborative Mode:
816         //      There is one wiki per group.
817         // Individual Mode:
818         //      Each person owns a wiki.
819         if ($wiki->wikimode == 'collaborative' || $wiki->wikimode == 'individual') {
820             // Only members of subwiki group could view that wiki
821             if (in_array($subwiki->groupid, $modinfo->get_groups($cm->groupingid))) {
822                 // Only view capability needed
823                 return has_capability('mod/wiki:viewpage', $context);
825             } else { // User is not part of that group
826                 // User must have:
827                 //      mod/wiki:managewiki capability
828                 // or
829                 //      moodle/site:accessallgroups capability
830                 // and
831                 //      mod/wiki:viewpage capability
832                 $view = has_capability('mod/wiki:viewpage', $context);
833                 $manage = has_capability('mod/wiki:managewiki', $context);
834                 $access = has_capability('moodle/site:accessallgroups', $context);
835                 return ($manage || $access) && $view;
836             }
837         } else {
838             //Error
839             return false;
840         }
841     case VISIBLEGROUPS:
842         // Collaborative and Individual Mode
843         //
844         // Collaborative Mode:
845         //      There is one wiki per group.
846         // Individual Mode:
847         //      Each person owns a wiki.
848         if ($wiki->wikimode == 'collaborative' || $wiki->wikimode == 'individual') {
849             // Everybody can read all wikis
850             //
851             // Only view capability needed
852             return has_capability('mod/wiki:viewpage', $context);
853         } else {
854             //Error
855             return false;
856         }
857     default: // Error
858         return false;
859     }
862 /**
863  * Checks if current user can edit a subwiki
864  *
865  * @param $subwiki
866  */
867 function wiki_user_can_edit($subwiki) {
868     global $USER;
870     $wiki = wiki_get_wiki($subwiki->wikiid);
871     $cm = get_coursemodule_from_instance('wiki', $wiki->id);
872     $context = context_module::instance($cm->id);
874     // Working depending on activity groupmode
875     switch (groups_get_activity_groupmode($cm)) {
876     case NOGROUPS:
878         if ($wiki->wikimode == 'collaborative') {
879             // Collaborative Mode:
880             // There is a wiki for all the class.
881             //
882             // Only edit capbility needed
883             return has_capability('mod/wiki:editpage', $context);
884         } else if ($wiki->wikimode == 'individual') {
885             // Individual Mode
886             // There is a wiki per user
888             // Only the owner of that wiki can edit it
889             if ($subwiki->userid == $USER->id) {
890                 return has_capability('mod/wiki:editpage', $context);
891             } else { // Current user is not the owner of that wiki.
893                 // User must have:
894                 //      mod/wiki:editpage capability
895                 // and
896                 //      mod/wiki:managewiki capability
897                 $edit = has_capability('mod/wiki:editpage', $context);
898                 $manage = has_capability('mod/wiki:managewiki', $context);
900                 return $edit && $manage;
901             }
902         } else {
903             //Error
904             return false;
905         }
906     case SEPARATEGROUPS:
907         if ($wiki->wikimode == 'collaborative') {
908             // Collaborative Mode:
909             // There is one wiki per group.
910             //
911             // Only members of subwiki group could edit that wiki
912             if (groups_is_member($subwiki->groupid)) {
913                 // Only edit capability needed
914                 return has_capability('mod/wiki:editpage', $context);
915             } else { // User is not part of that group
916                 // User must have:
917                 //      mod/wiki:managewiki capability
918                 // and
919                 //      moodle/site:accessallgroups capability
920                 // and
921                 //      mod/wiki:editpage capability
922                 $manage = has_capability('mod/wiki:managewiki', $context);
923                 $access = has_capability('moodle/site:accessallgroups', $context);
924                 $edit = has_capability('mod/wiki:editpage', $context);
925                 return $manage && $access && $edit;
926             }
927         } else if ($wiki->wikimode == 'individual') {
928             // Individual Mode:
929             // Each person owns a wiki.
930             //
931             // Only the owner of that wiki can edit it
932             if ($subwiki->userid == $USER->id) {
933                 return has_capability('mod/wiki:editpage', $context);
934             } else { // Current user is not the owner of that wiki.
935                 // User must have:
936                 //      mod/wiki:managewiki capability
937                 // and
938                 //      moodle/site:accessallgroups capability
939                 // and
940                 //      mod/wiki:editpage capability
941                 $manage = has_capability('mod/wiki:managewiki', $context);
942                 $access = has_capability('moodle/site:accessallgroups', $context);
943                 $edit = has_capability('mod/wiki:editpage', $context);
944                 return $manage && $access && $edit;
945             }
946         } else {
947             //Error
948             return false;
949         }
950     case VISIBLEGROUPS:
951         if ($wiki->wikimode == 'collaborative') {
952             // Collaborative Mode:
953             // There is one wiki per group.
954             //
955             // Only members of subwiki group could edit that wiki
956             if (groups_is_member($subwiki->groupid)) {
957                 // Only edit capability needed
958                 return has_capability('mod/wiki:editpage', $context);
959             } else { // User is not part of that group
960                 // User must have:
961                 //      mod/wiki:managewiki capability
962                 // and
963                 //      mod/wiki:editpage capability
964                 $manage = has_capability('mod/wiki:managewiki', $context);
965                 $edit = has_capability('mod/wiki:editpage', $context);
966                 return $manage && $edit;
967             }
968         } else if ($wiki->wikimode == 'individual') {
969             // Individual Mode:
970             // Each person owns a wiki.
971             //
972             // Only the owner of that wiki can edit it
973             if ($subwiki->userid == $USER->id) {
974                 return has_capability('mod/wiki:editpage', $context);
975             } else { // Current user is not the owner of that wiki.
976                 // User must have:
977                 //      mod/wiki:managewiki capability
978                 // and
979                 //      mod/wiki:editpage capability
980                 $manage = has_capability('mod/wiki:managewiki', $context);
981                 $edit = has_capability('mod/wiki:editpage', $context);
982                 return $manage && $edit;
983             }
984         } else {
985             //Error
986             return false;
987         }
988     default: // Error
989         return false;
990     }
993 //----------------
994 // Locks
995 //----------------
997 /**
998  * Checks if a page-section is locked.
999  *
1000  * @return true if the combination of section and page is locked, FALSE otherwise.
1001  */
1002 function wiki_is_page_section_locked($pageid, $userid, $section = null) {
1003     global $DB;
1005     $sql = "pageid = ? AND lockedat > ? AND userid != ?";
1006     $params = array($pageid, time(), $userid);
1008     if (!empty($section)) {
1009         $sql .= " AND (sectionname = ? OR sectionname IS null)";
1010         $params[] = $section;
1011     }
1013     return $DB->record_exists_select('wiki_locks', $sql, $params);
1016 /**
1017  * Inserts or updates a wiki_locks record.
1018  */
1019 function wiki_set_lock($pageid, $userid, $section = null, $insert = false) {
1020     global $DB;
1022     if (wiki_is_page_section_locked($pageid, $userid, $section)) {
1023         return false;
1024     }
1026     $params = array('pageid' => $pageid, 'userid' => $userid, 'sectionname' => $section);
1028     $lock = $DB->get_record('wiki_locks', $params);
1030     if (!empty($lock)) {
1031         $DB->update_record('wiki_locks', array('id' => $lock->id, 'lockedat' => time() + LOCK_TIMEOUT));
1032     } else if ($insert) {
1033         $DB->insert_record('wiki_locks',
1034             array('pageid' => $pageid, 'sectionname' => $section, 'userid' => $userid, 'lockedat' => time() + LOCK_TIMEOUT));
1035     }
1037     return true;
1040 /**
1041  * Deletes wiki_locks that are not in use. (F.Ex. after submitting the changes). If no userid is present, it deletes ALL the wiki_locks of a specific page.
1042  *
1043  * @param int $pageid page id.
1044  * @param int $userid id of user for which lock is deleted.
1045  * @param string $section section to be deleted.
1046  * @param bool $delete_from_db deleted from db.
1047  * @param bool $delete_section_and_page delete section and page version.
1048  */
1049 function wiki_delete_locks($pageid, $userid = null, $section = null, $delete_from_db = true, $delete_section_and_page = false) {
1050     global $DB;
1052     $wiki = wiki_get_wiki_from_pageid($pageid);
1053     $cm = get_coursemodule_from_instance('wiki', $wiki->id);
1054     $context = context_module::instance($cm->id);
1056     $params = array('pageid' => $pageid);
1058     if (!empty($userid)) {
1059         $params['userid'] = $userid;
1060     }
1062     if (!empty($section)) {
1063         $params['sectionname'] = $section;
1064     }
1066     if ($delete_from_db) {
1067         $DB->delete_records('wiki_locks', $params);
1068         if ($delete_section_and_page && !empty($section)) {
1069             $params['sectionname'] = null;
1070             $DB->delete_records('wiki_locks', $params);
1071         }
1072         $event = \mod_wiki\event\page_locks_deleted::create(
1073         array(
1074             'context' => $context,
1075             'objectid' => $pageid,
1076             'relateduserid' => $userid,
1077             'other' => array(
1078                 'section' => $section
1079                 )
1080             ));
1081         // No need to add snapshot, as important data is section, userid and pageid, which is part of event.
1082         $event->trigger();
1083     } else {
1084         $DB->set_field('wiki_locks', 'lockedat', time(), $params);
1085     }
1088 /**
1089  * Deletes wiki_locks that expired 1 hour ago.
1090  */
1091 function wiki_delete_old_locks() {
1092     global $DB;
1094     $DB->delete_records_select('wiki_locks', "lockedat < ?", array(time() - 3600));
1097 /**
1098  * Deletes wiki_links. It can be sepecific link or links attached in subwiki
1099  *
1100  * @global mixed $DB database object
1101  * @param int $linkid id of the link to be deleted
1102  * @param int $topageid links to the specific page
1103  * @param int $frompageid links from specific page
1104  * @param int $subwikiid links to subwiki
1105  */
1106 function wiki_delete_links($linkid = null, $topageid = null, $frompageid = null, $subwikiid = null) {
1107     global $DB;
1108     $params = array();
1110     // if link id is givien then don't check for anything else
1111     if (!empty($linkid)) {
1112         $params['id'] = $linkid;
1113     } else {
1114         if (!empty($topageid)) {
1115             $params['topageid'] = $topageid;
1116         }
1117         if (!empty($frompageid)) {
1118             $params['frompageid'] = $frompageid;
1119         }
1120         if (!empty($subwikiid)) {
1121             $params['subwikiid'] = $subwikiid;
1122         }
1123     }
1125     //Delete links if any params are passed, else nothing to delete.
1126     if (!empty($params)) {
1127         $DB->delete_records('wiki_links', $params);
1128     }
1131 /**
1132  * Delete wiki synonyms related to subwikiid or page
1133  *
1134  * @param int $subwikiid id of sunbwiki
1135  * @param int $pageid id of page
1136  */
1137 function wiki_delete_synonym($subwikiid, $pageid = null) {
1138     global $DB;
1140     $params = array('subwikiid' => $subwikiid);
1141     if (!is_null($pageid)) {
1142         $params['pageid'] = $pageid;
1143     }
1144     $DB->delete_records('wiki_synonyms', $params, IGNORE_MISSING);
1147 /**
1148  * Delete pages and all related data
1149  *
1150  * @param mixed $context context in which page needs to be deleted.
1151  * @param mixed $pageids id's of pages to be deleted
1152  * @param int $subwikiid id of the subwiki for which all pages should be deleted
1153  */
1154 function wiki_delete_pages($context, $pageids = null, $subwikiid = null) {
1155     global $DB, $CFG;
1157     if (!empty($pageids) && is_int($pageids)) {
1158        $pageids = array($pageids);
1159     } else if (!empty($subwikiid)) {
1160         $pageids = wiki_get_page_list($subwikiid);
1161     }
1163     //If there is no pageid then return as we can't delete anything.
1164     if (empty($pageids)) {
1165         return;
1166     }
1168     /// Delete page and all it's relevent data
1169     foreach ($pageids as $pageid) {
1170         if (is_object($pageid)) {
1171             $pageid = $pageid->id;
1172         }
1174         //Delete page comments
1175         $comments = wiki_get_comments($context->id, $pageid);
1176         foreach ($comments as $commentid => $commentvalue) {
1177             wiki_delete_comment($commentid, $context, $pageid);
1178         }
1180         //Delete page tags
1181         core_tag_tag::remove_all_item_tags('mod_wiki', 'wiki_pages', $pageid);
1183         //Delete Synonym
1184         wiki_delete_synonym($subwikiid, $pageid);
1186         //Delete all page versions
1187         wiki_delete_page_versions(array($pageid=>array(0)), $context);
1189         //Delete all page locks
1190         wiki_delete_locks($pageid);
1192         //Delete all page links
1193         wiki_delete_links(null, $pageid);
1195         $params = array('id' => $pageid);
1197         // Get page before deleting.
1198         $page = $DB->get_record('wiki_pages', $params);
1200         //Delete page
1201         $DB->delete_records('wiki_pages', $params);
1203         // Trigger page_deleted event.
1204         $event = \mod_wiki\event\page_deleted::create(
1205                 array(
1206                     'context' => $context,
1207                     'objectid' => $pageid,
1208                     'other' => array('subwikiid' => $subwikiid)
1209                     ));
1210         $event->add_record_snapshot('wiki_pages', $page);
1211         $event->trigger();
1212     }
1215 /**
1216  * Delete specificed versions of a page or versions created by users
1217  * if version is 0 then it will remove all versions of the page
1218  *
1219  * @param array $deleteversions delete versions for a page
1220  * @param context_module $context module context
1221  */
1222 function wiki_delete_page_versions($deleteversions, $context = null) {
1223     global $DB;
1225     /// delete page-versions
1226     foreach ($deleteversions as $id => $versions) {
1227         $params = array('pageid' => $id);
1228         if (is_null($context)) {
1229             $wiki = wiki_get_wiki_from_pageid($id);
1230             $cm = get_coursemodule_from_instance('wiki', $wiki->id);
1231             $context = context_module::instance($cm->id);
1232         }
1233         // Delete all versions, if version specified is 0.
1234         if (in_array(0, $versions)) {
1235             $oldversions = $DB->get_records('wiki_versions', $params);
1236             $DB->delete_records('wiki_versions', $params, IGNORE_MISSING);
1237         } else {
1238             list($insql, $param) = $DB->get_in_or_equal($versions);
1239             $insql .= ' AND pageid = ?';
1240             array_push($param, $params['pageid']);
1241             $oldversions = $DB->get_recordset_select('wiki_versions', 'version ' . $insql, $param);
1242             $DB->delete_records_select('wiki_versions', 'version ' . $insql, $param);
1243         }
1244         foreach ($oldversions as $version) {
1245             // Trigger page version deleted event.
1246             $event = \mod_wiki\event\page_version_deleted::create(
1247                     array(
1248                         'context' => $context,
1249                         'objectid' => $version->id,
1250                         'other' => array(
1251                             'pageid' => $id
1252                         )
1253                     ));
1254             $event->add_record_snapshot('wiki_versions', $version);
1255             $event->trigger();
1256         }
1257     }
1260 function wiki_get_comment($commentid){
1261     global $DB;
1262     return $DB->get_record('comments', array('id' => $commentid));
1265 /**
1266  * Returns all comments by context and pageid
1267  *
1268  * @param int $contextid Current context id
1269  * @param int $pageid Current pageid
1270  **/
1271 function wiki_get_comments($contextid, $pageid) {
1272     global $DB;
1274     return $DB->get_records('comments', array('contextid' => $contextid, 'itemid' => $pageid, 'commentarea' => 'wiki_page'), 'timecreated ASC');
1277 /**
1278  * Add comments ro database
1279  *
1280  * @param object $context. Current context
1281  * @param int $pageid. Current pageid
1282  * @param string $content. Content of the comment
1283  * @param string editor. Version of editor we are using.
1284  **/
1285 function wiki_add_comment($context, $pageid, $content, $editor) {
1286     global $CFG;
1287     require_once($CFG->dirroot . '/comment/lib.php');
1289     list($context, $course, $cm) = get_context_info_array($context->id);
1290     $cmt = new stdclass();
1291     $cmt->context = $context;
1292     $cmt->itemid = $pageid;
1293     $cmt->area = 'wiki_page';
1294     $cmt->course = $course;
1295     $cmt->component = 'mod_wiki';
1297     $manager = new comment($cmt);
1299     if ($editor == 'creole') {
1300         $manager->add($content, FORMAT_CREOLE);
1301     } else if ($editor == 'html') {
1302         $manager->add($content, FORMAT_HTML);
1303     } else if ($editor == 'nwiki') {
1304         $manager->add($content, FORMAT_NWIKI);
1305     }
1309 /**
1310  * Delete comments from database
1311  *
1312  * @param $idcomment. Id of comment which will be deleted
1313  * @param $context. Current context
1314  * @param $pageid. Current pageid
1315  **/
1316 function wiki_delete_comment($idcomment, $context, $pageid) {
1317     global $CFG;
1318     require_once($CFG->dirroot . '/comment/lib.php');
1320     list($context, $course, $cm) = get_context_info_array($context->id);
1321     $cmt = new stdClass();
1322     $cmt->context = $context;
1323     $cmt->itemid = $pageid;
1324     $cmt->area = 'wiki_page';
1325     $cmt->course = $course;
1326     $cmt->component = 'mod_wiki';
1328     $manager = new comment($cmt);
1329     $manager->delete($idcomment);
1333 /**
1334  * Delete al comments from wiki
1335  *
1336  **/
1337 function wiki_delete_comments_wiki() {
1338     global $PAGE, $DB;
1340     $cm = $PAGE->cm;
1341     $context = context_module::instance($cm->id);
1343     $table = 'comments';
1344     $select = 'contextid = ?';
1346     $DB->delete_records_select($table, $select, array($context->id));
1350 function wiki_add_progress($pageid, $oldversionid, $versionid, $progress) {
1351     global $DB;
1352     for ($v = $oldversionid + 1; $v <= $versionid; $v++) {
1353         $user = wiki_get_wiki_page_id($pageid, $v);
1355         $DB->insert_record('wiki_progress', array('userid' => $user->userid, 'pageid' => $pageid, 'versionid' => $v, 'progress' => $progress));
1356     }
1359 function wiki_get_wiki_page_id($pageid, $id) {
1360     global $DB;
1361     return $DB->get_record('wiki_versions', array('pageid' => $pageid, 'id' => $id));
1364 function wiki_print_page_content($page, $context, $subwikiid) {
1365     global $OUTPUT, $CFG;
1367     if ($page->timerendered + WIKI_REFRESH_CACHE_TIME < time()) {
1368         $content = wiki_refresh_cachedcontent($page);
1369         $page = $content['page'];
1370     }
1372     if (isset($content)) {
1373         $box = '';
1374         foreach ($content['sections'] as $s) {
1375             $box .= '<p>' . get_string('repeatedsection', 'wiki', $s) . '</p>';
1376         }
1378         if (!empty($box)) {
1379             echo $OUTPUT->box($box);
1380         }
1381     }
1382     $html = file_rewrite_pluginfile_urls($page->cachedcontent, 'pluginfile.php', $context->id, 'mod_wiki', 'attachments', $subwikiid);
1383     $html = format_text($html, FORMAT_MOODLE, array('overflowdiv'=>true, 'allowid'=>true));
1384     echo $OUTPUT->box($html);
1386     echo $OUTPUT->tag_list(core_tag_tag::get_item_tags('mod_wiki', 'wiki_pages', $page->id),
1387             null, 'wiki-tags');
1389     wiki_increment_pageviews($page);
1392 /**
1393  * This function trims any given text and returns it with some dots at the end
1394  *
1395  * @param string $text
1396  * @param string $limit
1397  *
1398  * @return string
1399  */
1400 function wiki_trim_string($text, $limit = 25) {
1402     if (core_text::strlen($text) > $limit) {
1403         $text = core_text::substr($text, 0, $limit) . '...';
1404     }
1406     return $text;
1409 /**
1410  * Prints default edit form fields and buttons
1411  *
1412  * @param string $format Edit form format (html, creole...)
1413  * @param integer $version Version number. A negative number means no versioning.
1414  */
1416 function wiki_print_edit_form_default_fields($format, $pageid, $version = -1, $upload = false, $deleteuploads = array()) {
1417     global $CFG, $PAGE, $OUTPUT;
1419     echo '<input type="hidden" name="sesskey" value="' . sesskey() . '" />';
1421     if ($version >= 0) {
1422         echo '<input type="hidden" name="version" value="' . $version . '" />';
1423     }
1425     echo '<input type="hidden" name="format" value="' . $format . '"/>';
1427     //attachments
1428     require_once($CFG->dirroot . '/lib/form/filemanager.php');
1430     $filemanager = new MoodleQuickForm_filemanager('attachments', get_string('wikiattachments', 'wiki'), array('id' => 'attachments'), array('subdirs' => false, 'maxfiles' => 99, 'maxbytes' => $CFG->maxbytes));
1432     $value = file_get_submitted_draft_itemid('attachments');
1433     if (!empty($value) && !$upload) {
1434         $filemanager->setValue($value);
1435     }
1437     echo "<fieldset class=\"wiki-upload-section clearfix\"><legend class=\"ftoggler\">" . get_string("uploadtitle", 'wiki') . "</legend>";
1439     echo $OUTPUT->container_start('mdl-align wiki-form-center aaaaa');
1440     print $filemanager->toHtml();
1441     echo $OUTPUT->container_end();
1443     $cm = $PAGE->cm;
1444     $context = context_module::instance($cm->id);
1446     echo $OUTPUT->container_start('mdl-align wiki-form-center wiki-upload-table');
1447     wiki_print_upload_table($context, 'wiki_upload', $pageid, $deleteuploads);
1448     echo $OUTPUT->container_end();
1450     echo "</fieldset>";
1452     echo '<input class="wiki_button" type="submit" name="editoption" value="' . get_string('save', 'wiki') . '"/>';
1453     echo '<input class="wiki_button" type="submit" name="editoption" value="' . get_string('upload', 'wiki') . '"/>';
1454     echo '<input class="wiki_button" type="submit" name="editoption" value="' . get_string('preview') . '"/>';
1455     echo '<input class="wiki_button" type="submit" name="editoption" value="' . get_string('cancel') . '" />';
1458 /**
1459  * Prints a table with the files attached to a wiki page
1460  * @param object $context
1461  * @param string $filearea
1462  * @param int $fileitemid
1463  * @param array deleteuploads
1464  */
1465 function wiki_print_upload_table($context, $filearea, $fileitemid, $deleteuploads = array()) {
1466     global $CFG, $OUTPUT;
1468     $htmltable = new html_table();
1470     $htmltable->head = array(get_string('deleteupload', 'wiki'), get_string('uploadname', 'wiki'), get_string('uploadactions', 'wiki'));
1472     $fs = get_file_storage();
1473     $files = $fs->get_area_files($context->id, 'mod_wiki', $filearea, $fileitemid); //TODO: this is weird (skodak)
1475     foreach ($files as $file) {
1476         if (!$file->is_directory()) {
1477             $checkbox = '<input type="checkbox" name="deleteupload[]", value="' . $file->get_pathnamehash() . '"';
1479             if (in_array($file->get_pathnamehash(), $deleteuploads)) {
1480                 $checkbox .= ' checked="checked"';
1481             }
1483             $checkbox .= " />";
1485             $htmltable->data[] = array($checkbox, '<a href="' . file_encode_url($CFG->wwwroot . '/pluginfile.php', '/' . $context->id . '/wiki_upload/' . $fileitemid . '/' . $file->get_filename()) . '">' . $file->get_filename() . '</a>', "");
1486         }
1487     }
1489     print '<h3 class="upload-table-title">' . get_string('uploadfiletitle', 'wiki') . "</h3>";
1490     print html_writer::table($htmltable);
1493 /**
1494  * Generate wiki's page tree
1495  *
1496  * @param page_wiki $page. A wiki page object
1497  * @param navigation_node $node. Starting navigation_node
1498  * @param array $keys. An array to store keys
1499  * @return an array with all tree nodes
1500  */
1501 function wiki_build_tree($page, $node, &$keys) {
1502     $content = array();
1503     static $icon = null;
1504     if ($icon === null) {
1505         // Substitute the default navigation icon with empty image.
1506         $icon = new pix_icon('spacer', '');
1507     }
1508     $pages = wiki_get_linked_pages($page->id);
1509     foreach ($pages as $p) {
1510         $key = $page->id . ':' . $p->id;
1511         if (in_array($key, $keys)) {
1512             break;
1513         }
1514         array_push($keys, $key);
1515         $l = wiki_parser_link($p);
1516         $link = new moodle_url('/mod/wiki/view.php', array('pageid' => $p->id));
1517         // navigation_node::get_content will format the title for us
1518         $nodeaux = $node->add($p->title, $link, null, null, null, $icon);
1519         if ($l['new']) {
1520             $nodeaux->add_class('wiki_newentry');
1521         }
1522         wiki_build_tree($p, $nodeaux, $keys);
1523     }
1524     $content[] = $node;
1525     return $content;
1528 /**
1529  * Get linked pages from page
1530  * @param int $pageid
1531  */
1532 function wiki_get_linked_pages($pageid) {
1533     global $DB;
1535     $sql = "SELECT p.id, p.title
1536             FROM {wiki_pages} p
1537             JOIN {wiki_links} l ON l.topageid = p.id
1538             WHERE l.frompageid = ?
1539             ORDER BY p.title ASC";
1540     return $DB->get_records_sql($sql, array($pageid));
1543 /**
1544  * Get updated pages from wiki
1545  * @param int $pageid
1546  */
1547 function wiki_get_updated_pages_by_subwiki($swid) {
1548     global $DB, $USER;
1550     $sql = "SELECT *
1551             FROM {wiki_pages}
1552             WHERE subwikiid = ? AND timemodified > ?
1553             ORDER BY timemodified DESC";
1554     return $DB->get_records_sql($sql, array($swid, $USER->lastlogin));
1557 /**
1558  * Check if the user can create pages in a certain wiki.
1559  * @param context $context Wiki's context.
1560  * @param integer|stdClass $user A user id or object. By default (null) checks the permissions of the current user.
1561  * @return bool True if user can create pages, false otherwise.
1562  * @since Moodle 3.1
1563  */
1564 function wiki_can_create_pages($context, $user = null) {
1565     return has_capability('mod/wiki:createpage', $context, $user);
1568 /**
1569  * Get a sub wiki instance by wiki id, group id and user id.
1570  * If the wiki doesn't exist in DB it will return an isntance with id -1.
1571  *
1572  * @param int $wikiid  Wiki ID.
1573  * @param int $groupid Group ID.
1574  * @param int $userid  User ID.
1575  * @return object      Subwiki instance.
1576  * @since Moodle 3.1
1577  */
1578 function wiki_get_possible_subwiki_by_group($wikiid, $groupid, $userid = 0) {
1579     if (!$subwiki = wiki_get_subwiki_by_group($wikiid, $groupid, $userid)) {
1580         $subwiki = new stdClass();
1581         $subwiki->id = -1;
1582         $subwiki->wikiid = $wikiid;
1583         $subwiki->groupid = $groupid;
1584         $subwiki->userid = $userid;
1585     }
1586     return $subwiki;
1589 /**
1590  * Get all the possible subwikis visible to the user in a wiki.
1591  * It will return all the subwikis that can be created in a wiki, even if they don't exist in DB yet.
1592  *
1593  * @param  stdClass $wiki          Wiki to get the subwikis from.
1594  * @param  cm_info|stdClass $cm    Optional. The course module object.
1595  * @param  context_module $context Optional. Context of wiki module.
1596  * @return array                   List of subwikis.
1597  * @since Moodle 3.1
1598  */
1599 function wiki_get_visible_subwikis($wiki, $cm = null, $context = null) {
1600     global $USER;
1602     $subwikis = array();
1604     if (empty($wiki) or !is_object($wiki)) {
1605         // Wiki not valid.
1606         return $subwikis;
1607     }
1609     if (empty($cm)) {
1610         $cm = get_coursemodule_from_instance('wiki', $wiki->id);
1611     }
1612     if (empty($context)) {
1613         $context = context_module::instance($cm->id);
1614     }
1616     if (!has_capability('mod/wiki:viewpage', $context)) {
1617         return $subwikis;
1618     }
1620     $manage = has_capability('mod/wiki:managewiki', $context);
1622     if (!$groupmode = groups_get_activity_groupmode($cm)) {
1623         // No groups.
1624         if ($wiki->wikimode == 'collaborative') {
1625             // Only 1 subwiki.
1626             $subwikis[] = wiki_get_possible_subwiki_by_group($wiki->id, 0, 0);
1627         } else if ($wiki->wikimode == 'individual') {
1628             // There's 1 subwiki per user.
1629             if ($manage) {
1630                 // User can view all subwikis.
1631                 $users = get_enrolled_users($context);
1632                 foreach ($users as $user) {
1633                     $subwikis[] = wiki_get_possible_subwiki_by_group($wiki->id, 0, $user->id);
1634                 }
1635             } else {
1636                 // User can only see his subwiki.
1637                 $subwikis[] = wiki_get_possible_subwiki_by_group($wiki->id, 0, $USER->id);
1638             }
1639         }
1640     } else {
1641         if ($wiki->wikimode == 'collaborative') {
1642             // 1 subwiki per group.
1643             $aag = has_capability('moodle/site:accessallgroups', $context);
1644             if ($aag || $groupmode == VISIBLEGROUPS) {
1645                 // User can see all groups.
1646                 $allowedgroups = groups_get_all_groups($cm->course, 0, $cm->groupingid);
1647                 $allparticipants = new stdClass();
1648                 $allparticipants->id = 0;
1649                 array_unshift($allowedgroups, $allparticipants); // Add all participants.
1650             } else {
1651                 // User can only see the groups he belongs to.
1652                 $allowedgroups = groups_get_all_groups($cm->course, $USER->id, $cm->groupingid);
1653             }
1655             foreach ($allowedgroups as $group) {
1656                 $subwikis[] = wiki_get_possible_subwiki_by_group($wiki->id, $group->id, 0);
1657             }
1658         } else if ($wiki->wikimode == 'individual') {
1659             // 1 subwiki per user and group.
1661             if ($manage || $groupmode == VISIBLEGROUPS) {
1662                 // User can view all subwikis.
1663                 $users = get_enrolled_users($context);
1664                 foreach ($users as $user) {
1665                     // Get all the groups this user belongs to.
1666                     $groups = groups_get_all_groups($cm->course, $user->id);
1667                     if (!empty($groups)) {
1668                         foreach ($groups as $group) {
1669                             $subwikis[] = wiki_get_possible_subwiki_by_group($wiki->id, $group->id, $user->id);
1670                         }
1671                     } else {
1672                         // User doesn't belong to any group, add it to group 0.
1673                         $subwikis[] = wiki_get_possible_subwiki_by_group($wiki->id, 0, $user->id);
1674                     }
1675                 }
1676             } else {
1677                 // The user can only see the subwikis of the groups he belongs.
1678                 $allowedgroups = groups_get_all_groups($cm->course, $USER->id, $cm->groupingid);
1679                 foreach ($allowedgroups as $group) {
1680                     $users = groups_get_members($group->id);
1681                     foreach ($users as $user) {
1682                         $subwikis[] = wiki_get_possible_subwiki_by_group($wiki->id, $group->id, $user->id);
1683                     }
1684                 }
1685             }
1686         }
1687     }
1689     return $subwikis;
1692 /**
1693  * Utility function for getting a subwiki by group and user, validating that the user can view it.
1694  * If the subwiki doesn't exists in DB yet it'll have id -1.
1695  *
1696  * @param stdClass $wiki The wiki.
1697  * @param int $groupid Group ID. 0 means the subwiki doesn't use groups.
1698  * @param int $userid User ID. 0 means the subwiki doesn't use users.
1699  * @return stdClass Subwiki. If it doesn't exists in DB yet it'll have id -1. If the user can't view the
1700  *                  subwiki this function will return false.
1701  * @since  Moodle 3.1
1702  * @throws moodle_exception
1703  */
1704 function wiki_get_subwiki_by_group_and_user_with_validation($wiki, $groupid, $userid) {
1705     global $USER, $DB;
1707     // Get subwiki based on group and user.
1708     if (!$subwiki = wiki_get_subwiki_by_group($wiki->id, $groupid, $userid)) {
1710         // The subwiki doesn't exist.
1711         // Validate if user is valid.
1712         if ($userid != 0) {
1713             $user = core_user::get_user($userid, '*', MUST_EXIST);
1714             core_user::require_active_user($user);
1715         }
1717         // Validate that groupid is valid.
1718         if ($groupid != 0 && !groups_group_exists($groupid)) {
1719             throw new moodle_exception('cannotfindgroup', 'error');
1720         }
1722         // Valid data but subwiki not found. We'll simulate a subwiki object to check if the user would be able to see it
1723         // if it existed. If he's able to see it then we'll return an empty array because the subwiki has no pages.
1724         $subwiki = new stdClass();
1725         $subwiki->id = -1;
1726         $subwiki->wikiid = $wiki->id;
1727         $subwiki->userid = $userid;
1728         $subwiki->groupid = $groupid;
1729     }
1731     // Check that the user can view the subwiki. This function checks capabilities.
1732     if (!wiki_user_can_view($subwiki, $wiki)) {
1733         return false;
1734     }
1736     return $subwiki;
1739 /**
1740  * Returns wiki pages tagged with a specified tag.
1741  *
1742  * This is a callback used by the tag area mod_wiki/wiki_pages to search for wiki pages
1743  * tagged with a specific tag.
1744  *
1745  * @param core_tag_tag $tag
1746  * @param bool $exclusivemode if set to true it means that no other entities tagged with this tag
1747  *             are displayed on the page and the per-page limit may be bigger
1748  * @param int $fromctx context id where the link was displayed, may be used by callbacks
1749  *            to display items in the same context first
1750  * @param int $ctx context id where to search for records
1751  * @param bool $rec search in subcontexts as well
1752  * @param int $page 0-based number of page being displayed
1753  * @return \core_tag\output\tagindex
1754  */
1755 function mod_wiki_get_tagged_pages($tag, $exclusivemode = false, $fromctx = 0, $ctx = 0, $rec = 1, $page = 0) {
1756     global $OUTPUT;
1757     $perpage = $exclusivemode ? 20 : 5;
1759     // Build the SQL query.
1760     $ctxselect = context_helper::get_preload_record_columns_sql('ctx');
1761     $query = "SELECT wp.id, wp.title, ws.userid, ws.wikiid, ws.id AS subwikiid, ws.groupid, w.wikimode,
1762                     cm.id AS cmid, c.id AS courseid, c.shortname, c.fullname, $ctxselect
1763                 FROM {wiki_pages} wp
1764                 JOIN {wiki_subwikis} ws ON wp.subwikiid = ws.id
1765                 JOIN {wiki} w ON w.id = ws.wikiid
1766                 JOIN {modules} m ON m.name='wiki'
1767                 JOIN {course_modules} cm ON cm.module = m.id AND cm.instance = w.id
1768                 JOIN {tag_instance} tt ON wp.id = tt.itemid
1769                 JOIN {course} c ON cm.course = c.id
1770                 JOIN {context} ctx ON ctx.instanceid = cm.id AND ctx.contextlevel = :coursemodulecontextlevel
1771                WHERE tt.itemtype = :itemtype AND tt.tagid = :tagid AND tt.component = :component
1772                  AND wp.id %ITEMFILTER% AND c.id %COURSEFILTER%";
1774     $params = array('itemtype' => 'wiki_pages', 'tagid' => $tag->id, 'component' => 'mod_wiki',
1775         'coursemodulecontextlevel' => CONTEXT_MODULE);
1777     if ($ctx) {
1778         $context = $ctx ? context::instance_by_id($ctx) : context_system::instance();
1779         $query .= $rec ? ' AND (ctx.id = :contextid OR ctx.path LIKE :path)' : ' AND ctx.id = :contextid';
1780         $params['contextid'] = $context->id;
1781         $params['path'] = $context->path.'/%';
1782     }
1784     $query .= " ORDER BY ";
1785     if ($fromctx) {
1786         // In order-clause specify that modules from inside "fromctx" context should be returned first.
1787         $fromcontext = context::instance_by_id($fromctx);
1788         $query .= ' (CASE WHEN ctx.id = :fromcontextid OR ctx.path LIKE :frompath THEN 0 ELSE 1 END),';
1789         $params['fromcontextid'] = $fromcontext->id;
1790         $params['frompath'] = $fromcontext->path.'/%';
1791     }
1792     $query .= ' c.sortorder, cm.id, wp.id';
1794     $totalpages = $page + 1;
1796     // Use core_tag_index_builder to build and filter the list of items.
1797     $builder = new core_tag_index_builder('mod_wiki', 'wiki_pages', $query, $params, $page * $perpage, $perpage + 1);
1798     while ($item = $builder->has_item_that_needs_access_check()) {
1799         context_helper::preload_from_record($item);
1800         $courseid = $item->courseid;
1801         if (!$builder->can_access_course($courseid)) {
1802             $builder->set_accessible($item, false);
1803             continue;
1804         }
1805         $modinfo = get_fast_modinfo($builder->get_course($courseid));
1806         // Set accessibility of this item and all other items in the same course.
1807         $builder->walk(function ($taggeditem) use ($courseid, $modinfo, $builder) {
1808             if ($taggeditem->courseid == $courseid) {
1809                 $accessible = false;
1810                 if (($cm = $modinfo->get_cm($taggeditem->cmid)) && $cm->uservisible) {
1811                     $subwiki = (object)array('id' => $taggeditem->subwikiid, 'groupid' => $taggeditem->groupid,
1812                         'userid' => $taggeditem->userid, 'wikiid' => $taggeditem->wikiid);
1813                     $wiki = (object)array('id' => $taggeditem->wikiid, 'wikimode' => $taggeditem->wikimode,
1814                         'course' => $cm->course);
1815                     $accessible = wiki_user_can_view($subwiki, $wiki);
1816                 }
1817                 $builder->set_accessible($taggeditem, $accessible);
1818             }
1819         });
1820     }
1822     $items = $builder->get_items();
1823     if (count($items) > $perpage) {
1824         $totalpages = $page + 2; // We don't need exact page count, just indicate that the next page exists.
1825         array_pop($items);
1826     }
1828     // Build the display contents.
1829     if ($items) {
1830         $tagfeed = new core_tag\output\tagfeed();
1831         foreach ($items as $item) {
1832             context_helper::preload_from_record($item);
1833             $modinfo = get_fast_modinfo($item->courseid);
1834             $cm = $modinfo->get_cm($item->cmid);
1835             $pageurl = new moodle_url('/mod/wiki/view.php', array('pageid' => $item->id));
1836             $pagename = format_string($item->title, true, array('context' => context_module::instance($item->cmid)));
1837             $pagename = html_writer::link($pageurl, $pagename);
1838             $courseurl = course_get_url($item->courseid, $cm->sectionnum);
1839             $cmname = html_writer::link($cm->url, $cm->get_formatted_name());
1840             $coursename = format_string($item->fullname, true, array('context' => context_course::instance($item->courseid)));
1841             $coursename = html_writer::link($courseurl, $coursename);
1842             $icon = html_writer::link($pageurl, html_writer::empty_tag('img', array('src' => $cm->get_icon_url())));
1843             $tagfeed->add($icon, $pagename, $cmname.'<br>'.$coursename);
1844         }
1846         $content = $OUTPUT->render_from_template('core_tag/tagfeed',
1847                 $tagfeed->export_for_template($OUTPUT));
1849         return new core_tag\output\tagindex($tag, 'mod_wiki', 'wiki_pages', $content,
1850                 $exclusivemode, $fromctx, $ctx, $rec, $page, $totalpages);
1851     }