Merged branch 's9_MDL-26392_wiki_files_master' from git://github.com/dongsheng/moodle...
[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-2.0
22  * @copyrigth 2009 Marc Alier, Jordi Piguillem marc.alier@upc.edu
23  * @copyrigth 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     return array_pop($DB->get_records_sql($sql, array($pageid), 0, 1));
152 /**
153  * Alias of wiki_get_current_version
154  * @TODO, does the exactly same thing as wiki_get_current_version, should be removed
155  * @param int $pageid
156  * @return object
157  */
158 function wiki_get_last_version($pageid) {
159     return wiki_get_current_version($pageid);
162 /**
163  * Get page section
164  * @param int $pageid
165  * @param string $section
166  */
167 function wiki_get_section_page($page, $section) {
169     $version = wiki_get_current_version($page->id);
170     return wiki_parser_proxy::get_section($version->content, $version->contentformat, $section);
173 /**
174  * Get a wiki page by page title
175  * @param int $swid, sub wiki id
176  * @param string $title
177  * @return object
178  */
179 function wiki_get_page_by_title($swid, $title) {
180     global $DB;
181     return $DB->get_record('wiki_pages', array('subwikiid' => $swid, 'title' => $title));
184 /**
185  * Get a version record by record id
186  * @param int $versionid, the version id
187  * @return object
188  */
189 function wiki_get_version($versionid) {
190     global $DB;
191     return $DB->get_record('wiki_versions', array('id' => $versionid));
194 /**
195  * Get first page of wiki instace
196  * @param int $subwikiid
197  * @param int $module, wiki instance object
198  */
199 function wiki_get_first_page($subwikid, $module = null) {
200     global $DB, $USER;
202     $sql = "SELECT p.*
203             FROM {wiki} w, {wiki_subwikis} s, {wiki_pages} p
204             WHERE s.id = ? AND
205             s.wikiid = w.id AND
206             w.firstpagetitle = p.title AND
207             p.subwikiid = s.id";
208     return $DB->get_record_sql($sql, array($subwikid));
211 function wiki_save_section($wikipage, $sectiontitle, $sectioncontent, $userid) {
213     $wiki = wiki_get_wiki_from_pageid($wikipage->id);
214     $cm = get_coursemodule_from_instance('wiki', $wiki->id);
215     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
217     if (has_capability('mod/wiki:editpage', $context)) {
218         $version = wiki_get_current_version($wikipage->id);
219         $content = wiki_parser_proxy::get_section($version->content, $version->contentformat, $sectiontitle, true);
221         $newcontent = $content[0] . $sectioncontent . $content[2];
223         return wiki_save_page($wikipage, $newcontent, $userid);
224     } else {
225         return false;
226     }
229 /**
230  * Save page content
231  * @param object $wikipage
232  * @param string $newcontent
233  * @param int $userid
234  */
235 function wiki_save_page($wikipage, $newcontent, $userid) {
236     global $DB;
238     $wiki = wiki_get_wiki_from_pageid($wikipage->id);
239     $cm = get_coursemodule_from_instance('wiki', $wiki->id);
240     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
242     if (has_capability('mod/wiki:editpage', $context)) {
243         $version = wiki_get_current_version($wikipage->id);
245         $version->content = $newcontent;
246         $version->userid = $userid;
247         $version->version++;
248         $version->timecreated = time();
249         $versionid = $DB->insert_record('wiki_versions', $version);
251         $wikipage->timemodified = $version->timecreated;
252         $wikipage->userid = $userid;
253         $return = wiki_refresh_cachedcontent($wikipage, $newcontent);
255         return $return;
256     } else {
257         return false;
258     }
261 function wiki_refresh_cachedcontent($page, $newcontent = null) {
262     global $DB;
264     $version = wiki_get_current_version($page->id);
265     if (empty($version)) {
266         return null;
267     }
268     if (!isset($newcontent)) {
269         $newcontent = $version->content;
270     }
272     $options = array('swid' => $page->subwikiid, 'pageid' => $page->id);
273     $parseroutput = wiki_parse_content($version->contentformat, $newcontent, $options);
274     $page->cachedcontent = $parseroutput['toc'] . $parseroutput['parsed_text'];
275     $page->timerendered = time();
276     $DB->update_record('wiki_pages', $page);
278     wiki_refresh_page_links($page, $parseroutput['link_count']);
280     return array('page' => $page, 'sections' => $parseroutput['repeated_sections'], 'version' => $version->version);
282 /**
283  * Restore a page
284  */
285 function wiki_restore_page($wikipage, $newcontent, $userid) {
286     $return = wiki_save_page($wikipage, $newcontent, $userid);
287     return $return['page'];
290 function wiki_refresh_page_links($page, $links) {
291     global $DB;
293     $DB->delete_records('wiki_links', array('frompageid' => $page->id));
294     foreach ($links as $linkname => $linkinfo) {
296         $newlink = new stdClass();
297         $newlink->subwikiid = $page->subwikiid;
298         $newlink->frompageid = $page->id;
300         if ($linkinfo['new']) {
301             $newlink->tomissingpage = $linkname;
302         } else {
303             $newlink->topageid = $linkinfo['pageid'];
304         }
306         try {
307             $DB->insert_record('wiki_links', $newlink);
308         } catch (dml_exception $e) {
309             debugging($e->getMessage());
310         }
312     }
315 /**
316  * Create a new wiki page, if the page exists, return existing pageid
317  * @param int $swid
318  * @param string $title
319  * @param string $format
320  * @param int $userid
321  */
322 function wiki_create_page($swid, $title, $format, $userid) {
323     global $DB, $PAGE;
324     $subwiki = wiki_get_subwiki($swid);
325     $cm = get_coursemodule_from_instance('wiki', $subwiki->wikiid);
326     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
327     require_capability('mod/wiki:editpage', $context);
328     // if page exists
329     if ($page = wiki_get_page_by_title($swid, $title)) {
330         return $page->id;
331     }
333     // Creating a new empty version
334     $version = new stdClass();
335     $version->content = '';
336     $version->contentformat = $format;
337     $version->version = 0;
338     $version->timecreated = time();
339     $version->userid = $userid;
341     $versionid = null;
342     $versionid = $DB->insert_record('wiki_versions', $version);
344     // Createing a new empty page
345     $page = new stdClass();
346     $page->subwikiid = $swid;
347     $page->title = $title;
348     $page->cachedcontent = '';
349     $page->timecreated = $version->timecreated;
350     $page->timemodified = $version->timecreated;
351     $page->timerendered = $version->timecreated;
352     $page->userid = $userid;
353     $page->pageviews = 0;
354     $page->readonly = 0;
356     $pageid = $DB->insert_record('wiki_pages', $page);
358     // Setting the pageid
359     $version->id = $versionid;
360     $version->pageid = $pageid;
361     $DB->update_record('wiki_versions', $version);
363     wiki_make_cache_expire($page->title);
364     return $pageid;
367 function wiki_make_cache_expire($pagename) {
368     global $DB;
370     $sql = "UPDATE {wiki_pages}
371             SET timerendered = 0
372             WHERE id IN ( SELECT l.frompageid
373                 FROM {wiki_links} l
374                 WHERE l.tomissingpage = ?
375             )";
376     $DB->execute ($sql, array($pagename));
379 /**
380  * Get a specific version of page
381  * @param int $pageid
382  * @param int $version
383  */
384 function wiki_get_wiki_page_version($pageid, $version) {
385     global $DB;
386     return $DB->get_record('wiki_versions', array('pageid' => $pageid, 'version' => $version));
389 /**
390  * Get version list
391  * @param int $pageid
392  * @param int $limitfrom
393  * @param int $limitnum
394  */
395 function wiki_get_wiki_page_versions($pageid, $limitfrom, $limitnum) {
396     global $DB;
397     return $DB->get_records('wiki_versions', array('pageid' => $pageid), 'version DESC', '*', $limitfrom, $limitnum);
400 /**
401  * Count the number of page version
402  * @param int $pageid
403  */
404 function wiki_count_wiki_page_versions($pageid) {
405     global $DB;
406     return $DB->count_records('wiki_versions', array('pageid' => $pageid));
409 /**
410  * Get linked from page
411  * @param int $pageid
412  */
413 function wiki_get_linked_to_pages($pageid) {
414     global $DB;
415     return $DB->get_records('wiki_links', array('frompageid' => $pageid));
418 /**
419  * Get linked from page
420  * @param int $pageid
421  */
422 function wiki_get_linked_from_pages($pageid) {
423     global $DB;
424     return $DB->get_records('wiki_links', array('topageid' => $pageid));
427 /**
428  * Get pages which user have been edited
429  * @param int $swid
430  * @param int $userid
431  */
432 function wiki_get_contributions($swid, $userid) {
433     global $DB;
435     $sql = "SELECT v.*
436             FROM {wiki_versions} v, {wiki_pages} p
437             WHERE p.subwikiid = ? AND
438             v.pageid = p.id AND
439             v.userid = ?";
441     return $DB->get_records_sql($sql, array($swid, $userid));
444 /**
445  * Get missing or empty pages in wiki
446  * @param int $swid sub wiki id
447  */
448 function wiki_get_missing_or_empty_pages($swid) {
449     global $DB;
451     $sql = "SELECT DISTINCT p.title, p.id, p.subwikiid
452             FROM {wiki} w, {wiki_subwikis} s, {wiki_pages} p
453             WHERE s.wikiid = w.id and
454             s.id = ? and
455             w.firstpagetitle != p.title and
456             p.subwikiid = ? and
457             1 =  (SELECT count(*)
458                 FROM {wiki_versions} v
459                 WHERE v.pageid = p.id)
460             UNION
461             SELECT DISTINCT l.tomissingpage as title, 0 as id, l.subwikiid
462             FROM {wiki_links} l
463             WHERE l.subwikiid = ? and
464             l.topageid = 0";
466     return $DB->get_records_sql($sql, array($swid, $swid, $swid));
469 /**
470  * Get pages list in wiki
471  * @param int $swid sub wiki id
472  */
473 function wiki_get_page_list($swid) {
474     global $DB;
475     $records = $DB->get_records('wiki_pages', array('subwikiid' => $swid), 'title ASC');
476     return $records;
479 /**
480  * Return a list of orphaned wikis for one specific subwiki
481  * @global object
482  * @param int $swid sub wiki id
483  */
484 function wiki_get_orphaned_pages($swid) {
485     global $DB;
487     $sql = "SELECT p.id, p.title
488             FROM {wiki_pages} p, {wiki} w , {wiki_subwikis} s
489             WHERE p.subwikiid = ?
490             AND s.id = ?
491             AND w.id = s.wikiid
492             AND p.title != w.firstpagetitle
493             AND p.id NOT IN (SELECT topageid FROM {wiki_links} WHERE subwikiid = ?);";
495     return $DB->get_records_sql($sql, array($swid, $swid, $swid));
498 /**
499  * Search wiki title
500  * @param int $swid sub wiki id
501  * @param string $search
502  */
503 function wiki_search_title($swid, $search) {
504     global $DB;
506     return $DB->get_records_select('wiki_pages', "subwikiid = ? AND title LIKE ?", array($swid, '%'.$search.'%'));
509 /**
510  * Search wiki content
511  * @param int $swid sub wiki id
512  * @param string $search
513  */
514 function wiki_search_content($swid, $search) {
515     global $DB;
517     return $DB->get_records_select('wiki_pages', "subwikiid = ? AND cachedcontent LIKE ?", array($swid, '%'.$search.'%'));
520 /**
521  * Search wiki title and content
522  * @param int $swid sub wiki id
523  * @param string $search
524  */
525 function wiki_search_all($swid, $search) {
526     global $DB;
528     return $DB->get_records_select('wiki_pages', "subwikiid = ? AND (cachedcontent LIKE ? OR title LIKE ?)", array($swid, '%'.$search.'%', '%'.$search.'%'));
531 /**
532  * Get user data
533  */
534 function wiki_get_user_info($userid) {
535     global $DB;
536     return $DB->get_record('user', array('id' => $userid));
539 /**
540  * Increase page view nubmer
541  * @param int $page, database record
542  */
543 function wiki_increment_pageviews($page) {
544     global $DB;
546     $page->pageviews++;
547     $DB->update_record('wiki_pages', $page);
550 //----------------------------------------------------------
551 //----------------------------------------------------------
553 /**
554  * Text format supported by wiki module
555  */
556 function wiki_get_formats() {
557     return array('html', 'creole', 'nwiki');
560 /**
561  * Parses a string with the wiki markup language in $markup.
562  *
563  * @return Array or false when something wrong has happened.
564  *
565  * Returned array contains the following fields:
566  *     'parsed_text' => String. Contains the parsed wiki content.
567  *     'unparsed_text' => String. Constains the original wiki content.
568  *     'link_count' => Array of array('destination' => ..., 'new' => "is new?"). Contains the internal wiki links found in the wiki content.
569  *      'deleted_sections' => the list of deleted sections.
570  *              '' =>
571  *
572  * @author Josep Arús Pous
573  **/
574 function wiki_parse_content($markup, $pagecontent, $options = array()) {
575     global $PAGE;
577     $subwiki = wiki_get_subwiki($options['swid']);
578     $cm = get_coursemodule_from_instance("wiki", $subwiki->wikiid);
579     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
581     $parser_options = array(
582         'link_callback' => '/mod/wiki/locallib.php:wiki_parser_link',
583         'link_callback_args' => array('swid' => $options['swid']),
584         'table_callback' => '/mod/wiki/locallib.php:wiki_parser_table',
585         'real_path_callback' => '/mod/wiki/locallib.php:wiki_parser_real_path',
586         'real_path_callback_args' => array(
587             'context' => $context,
588             'component' => 'mod_wiki',
589             'filearea' => 'attachments',
590             'subwikiid'=> $subwiki->id,
591             'pageid' => $options['pageid']
592         ),
593         'pageid' => $options['pageid'],
594         'pretty_print' => (isset($options['pretty_print']) && $options['pretty_print']),
595         'printable' => (isset($options['printable']) && $options['printable'])
596     );
598     return wiki_parser_proxy::parse($pagecontent, $markup, $parser_options);
601 /**
602  * This function is the parser callback to parse wiki links.
603  *
604  * It returns the necesary information to print a link.
605  *
606  * NOTE: Empty pages and non-existent pages must be print in red color.
607  *
608  * @param link name of a page
609  * @param $options
610  *
611  * @return
612  *
613  * @TODO Doc return and options
614  */
615 function wiki_parser_link($link, $options = null) {
616     global $CFG;
618     if (is_object($link)) {
619         $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));
621         $version = wiki_get_current_version($link->id);
622         if ($version->version == 0) {
623             $parsedlink['new'] = true;
624         }
625         return $parsedlink;
626     } else {
627         $swid = $options['swid'];
629         if ($page = wiki_get_page_by_title($swid, $link)) {
630             $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));
632             $version = wiki_get_current_version($page->id);
633             if ($version->version == 0) {
634                 $parsedlink['new'] = true;
635             }
637             return $parsedlink;
639         } else {
640             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));
641         }
642     }
645 /**
646  * Returns the table fully parsed (HTML)
647  *
648  * @return HTML for the table $table
649  * @author Josep Arús Pous
650  *
651  **/
652 function wiki_parser_table($table) {
653     global $OUTPUT;
655     $htmltable = new html_table();
657     $headers = $table[0];
658     $htmltable->head = array();
659     foreach ($headers as $h) {
660         $htmltable->head[] = $h[1];
661     }
663     array_shift($table);
664     $htmltable->data = array();
665     foreach ($table as $row) {
666         $row_data = array();
667         foreach ($row as $r) {
668             $row_data[] = $r[1];
669         }
670         $htmltable->data[] = $row_data;
671     }
673     return html_writer::table($htmltable);
676 /**
677  * Returns an absolute path link, unless there is no such link.
678  *
679  * @param string $url Link's URL or filename
680  * @param stdClass $context filearea params
681  * @param string $component The component the file is associated with
682  * @param string $filearea The filearea the file is stored in
683  * @param int $swid Sub wiki id
684  *
685  * @return string URL for files full path
686  */
688 function wiki_parser_real_path($url, $context, $component, $filearea, $swid) {
689     global $CFG;
691     if (preg_match("/^(?:http|ftp)s?\:\/\//", $url)) {
692         return $url;
693     } else {
695         $file = 'pluginfile.php';
696         if (!$CFG->slasharguments) {
697             $file = $file . '?file=';
698         }
699         $baseurl = "$CFG->wwwroot/$file/{$context->id}/$component/$filearea/$swid/";
700         // it is a file in current file area
701         return $baseurl . $url;
702     }
705 /**
706  * Returns the token used by a wiki language to represent a given tag or "object" (bold -> **)
707  *
708  * @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.
709  * @author Josep Arús Pous
710  **/
711 function wiki_parser_get_token($markup, $name) {
713     return wiki_parser_proxy::get_token($name, $markup);
716 /**
717  * Checks if current user can view a subwiki
718  *
719  * @param $subwiki
720  */
721 function wiki_user_can_view($subwiki) {
722     global $USER;
724     $wiki = wiki_get_wiki($subwiki->wikiid);
725     $cm = get_coursemodule_from_instance('wiki', $wiki->id);
726     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
728     // Working depending on activity groupmode
729     switch (groups_get_activity_groupmode($cm)) {
730     case NOGROUPS:
732         if ($wiki->wikimode == 'collaborative') {
733             // Collaborative Mode:
734             // There is one wiki for all the class.
735             //
736             // Only view capbility needed
737             return has_capability('mod/wiki:viewpage', $context);
738         } else if ($wiki->wikimode == 'individual') {
739             // Individual Mode:
740             // Each person owns a wiki.
741             if ($subwiki->userid == $USER->id) {
742                 // Only the owner of the wiki can view it
743                 return has_capability('mod/wiki:viewpage', $context);
744             } else { // User has special capabilities
745                 // User must have:
746                 //      mod/wiki:viewpage capability
747                 // and
748                 //      mod/wiki:managewiki capability
749                 $view = has_capability('mod/wiki:viewpage', $context);
750                 $manage = has_capability('mod/wiki:managewiki', $context);
752                 return $view && $manage;
753             }
754         } else {
755             //Error
756             return false;
757         }
758     case SEPARATEGROUPS:
759         // Collaborative and Individual Mode
760         //
761         // Collaborative Mode:
762         //      There is one wiki per group.
763         // Individual Mode:
764         //      Each person owns a wiki.
765         if ($wiki->wikimode == 'collaborative' || $wiki->wikimode == 'individual') {
766             // Only members of subwiki group could view that wiki
767             if ($subwiki->groupid == groups_get_activity_group($cm)) {
768                 // Only view capability needed
769                 return has_capability('mod/wiki:viewpage', $context);
771             } else { // User is not part of that group
772                 // User must have:
773                 //      mod/wiki:managewiki capability
774                 // or
775                 //      moodle/site:accessallgroups capability
776                 // and
777                 //      mod/wiki:viewpage capability
778                 $view = has_capability('mod/wiki:viewpage', $context);
779                 $manage = has_capability('mod/wiki:managewiki', $context);
780                 $access = has_capability('moodle/site:accessallgroups', $context);
781                 return ($manage || $access) && $view;
782             }
783         } else {
784             //Error
785             return false;
786         }
787     case VISIBLEGROUPS:
788         // Collaborative and Individual Mode
789         //
790         // Collaborative Mode:
791         //      There is one wiki per group.
792         // Individual Mode:
793         //      Each person owns a wiki.
794         if ($wiki->wikimode == 'collaborative' || $wiki->wikimode == 'individual') {
795             // Everybody can read all wikis
796             //
797             // Only view capability needed
798             return has_capability('mod/wiki:viewpage', $context);
799         } else {
800             //Error
801             return false;
802         }
803     default: // Error
804         return false;
805     }
808 /**
809  * Checks if current user can edit a subwiki
810  *
811  * @param $subwiki
812  */
813 function wiki_user_can_edit($subwiki) {
814     global $USER;
816     $wiki = wiki_get_wiki($subwiki->wikiid);
817     $cm = get_coursemodule_from_instance('wiki', $wiki->id);
818     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
820     // Working depending on activity groupmode
821     switch (groups_get_activity_groupmode($cm)) {
822     case NOGROUPS:
824         if ($wiki->wikimode == 'collaborative') {
825             // Collaborative Mode:
826             // There is a wiki for all the class.
827             //
828             // Only edit capbility needed
829             return has_capability('mod/wiki:editpage', $context);
830         } else if ($wiki->wikimode == 'individual') {
831             // Individual Mode
832             // There is a wiki per user
834             // Only the owner of that wiki can edit it
835             if ($subwiki->userid == $USER->id) {
836                 return has_capability('mod/wiki:editpage', $context);
837             } else { // Current user is not the owner of that wiki.
839                 // User must have:
840                 //      mod/wiki:editpage capability
841                 // and
842                 //      mod/wiki:managewiki capability
843                 $edit = has_capability('mod/wiki:editpage', $context);
844                 $manage = has_capability('mod/wiki:managewiki', $context);
846                 return $edit && $manage;
847             }
848         } else {
849             //Error
850             return false;
851         }
852     case SEPARATEGROUPS:
853         if ($wiki->wikimode == 'collaborative') {
854             // Collaborative Mode:
855             // There is one wiki per group.
856             //
857             // Only members of subwiki group could edit that wiki
858             if ($subwiki->groupid == groups_get_activity_group($cm)) {
859                 // Only edit capability needed
860                 return has_capability('mod/wiki:editpage', $context);
861             } else { // User is not part of that group
862                 // User must have:
863                 //      mod/wiki:managewiki capability
864                 // and
865                 //      moodle/site:accessallgroups capability
866                 // and
867                 //      mod/wiki:editpage capability
868                 $manage = has_capability('mod/wiki:managewiki', $context);
869                 $access = has_capability('moodle/site:accessallgroups', $context);
870                 $edit = has_capability('mod/wiki:editpage', $context);
871                 return $manage && $access && $edit;
872             }
873         } else if ($wiki->wikimode == 'individual') {
874             // Individual Mode:
875             // Each person owns a wiki.
876             //
877             // Only the owner of that wiki can edit it
878             if ($subwiki->userid == $USER->id) {
879                 return has_capability('mod/wiki:editpage', $context);
880             } else { // Current user is not the owner of that wiki.
881                 // User must have:
882                 //      mod/wiki:managewiki capability
883                 // and
884                 //      moodle/site:accessallgroups capability
885                 // and
886                 //      mod/wiki:editpage capability
887                 $manage = has_capability('mod/wiki:managewiki', $context);
888                 $access = has_capability('moodle/site:accessallgroups', $context);
889                 $edit = has_capability('mod/wiki:editpage', $context);
890                 return $manage && $access && $edit;
891             }
892         } else {
893             //Error
894             return false;
895         }
896     case VISIBLEGROUPS:
897         if ($wiki->wikimode == 'collaborative') {
898             // Collaborative Mode:
899             // There is one wiki per group.
900             //
901             // Only members of subwiki group could edit that wiki
902             if ($subwiki->groupid == groups_get_activity_group($cm)) {
903                 // Only edit capability needed
904                 return has_capability('mod/wiki:editpage', $context);
905             } else { // User is not part of that group
906                 // User must have:
907                 //      mod/wiki:managewiki capability
908                 // and
909                 //      mod/wiki:editpage capability
910                 $manage = has_capability('mod/wiki:managewiki', $context);
911                 $edit = has_capability('mod/wiki:editpage', $context);
912                 return $manage && $edit;
913             }
914         } else if ($wiki->wikimode == 'individual') {
915             // Individual Mode:
916             // Each person owns a wiki.
917             //
918             // Only the owner of that wiki can edit it
919             if ($subwiki->userid == $USER->id) {
920                 return has_capability('mod/wiki:editpage', $context);
921             } else { // Current user is not the owner of that wiki.
922                 // User must have:
923                 //      mod/wiki:managewiki capability
924                 // and
925                 //      mod/wiki:editpage capability
926                 $manage = has_capability('mod/wiki:managewiki', $context);
927                 $edit = has_capability('mod/wiki:editpage', $context);
928                 return $manage && $edit;
929             }
930         } else {
931             //Error
932             return false;
933         }
934     default: // Error
935         return false;
936     }
939 //----------------
940 // Locks
941 //----------------
943 /**
944  * Checks if a page-section is locked.
945  *
946  * @return true if the combination of section and page is locked, FALSE otherwise.
947  */
948 function wiki_is_page_section_locked($pageid, $userid, $section = null) {
949     global $DB;
951     $sql = "pageid = ? AND lockedat > ? AND userid != ?";
952     $params = array($pageid, time(), $userid);
954     if (!empty($section)) {
955         $sql .= " AND (sectionname = ? OR sectionname IS null)";
956         $params[] = $section;
957     }
959     return $DB->record_exists_select('wiki_locks', $sql, $params);
962 /**
963  * Inserts or updates a wiki_locks record.
964  */
965 function wiki_set_lock($pageid, $userid, $section = null, $insert = false) {
966     global $DB;
968     if (wiki_is_page_section_locked($pageid, $userid, $section)) {
969         return false;
970     }
972     $params = array('pageid' => $pageid, 'userid' => $userid, 'sectionname' => $section);
974     $lock = $DB->get_record('wiki_locks', $params);
976     if (!empty($lock)) {
977         $DB->update_record('wiki_locks', array('id' => $lock->id, 'lockedat' => time() + LOCK_TIMEOUT));
978     } else if ($insert) {
979         $DB->insert_record('wiki_locks', array('pageid' => $pageid, 'sectionname' => $section, 'userid' => $userid, 'lockedat' => time() + 30));
980     }
982     return true;
985 /**
986  * 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.
987  */
988 function wiki_delete_locks($pageid, $userid = null, $section = null, $delete_from_db = true, $delete_section_and_page = false) {
989     global $DB;
991     $params = array('pageid' => $pageid);
993     if (!empty($userid)) {
994         $params['userid'] = $userid;
995     }
997     if (!empty($section)) {
998         $params['sectionname'] = $section;
999     }
1001     if ($delete_from_db) {
1002         $DB->delete_records('wiki_locks', $params);
1003         if ($delete_section_and_page && !empty($section)) {
1004             $params['sectionname'] = null;
1005             $DB->delete_records('wiki_locks', $params);
1006         }
1007     } else {
1008         $DB->set_field('wiki_locks', 'lockedat', time(), $params);
1009     }
1012 /**
1013  * Deletes wiki_locks that expired 1 hour ago.
1014  */
1015 function wiki_delete_old_locks() {
1016     global $DB;
1018     $DB->delete_records_select('wiki_locks', "lockedat < ?", array(time() - 3600));
1021 function wiki_get_comment($commentid){
1022     global $DB;
1023     return $DB->get_record('comments', array('id' => $commentid));
1026 /**
1027  * Returns all comments by context and pageid
1028  *
1029  * @param $context. Current context
1030  * @param $pageid. Current pageid
1031  **/
1032 function wiki_get_comments($contextid, $pageid) {
1033     global $DB;
1035     return $DB->get_records('comments', array('contextid' => $contextid, 'itemid' => $pageid, 'commentarea' => 'wiki_page'));
1038 /**
1039  * Add comments ro database
1040  *
1041  * @param object $context. Current context
1042  * @param int $pageid. Current pageid
1043  * @param string $content. Content of the comment
1044  * @param string editor. Version of editor we are using.
1045  **/
1046 function wiki_add_comment($context, $pageid, $content, $editor) {
1047     global $CFG;
1048     require_once($CFG->dirroot . '/comment/lib.php');
1050     list($context, $course, $cm) = get_context_info_array($context->id);
1051     $cmt = new stdclass();
1052     $cmt->context = $context;
1053     $cmt->itemid = $pageid;
1054     $cmt->area = 'wiki_page';
1055     $cmt->course = $course;
1056     $cmt->component = 'mod_wiki';
1058     $manager = new comment($cmt);
1060     if ($editor == 'creole') {
1061         $manager->add($content, FORMAT_CREOLE);
1062     } else if ($editor == 'html') {
1063         $manager->add($content, FORMAT_HTML);
1064     } else if ($editor == 'nwiki') {
1065         $manager->add($content, FORMAT_NWIKI);
1066     }
1070 /**
1071  * Delete comments from database
1072  *
1073  * @param $idcomment. Id of comment which will be deleted
1074  * @param $context. Current context
1075  * @param $pageid. Current pageid
1076  **/
1077 function wiki_delete_comment($idcomment, $context, $pageid) {
1078     global $CFG;
1079     require_once($CFG->dirroot . '/comment/lib.php');
1081     list($context, $course, $cm) = get_context_info_array($context->id);
1082     $cmt = new stdClass();
1083     $cmt->context = $context;
1084     $cmt->itemid = $pageid;
1085     $cmt->area = 'wiki_page';
1086     $cmt->course = $course;
1087     $cmt->component = 'mod_wiki';
1089     $manager = new comment($cmt);
1090     $manager->delete($idcomment);
1094 /**
1095  * Delete al comments from wiki
1096  *
1097  **/
1098 function wiki_delete_comments_wiki() {
1099     global $PAGE, $DB;
1101     $cm = $PAGE->cm;
1102     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1104     $table = 'comments';
1105     $select = 'contextid = ?';
1107     $DB->delete_records_select($table, $select, array($context->id));
1111 function wiki_add_progress($pageid, $oldversionid, $versionid, $progress) {
1112     global $DB;
1113     for ($v = $oldversionid + 1; $v <= $versionid; $v++) {
1114         $user = wiki_get_wiki_page_id($pageid, $v);
1116         $DB->insert_record('wiki_progress', array('userid' => $user->userid, 'pageid' => $pageid, 'versionid' => $v, 'progress' => $progress));
1117     }
1120 function wiki_get_wiki_page_id($pageid, $id) {
1121     global $DB;
1122     return $DB->get_record('wiki_versions', array('pageid' => $pageid, 'id' => $id));
1125 function wiki_print_page_content($page, $context, $subwikiid) {
1126     global $OUTPUT, $CFG;
1128     if ($page->timerendered + WIKI_REFRESH_CACHE_TIME < time()) {
1129         $content = wiki_refresh_cachedcontent($page);
1130         $page = $content['page'];
1131     }
1133     if (isset($content)) {
1134         $box = '';
1135         foreach ($content['sections'] as $s) {
1136             $box .= '<p>' . get_string('repeatedsection', 'wiki', $s) . '</p>';
1137         }
1139         if (!empty($box)) {
1140             echo $OUTPUT->box($box);
1141         }
1142     }
1143     $html = file_rewrite_pluginfile_urls($page->cachedcontent, 'pluginfile.php', $context->id, 'mod_wiki', 'attachments', $subwikiid);
1144     $html = format_text($html, FORMAT_MOODLE, array('overflowdiv'=>true));
1145     echo $OUTPUT->box($html);
1147     if (!empty($CFG->usetags)) {
1148         $tags = tag_get_tags_array('wiki_pages', $page->id);
1149         echo $OUTPUT->container_start('wiki-tags');
1150         echo '<span class="wiki-tags-title">'.get_string('tags').': </span>';
1151         $links = array();
1152         foreach ($tags as $tagid=>$tag) {
1153             $url = new moodle_url('/tag/index.php', array('tag'=>$tag));
1154             $links[] = html_writer::link($url, $tag, array('title'=>get_string('tagtitle', 'wiki', $tag)));
1155         }
1156         echo join($links, ", ");
1157         echo $OUTPUT->container_end();
1158     }
1160     wiki_increment_pageviews($page);
1163 /**
1164  * This function trims any given text and returns it with some dots at the end
1165  *
1166  * @param string $text
1167  * @param string $limit
1168  *
1169  * @return string
1170  */
1171 function wiki_trim_string($text, $limit = 25) {
1173     if (strlen($text) > $limit) {
1174         $text = substr($text, 0, $limit) . '...';
1175     }
1177     return $text;
1180 /**
1181  * Prints default edit form fields and buttons
1182  *
1183  * @param string $format Edit form format (html, creole...)
1184  * @param integer $version Version number. A negative number means no versioning.
1185  */
1187 function wiki_print_edit_form_default_fields($format, $pageid, $version = -1, $upload = false, $deleteuploads = array()) {
1188     global $CFG, $PAGE, $OUTPUT;
1190     echo '<input type="hidden" name="sesskey" value="' . sesskey() . '" />';
1192     if ($version >= 0) {
1193         echo '<input type="hidden" name="version" value="' . $version . '" />';
1194     }
1196     echo '<input type="hidden" name="format" value="' . $format . '"/>';
1198     //attachments
1199     require_once($CFG->dirroot . '/lib/form/filemanager.php');
1201     $filemanager = new MoodleQuickForm_filemanager('attachments', get_string('wikiattachments', 'wiki'), array('id' => 'attachments'), array('subdirs' => false, 'maxfiles' => 99, 'maxbytes' => $CFG->maxbytes));
1203     $value = file_get_submitted_draft_itemid('attachments');
1204     if (!empty($value) && !$upload) {
1205         $filemanager->setValue($value);
1206     }
1208     echo "<fieldset class=\"wiki-upload-section clearfix\"><legend class=\"ftoggler\">" . get_string("uploadtitle", 'wiki') . "</legend>";
1210     echo $OUTPUT->container_start('mdl-align wiki-form-center aaaaa');
1211     print $filemanager->toHtml();
1212     echo $OUTPUT->container_end();
1214     $cm = $PAGE->cm;
1215     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1217     echo $OUTPUT->container_start('mdl-align wiki-form-center wiki-upload-table');
1218     wiki_print_upload_table($context, 'wiki_upload', $pageid, $deleteuploads);
1219     echo $OUTPUT->container_end();
1221     echo "</fieldset>";
1223     echo '<input class="wiki_button" type="submit" name="editoption" value="' . get_string('save', 'wiki') . '"/>';
1224     echo '<input class="wiki_button" type="submit" name="editoption" value="' . get_string('upload', 'wiki') . '"/>';
1225     echo '<input class="wiki_button" type="submit" name="editoption" value="' . get_string('preview') . '"/>';
1226     echo '<input class="wiki_button" type="submit" name="editoption" value="' . get_string('cancel') . '" />';
1229 /**
1230  * Prints a table with the files attached to a wiki page
1231  * @param object $context
1232  * @param string $filearea
1233  * @param int $fileitemid
1234  * @param array deleteuploads
1235  */
1236 function wiki_print_upload_table($context, $filearea, $fileitemid, $deleteuploads = array()) {
1237     global $CFG, $OUTPUT;
1239     $htmltable = new html_table();
1241     $htmltable->head = array(get_string('deleteupload', 'wiki'), get_string('uploadname', 'wiki'), get_string('uploadactions', 'wiki'));
1243     $fs = get_file_storage();
1244     $files = $fs->get_area_files($context->id, 'mod_wiki', $filearea, $fileitemid); //TODO: this is weird (skodak)
1246     foreach ($files as $file) {
1247         if (!$file->is_directory()) {
1248             $checkbox = '<input type="checkbox" name="deleteupload[]", value="' . $file->get_pathnamehash() . '"';
1250             if (in_array($file->get_pathnamehash(), $deleteuploads)) {
1251                 $checkbox .= ' checked="checked"';
1252             }
1254             $checkbox .= " />";
1256             $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>', "");
1257         }
1258     }
1260     print '<h3 class="upload-table-title">' . get_string('uploadfiletitle', 'wiki') . "</h3>";
1261     print html_writer::table($htmltable);
1264 /**
1265  * Generate wiki's page tree
1266  *
1267  * @param $page. A wiki page object
1268  * @param $node. Starting navigation_node
1269  * @param $keys. An array to store keys
1270  * @return an array with all tree nodes
1271  */
1272 function wiki_build_tree($page, $node, &$keys) {
1273     $content = array();
1274     static $icon;
1275     $icon = new pix_icon('f/odt', '');
1276     $pages = wiki_get_linked_pages($page->id);
1277     foreach ($pages as $p) {
1278         $key = $page->id . ':' . $p->id;
1279         if (in_array($key, $keys)) {
1280             break;
1281         }
1282         array_push($keys, $key);
1283         $l = wiki_parser_link($p);
1284         $link = new moodle_url('/mod/wiki/view.php', array('pageid' => $p->id));
1285         $nodeaux = $node->add($p->title, $link, null, null, null, $icon);
1286         if ($l['new']) {
1287             $nodeaux->add_class('wiki_newentry');
1288         }
1289         wiki_build_tree($p, $nodeaux, $keys);
1290     }
1291     $content[] = $node;
1292     return $content;
1295 /**
1296  * Get linked pages from page
1297  * @param int $pageid
1298  */
1299 function wiki_get_linked_pages($pageid) {
1300     global $DB;
1302     $sql = "SELECT p.id, p.title
1303             FROM {wiki_pages} p
1304             JOIN {wiki_links} l ON l.topageid = p.id
1305             WHERE l.frompageid = ?
1306             ORDER BY p.title ASC";
1307     return $DB->get_records_sql($sql, array($pageid));
1310 /**
1311  * Get updated pages from wiki
1312  * @param int $pageid
1313  */
1314 function wiki_get_updated_pages_by_subwiki($swid) {
1315     global $DB, $USER;
1317     $sql = "SELECT *
1318             FROM {wiki_pages}
1319             WHERE subwikiid = ? AND timemodified > ?
1320             ORDER BY timemodified DESC";
1321     return $DB->get_records_sql($sql, array($swid, $USER->lastlogin));