6922674e950517afb75e4b0c147f2b6848763833
[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');
38 define('WIKI_REFRESH_CACHE_TIME', 30); // @TODO: To be deleted.
39 define('FORMAT_CREOLE', '37');
40 define('FORMAT_NWIKI', '38');
41 define('NO_VALID_RATE', '-999');
42 define('IMPROVEMENT', '+');
43 define('EQUAL', '=');
44 define('WORST', '-');
46 define('LOCK_TIMEOUT', 30);
48 /**
49  * Get a wiki instance
50  * @param int $wikiid the instance id of wiki
51  */
52 function wiki_get_wiki($wikiid) {
53     global $DB;
55     return $DB->get_record('wiki', array('id' => $wikiid));
56 }
58 /**
59  * Get sub wiki instances with same wiki id
60  * @param int $wikiid
61  */
62 function wiki_get_subwikis($wikiid) {
63     global $DB;
64     return $DB->get_records('wiki_subwikis', array('wikiid' => $wikiid));
65 }
67 /**
68  * Get a sub wiki instance by wiki id and group id
69  * @param int $wikiid
70  * @param int $groupid
71  * @return object
72  */
73 function wiki_get_subwiki_by_group($wikiid, $groupid, $userid = 0) {
74     global $DB;
75     return $DB->get_record('wiki_subwikis', array('wikiid' => $wikiid, 'groupid' => $groupid, 'userid' => $userid));
76 }
78 /**
79  * Get a sub wiki instace by instance id
80  * @param int $subwikiid
81  * @return object
82  */
83 function wiki_get_subwiki($subwikiid) {
84     global $DB;
85     return $DB->get_record('wiki_subwikis', array('id' => $subwikiid));
87 }
89 /**
90  * Add a new sub wiki instance
91  * @param int $wikiid
92  * @param int $groupid
93  * @return int $insertid
94  */
95 function wiki_add_subwiki($wikiid, $groupid, $userid = 0) {
96     global $DB;
98     $record = new StdClass();
99     $record->wikiid = $wikiid;
100     $record->groupid = $groupid;
101     $record->userid = $userid;
103     $insertid = $DB->insert_record('wiki_subwikis', $record);
104     return $insertid;
107 /**
108  * Get a wiki instance by pageid
109  * @param int $pageid
110  * @return object
111  */
112 function wiki_get_wiki_from_pageid($pageid) {
113     global $DB;
115     $sql = "SELECT w.*
116             FROM {wiki} w, {wiki_subwikis} s, {wiki_pages} p
117             WHERE p.id = ? AND
118             p.subwikiid = s.id AND
119             s.wikiid = w.id";
121     return $DB->get_record_sql($sql, array($pageid));
124 /**
125  * Get a wiki page by pageid
126  * @param int $pageid
127  * @return object
128  */
129 function wiki_get_page($pageid) {
130     global $DB;
131     return $DB->get_record('wiki_pages', array('id' => $pageid));
134 /**
135  * Get latest version of wiki page
136  * @param int $pageid
137  * @return object
138  */
139 function wiki_get_current_version($pageid) {
140     global $DB;
142     // @TODO: Fix this query
143     $sql = "SELECT *
144             FROM {wiki_versions}
145             WHERE pageid = ?
146             ORDER BY version DESC
147             LIMIT 1";
148     return $DB->get_record_sql($sql, array($pageid));
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         if (!$versionid = $DB->insert_record('wiki_versions', $version)) {
250             return false;
251         }
253         $wikipage->timemodified = $version->timecreated;
254         $wikipage->userid = $userid;
255         $return = wiki_refresh_cachedcontent($wikipage, $newcontent);
257         return $return;
258     } else {
259         return false;
260     }
263 function wiki_refresh_cachedcontent($page, $newcontent = null) {
264     global $DB;
266     $version = wiki_get_current_version($page->id);
267     if (!isset($newcontent)) {
268         $newcontent = $version->content;
269     }
271     $options = array('swid' => $page->subwikiid, 'pageid' => $page->id);
272     $parseroutput = wiki_parse_content($version->contentformat, $newcontent, $options);
273     $page->cachedcontent = $parseroutput['toc'] . $parseroutput['parsed_text'];
274     $page->timerendered = time();
275     $DB->update_record('wiki_pages', $page);
277     wiki_refresh_page_links($page, $parseroutput['link_count']);
279     return array('page' => $page, 'sections' => $parseroutput['repeated_sections'], 'version' => $version->version);
281 /**
282  * Restore a page
283  */
284 function wiki_restore_page($wikipage, $newcontent, $userid) {
285     $return = wiki_save_page($wikipage, $newcontent, $userid);
286     return $return['page'];
289 function wiki_refresh_page_links($page, $links) {
290     global $DB;
292     $DB->delete_records('wiki_links', array('frompageid' => $page->id));
293     foreach ($links as $linkname => $linkinfo) {
295         $newlink = new stdClass();
296         $newlink->subwikiid = $page->subwikiid;
297         $newlink->frompageid = $page->id;
299         if ($linkinfo['new']) {
300             $newlink->tomissingpage = $linkname;
301         } else {
302             $newlink->topageid = $linkinfo['pageid'];
303         }
305         $DB->insert_record('wiki_links', $newlink);
307     }
310 /**
311  * Create a new wiki page, if the page exists, return existing pageid
312  * @param int $swid
313  * @param string $title
314  * @param string $format
315  * @param int $userid
316  */
317 function wiki_create_page($swid, $title, $format, $userid) {
318     global $DB, $PAGE;
319     $subwiki = wiki_get_subwiki($swid);
320     $cm = get_coursemodule_from_instance('wiki', $subwiki->wikiid);
321     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
322     require_capability('mod/wiki:editpage', $context);
323     // if page exists
324     if ($page = wiki_get_page_by_title($swid, $title)) {
325         return $page->id;
326     }
328     // Creating a new empty version
329     $version = new stdClass();
330     $version->content = '';
331     $version->contentformat = $format;
332     $version->version = 0;
333     $version->timecreated = time();
334     $version->userid = $userid;
336     $versionid = null;
337     if (!$versionid = $DB->insert_record('wiki_versions', $version)) {
338         return false;
339     }
341     // Createing a new empty page
342     $page = new stdClass();
343     $page->subwikiid = $swid;
344     $page->title = $title;
345     $page->cachedcontent = '';
346     $page->timecreated = $version->timecreated;
347     $page->timemodified = $version->timecreated;
348     $page->timerendered = $version->timecreated;
349     $page->userid = $userid;
350     $page->pageviews = 0;
351     $page->readonly = 0;
353     $pageid = $DB->insert_record('wiki_pages', $page);
355     // Setting the pageid
356     $version->id = $versionid;
357     $version->pageid = $pageid;
358     $DB->update_record('wiki_versions', $version);
360     wiki_make_cache_expire($page->title);
361     return $pageid;
364 function wiki_make_cache_expire($pagename) {
365     global $DB;
367     $sql = "UPDATE {wiki_pages}
368             SET timerendered = 0
369             WHERE id IN ( SELECT l.frompageid
370                 FROM {wiki_links} l
371                 WHERE l.tomissingpage = ?
372             )";
373     $DB->execute ($sql, array($pagename));
376 /**
377  * Get a specific version of page
378  * @param int $pageid
379  * @param int $version
380  */
381 function wiki_get_wiki_page_version($pageid, $version) {
382     global $DB;
383     return $DB->get_record('wiki_versions', array('pageid' => $pageid, 'version' => $version));
386 /**
387  * Get version list
388  * @param int $pageid
389  * @param int $limitfrom
390  * @param int $limitnum
391  */
392 function wiki_get_wiki_page_versions($pageid, $limitfrom, $limitnum) {
393     global $DB;
394     return $DB->get_records('wiki_versions', array('pageid' => $pageid), 'version DESC', '*', $limitfrom, $limitnum);
397 /**
398  * Count the number of page version
399  * @param int $pageid
400  */
401 function wiki_count_wiki_page_versions($pageid) {
402     global $DB;
403     return $DB->count_records('wiki_versions', array('pageid' => $pageid));
406 /**
407  * Get linked from page
408  * @param int $pageid
409  */
410 function wiki_get_linked_to_pages($pageid) {
411     global $DB;
412     return $DB->get_records('wiki_links', array('frompageid' => $pageid));
415 /**
416  * Get linked from page
417  * @param int $pageid
418  */
419 function wiki_get_linked_from_pages($pageid) {
420     global $DB;
421     return $DB->get_records('wiki_links', array('topageid' => $pageid));
424 /**
425  * Get pages which user have been edited
426  * @param int $swid
427  * @param int $userid
428  */
429 function wiki_get_contributions($swid, $userid) {
430     global $DB;
432     $sql = "SELECT v.*
433             FROM {wiki_versions} v, {wiki_pages} p
434             WHERE p.subwikiid = ? AND
435             v.pageid = p.id AND
436             v.userid = ?";
438     return $DB->get_records_sql($sql, array($swid, $userid));
441 /**
442  * Get missing or empty pages in wiki
443  * @param int $swid sub wiki id
444  */
445 function wiki_get_missing_or_empty_pages($swid) {
446     global $DB;
448     $sql = "SELECT DISTINCT p.title, p.id, p.subwikiid
449             FROM {wiki} w, {wiki_subwikis} s, {wiki_pages} p
450             WHERE s.wikiid = w.id and
451             s.id = ? and
452             w.firstpagetitle != p.title and
453             p.subwikiid = ? and
454             1 =  (SELECT count(*)
455                 FROM {wiki_versions} v
456                 WHERE v.pageid = p.id)
457             UNION
458             SELECT DISTINCT l.tomissingpage as title, 0 as id, l.subwikiid
459             FROM {wiki_links} l
460             WHERE l.subwikiid = ? and
461             l.topageid = 0";
463     return $DB->get_records_sql($sql, array($swid, $swid, $swid));
466 /**
467  * Get pages list in wiki
468  * @param int $swid sub wiki id
469  */
470 function wiki_get_page_list($swid) {
471     global $DB;
472     $records = $DB->get_records('wiki_pages', array('subwikiid' => $swid), 'title ASC');
473     return $records;
476 /**
477  * Return a list of orphaned wikis for one specific subwiki
478  * @global object
479  * @param int $swid sub wiki id
480  */
481 function wiki_get_orphaned_pages($swid) {
482     global $DB;
484     $sql = "SELECT p.id, p.title
485             FROM {wiki_pages} p, {wiki} w , {wiki_subwikis} s
486             WHERE p.subwikiid = ?
487             AND s.id = ?
488             AND w.id = s.wikiid
489             AND p.title != w.firstpagetitle
490             AND p.id NOT IN (SELECT topageid FROM {wiki_links} WHERE subwikiid = ?);";
492     return $DB->get_records_sql($sql, array($swid, $swid, $swid));
495 /**
496  * Search wiki title
497  * @param int $swid sub wiki id
498  * @param string $search
499  */
500 function wiki_search_title($swid, $search) {
501     global $DB;
503     return $DB->get_records_select('wiki_pages', "subwikiid = ? AND title LIKE ?", array($swid, '%'.$search.'%'));
506 /**
507  * Search wiki content
508  * @param int $swid sub wiki id
509  * @param string $search
510  */
511 function wiki_search_content($swid, $search) {
512     global $DB;
514     return $DB->get_records_select('wiki_pages', "subwikiid = ? AND cachedcontent LIKE ?", array($swid, '%'.$search.'%'));
517 /**
518  * Search wiki title and content
519  * @param int $swid sub wiki id
520  * @param string $search
521  */
522 function wiki_search_all($swid, $search) {
523     global $DB;
525     return $DB->get_records_select('wiki_pages', "subwikiid = ? AND (cachedcontent LIKE ? OR title LIKE ?)", array($swid, '%'.$search.'%', '%'.$search.'%'));
528 /**
529  * Get user data
530  */
531 function wiki_get_user_info($userid) {
532     global $DB;
533     return $DB->get_record('user', array('id' => $userid));
536 /**
537  * Increase page view nubmer
538  * @param int $page, database record
539  */
540 function wiki_increment_pageviews($page) {
541     global $DB;
543     $page->pageviews++;
544     $DB->update_record('wiki_pages', $page);
547 //----------------------------------------------------------
548 //----------------------------------------------------------
550 /**
551  * Text format supported by wiki module
552  */
553 function wiki_get_formats() {
554     return array('html', 'creole', 'nwiki');
557 /**
558  * Parses a string with the wiki markup language in $markup.
559  *
560  * @return Array or false when something wrong has happened.
561  *
562  * Returned array contains the following fields:
563  *     'parsed_text' => String. Contains the parsed wiki content.
564  *     'unparsed_text' => String. Constains the original wiki content.
565  *     'link_count' => Array of array('destination' => ..., 'new' => "is new?"). Contains the internal wiki links found in the wiki content.
566  *      'deleted_sections' => the list of deleted sections.
567  *              '' =>
568  *
569  * @author Josep Arús Pous
570  **/
571 function wiki_parse_content($markup, $pagecontent, $options = array()) {
572     global $PAGE;
574     $subwiki = wiki_get_subwiki($options['swid']);
575     $cm = get_coursemodule_from_instance("wiki", $subwiki->wikiid);
576     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
578     $parser_options = array('link_callback' => '/mod/wiki/locallib.php:wiki_parser_link', 'link_callback_args' => array('swid' => $options['swid']), 'table_callback' => '/mod/wiki/locallib.php:wiki_parser_table', 'real_path_callback' => '/mod/wiki/locallib.php:wiki_parser_real_path', 'real_path_callback_args' => array('context' => $context, 'component' => 'mod_wiki', 'filearea' => 'attachments', 'pageid' => $options['pageid']), 'pageid' => $options['pageid'], 'pretty_print' => (isset($options['pretty_print']) && $options['pretty_print']), 'printable' => (isset($options['printable']) && $options['printable']));
580     return wiki_parser_proxy::parse($pagecontent, $markup, $parser_options);
583 /**
584  * This function is the parser callback to parse wiki links.
585  *
586  * It returns the necesary information to print a link.
587  *
588  * NOTE: Empty pages and non-existent pages must be print in red color.
589  *
590  * @param link name of a page
591  * @param $options
592  *
593  * @return
594  *
595  * @TODO Doc return and options
596  */
597 function wiki_parser_link($link, $options = null) {
598     global $CFG;
600     if (is_object($link)) {
601         $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));
603         $version = wiki_get_current_version($link->id);
604         if ($version->version == 0) {
605             $parsedlink['new'] = true;
606         }
607         return $parsedlink;
608     } else {
609         $swid = $options['swid'];
611         if ($page = wiki_get_page_by_title($swid, $link)) {
612             $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));
614             $version = wiki_get_current_version($page->id);
615             if ($version->version == 0) {
616                 $parsedlink['new'] = true;
617             }
619             return $parsedlink;
621         } else {
622             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));
623         }
624     }
627 /**
628  * Returns the table fully parsed (HTML)
629  *
630  * @return HTML for the table $table
631  * @author Josep Arús Pous
632  *
633  **/
634 function wiki_parser_table($table) {
635     global $OUTPUT;
637     $htmltable = new html_table();
639     $headers = $table[0];
640     $htmltable->head = array();
641     foreach ($headers as $h) {
642         $htmltable->head[] = $h[1];
643     }
645     array_shift($table);
646     $htmltable->data = array();
647     foreach ($table as $row) {
648         $row_data = array();
649         foreach ($row as $r) {
650             $row_data[] = $r[1];
651         }
652         $htmltable->data[] = $row_data;
653     }
655     return html_writer::table($htmltable);
658 /**
659  * Returns an absolute path link, unless there is no such link.
660  *
661  * @param url Link's URL
662  * @param context filearea params
663  * @param filearea
664  * @param fileareaid
665  *
666  * @return File full path
667  */
669 function wiki_parser_real_path($url, $context, $filearea, $fileareaid) {
670     global $CFG;
672     if (preg_match("/^(?:http|ftp)s?\:\/\//", $url)) {
673         return $url;
674     } else {
675         return "{$CFG->wwwroot}/pluginfile.php/{$context->id}/$filearea/$fileareaid/$url";
676     }
679 /**
680  * Returns the token used by a wiki language to represent a given tag or "object" (bold -> **)
681  *
682  * @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.
683  * @author Josep Arús Pous
684  **/
685 function wiki_parser_get_token($markup, $name) {
687     return wiki_parser_proxy::get_token($name, $markup);
690 /**
691  * Checks if current user can view a subwiki
692  *
693  * @param $subwiki
694  */
695 function wiki_user_can_view($subwiki) {
696     global $USER;
698     $wiki = wiki_get_wiki($subwiki->wikiid);
699     $cm = get_coursemodule_from_instance('wiki', $wiki->id);
700     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
702     // Working depending on activity groupmode
703     switch (groups_get_activity_groupmode($cm)) {
704     case NOGROUPS:
706         if ($wiki->wikimode == 'collaborative') {
707             // Collaborative Mode:
708             // There is one wiki for all the class.
709             //
710             // Only view capbility needed
711             return has_capability('mod/wiki:viewpage', $context, $USER);
712         } else if ($wiki->wikimode == 'individual') {
713             // Individual Mode:
714             // Each person owns a wiki.
715             if ($subwiki->userid == $USER->id) {
716                 // Only the owner of the wiki can view it
717                 return has_capability('mod/wiki:viewpage', $context, $USER);
718             } else { // User has special capabilities
719                 // User must have:
720                 //      mod/wiki:viewpage capability
721                 // and
722                 //      mod/wiki:managewiki capability
723                 $view = has_capability('mod/wiki:viewpage', $context, $USER);
724                 $manage = has_capability('mod/wiki:managewiki', $context, $USER);
726                 return $view && $manage;
727             }
728         } else {
729             //Error
730             return false;
731         }
732     case SEPARATEGROUPS:
733         // Collaborative and Individual Mode
734         //
735         // Collaborative Mode:
736         //      There is one wiki per group.
737         // Individual Mode:
738         //      Each person owns a wiki.
739         if ($wiki->wikimode == 'collaborative' || $wiki->wikimode == 'individual') {
740             // Only members of subwiki group could view that wiki
741             if ($subwiki->groupid == groups_get_activity_group($cm)) {
742                 // Only view capability needed
743                 return has_capability('mod/wiki:viewpage', $context, $USER);
745             } else { // User is not part of that group
746                 // User must have:
747                 //      mod/wiki:managewiki capability
748                 // or
749                 //      moodle/site:accessallgroups capability
750                 // and
751                 //      mod/wiki:viewpage capability
752                 $view = has_capability('mod/wiki:viewpage', $context, $USER);
753                 $manage = has_capability('mod/wiki:managewiki', $context, $USER);
754                 $access = has_capability('moodle/site:accessallgroups', $context, $USER);
755                 return ($manage || $access) && $view;
756             }
757         } else {
758             //Error
759             return false;
760         }
761     case VISIBLEGROUPS:
762         // Collaborative and Individual Mode
763         //
764         // Collaborative Mode:
765         //      There is one wiki per group.
766         // Individual Mode:
767         //      Each person owns a wiki.
768         if ($wiki->wikimode == 'collaborative' || $wiki->wikimode == 'individual') {
769             // Everybody can read all wikis
770             //
771             // Only view capability needed
772             return has_capability('mod/wiki:viewpage', $context, $USER);
773         } else {
774             //Error
775             return false;
776         }
777     default: // Error
778         return false;
779     }
782 /**
783  * Checks if current user can edit a subwiki
784  *
785  * @param $subwiki
786  */
787 function wiki_user_can_edit($subwiki) {
788     global $USER;
790     $wiki = wiki_get_wiki($subwiki->wikiid);
791     $cm = get_coursemodule_from_instance('wiki', $wiki->id);
792     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
794     // Working depending on activity groupmode
795     switch (groups_get_activity_groupmode($cm)) {
796     case NOGROUPS:
798         if ($wiki->wikimode == 'collaborative') {
799             // Collaborative Mode:
800             // There is a wiki for all the class.
801             //
802             // Only edit capbility needed
803             return has_capability('mod/wiki:editpage', $context, $USER);
804         } else if ($wiki->wikimode == 'individual') {
805             // Individual Mode
806             // There is a wiki per user
808             // Only the owner of that wiki can edit it
809             if ($subwiki->userid == $USER->id) {
810                 return has_capability('mod/wiki:editpage', $context, $USER);
811             } else { // Current user is not the owner of that wiki.
813                 // User must have:
814                 //      mod/wiki:editpage capability
815                 // and
816                 //      mod/wiki:managewiki capability
817                 $edit = has_capability('mod/wiki:editpage', $context, $USER);
818                 $manage = has_capability('mod/wiki:managewiki', $context, $USER);
820                 return $edit && $manage;
821             }
822         } else {
823             //Error
824             return false;
825         }
826     case SEPARATEGROUPS:
827         if ($wiki->wikimode == 'collaborative') {
828             // Collaborative Mode:
829             // There is one wiki per group.
830             //
831             // Only members of subwiki group could edit that wiki
832             if ($subwiki->groupid == groups_get_activity_group($cm)) {
833                 // Only edit capability needed
834                 return has_capability('mod/wiki:editpage', $context, $USER);
835             } else { // User is not part of that group
836                 // User must have:
837                 //      mod/wiki:managewiki capability
838                 // and
839                 //      moodle/site:accessallgroups capability
840                 // and
841                 //      mod/wiki:editpage capability
842                 $manage = has_capability('mod/wiki:managewiki', $context, $USER);
843                 $access = has_capability('moodle/site:accessallgroups', $context, $USER);
844                 $edit = has_capability('mod/wiki:editpage', $context, $USER);
845                 return $manage && $access && $edit;
846             }
847         } else if ($wiki->wikimode == 'individual') {
848             // Individual Mode:
849             // Each person owns a wiki.
850             //
851             // Only the owner of that wiki can edit it
852             if ($subwiki->userid == $USER->id) {
853                 return has_capability('mod/wiki:editpage', $context, $USER);
854             } else { // Current user is not the owner of that wiki.
855                 // User must have:
856                 //      mod/wiki:managewiki capability
857                 // and
858                 //      moodle/site:accessallgroups capability
859                 // and
860                 //      mod/wiki:editpage capability
861                 $manage = has_capability('mod/wiki:managewiki', $context, $USER);
862                 $access = has_capability('moodle/site:accessallgroups', $context, $USER);
863                 $edit = has_capability('mod/wiki:editpage', $context, $USER);
864                 return $manage && $access && $edit;
865             }
866         } else {
867             //Error
868             return false;
869         }
870     case VISIBLEGROUPS:
871         if ($wiki->wikimode == 'collaborative') {
872             // Collaborative Mode:
873             // There is one wiki per group.
874             //
875             // Only members of subwiki group could edit that wiki
876             if ($subwiki->groupid == groups_get_activity_group($cm)) {
877                 // Only edit capability needed
878                 return has_capability('mod/wiki:editpage', $context, $USER);
879             } else { // User is not part of that group
880                 // User must have:
881                 //      mod/wiki:managewiki capability
882                 // and
883                 //      mod/wiki:editpage capability
884                 $manage = has_capability('mod/wiki:managewiki', $context, $USER);
885                 $edit = has_capability('mod/wiki:editpage', $context, $USER);
886                 return $manage && $edit;
887             }
888         } else if ($wiki->wikimode == 'individual') {
889             // Individual Mode:
890             // Each person owns a wiki.
891             //
892             // Only the owner of that wiki can edit it
893             if ($subwiki->userid == $USER->id) {
894                 return has_capability('mod/wiki:editpage', $context, $USER);
895             } else { // Current user is not the owner of that wiki.
896                 // User must have:
897                 //      mod/wiki:managewiki capability
898                 // and
899                 //      mod/wiki:editpage capability
900                 $manage = has_capability('mod/wiki:managewiki', $context, $USER);
901                 $edit = has_capability('mod/wiki:editpage', $context, $USER);
902                 return $manage && $edit;
903             }
904         } else {
905             //Error
906             return false;
907         }
908     default: // Error
909         return false;
910     }
913 //----------------
914 // Locks
915 //----------------
917 /**
918  * Checks if a page-section is locked.
919  *
920  * @return true if the combination of section and page is locked, FALSE otherwise.
921  */
922 function wiki_is_page_section_locked($pageid, $userid, $section = null) {
923     global $DB;
925     $sql = "pageid = ? AND lockedat > ? AND userid != ?";
926     $params = array($pageid, time(), $userid);
928     if (!empty($section)) {
929         $sql .= " AND (sectionname = ? OR sectionname IS null)";
930         $params[] = $section;
931     }
933     return $DB->record_exists_select('wiki_locks', $sql, $params);
936 /**
937  * Inserts or updates a wiki_locks record.
938  */
939 function wiki_set_lock($pageid, $userid, $section = null, $insert = false) {
940     global $DB;
942     if (wiki_is_page_section_locked($pageid, $userid, $section)) {
943         return false;
944     }
946     $params = array('pageid' => $pageid, 'userid' => $userid, 'sectionname' => $section);
948     $lock = $DB->get_record('wiki_locks', $params);
950     if (!empty($lock)) {
951         $DB->update_record('wiki_locks', array('id' => $lock->id, 'lockedat' => time() + LOCK_TIMEOUT));
952     } else if ($insert) {
953         $DB->insert_record('wiki_locks', array('pageid' => $pageid, 'sectionname' => $section, 'userid' => $userid, 'lockedat' => time() + 30));
954     }
956     return true;
959 /**
960  * 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.
961  */
962 function wiki_delete_locks($pageid, $userid = null, $section = null, $delete_from_db = true, $delete_section_and_page = false) {
963     global $DB;
965     $params = array('pageid' => $pageid);
967     if (!empty($userid)) {
968         $params['userid'] = $userid;
969     }
971     if (!empty($section)) {
972         $params['sectionname'] = $section;
973     }
975     if ($delete_from_db) {
976         $DB->delete_records('wiki_locks', $params);
977         if ($delete_section_and_page && !empty($section)) {
978             $params['sectionname'] = null;
979             $DB->delete_records('wiki_locks', $params);
980         }
981     } else {
982         $DB->set_field('wiki_locks', 'lockedat', time(), $params);
983     }
986 /**
987  * Deletes wiki_locks that expired 1 hour ago.
988  */
989 function wiki_delete_old_locks() {
990     global $DB;
992     $DB->delete_records_select('wiki_locks', "lockedat < ?", array(time() - 3600));
995 /**
996  * File processing
997  */
999 /**
1000  * Uploads files to permanent disk space.
1001  *
1002  * @param draftitemid Draft space ID
1003  * @param contextid
1004  *
1005  * @return array of files that have not been inserted.
1006  */
1008 function wiki_process_attachments($draftitemid, $deleteuploads, $contextid, $filearea, $itemid, $options = null) {
1009     global $CFG, $USER;
1011     if (empty($options)) {
1012         $options = page_wiki_edit::$attachmentoptions;
1013     }
1015     $errors = array();
1017     $usercontext = get_context_instance(CONTEXT_USER, $USER->id);
1018     $fs = get_file_storage();
1020     $oldfiles = $fs->get_area_files($contextid, 'mod_wiki', 'attachments', $itemid, 'id');
1022     foreach ($oldfiles as $file) {
1023         if (in_array($file->get_pathnamehash(), $deleteuploads)) {
1024             $file->delete();
1025         }
1026     }
1028     $draftfiles = $fs->get_area_files($usercontext->id, 'user', 'draft', $draftitemid, 'id');
1029     $oldfiles = $fs->get_area_files($contextid, 'mod_wiki', 'attachments', $itemid, 'id');
1031     $file_record = array('contextid' => $contextid, 'component' => 'mod_wiki', 'filearea' => 'attachments', 'itemid' => $itemid);
1032     //more or less a merge...
1033     $newhashes = array();
1034     foreach ($draftfiles as $file) {
1035         $newhash = sha1("/$contextid/mod_wiki/attachments/$itemid" . $file->get_filepath() . $file->get_filename());
1036         $newhashes[$newhash] = $file;
1037     }
1039     $filecount = 0;
1040     foreach ($oldfiles as $file) {
1041         $oldhash = $file->get_pathnamehash();
1042         if (!$file->is_directory() && isset($newhashes[$oldhash])) {
1043             //repeated file: ERROR!!!
1044             unset($newhashes[$oldhash]);
1045             $errors[] = $file;
1046         }
1048         if (!$file->is_directory()) {
1049             $filecount++;
1050         }
1051     }
1053     foreach ($newhashes as $file) {
1054         if ($file->get_filepath() !== '/' or $file->is_directory()) {
1055             continue;
1056         }
1058         if ($options['maxfiles'] and $options['maxfiles'] <= $filecount) {
1059             break;
1060         }
1062         if (!$file->is_directory()) {
1063             $filecount++;
1064             $fs->create_file_from_storedfile($file_record, $file);
1065         }
1066     }
1068     //delete all draft files
1069     $fs->delete_area_files($usercontext->id, 'user', 'draft', $draftitemid);
1071     return $errors;
1074 function wiki_get_comment($commentid){
1075     global $DB;
1076     return $DB->get_record('comments', array('id' => $commentid));
1079 /**
1080  * Returns all comments by context and pageid
1081  *
1082  * @param $context. Current context
1083  * @param $pageid. Current pageid
1084  **/
1085 function wiki_get_comments($contextid, $pageid) {
1086     global $DB;
1088     return $DB->get_records('comments', array('contextid' => $contextid, 'itemid' => $pageid, 'commentarea' => 'wiki_page'));
1091 /**
1092  * Add comments ro database
1093  *
1094  * @param object $context. Current context
1095  * @param int $pageid. Current pageid
1096  * @param string $content. Content of the comment
1097  * @param string editor. Version of editor we are using.
1098  **/
1099 function wiki_add_comment($context, $pageid, $content, $editor) {
1100     global $CFG;
1101     require_once($CFG->dirroot . '/comment/lib.php');
1103     list($context, $course, $cm) = get_context_info_array($context->id);
1104     $cmt = new stdclass();
1105     $cmt->context = $context;
1106     $cmt->itemid = $pageid;
1107     $cmt->area = 'wiki_page';
1108     $cmt->course = $course;
1109     $cmt->pluginname = 'wiki';
1111     $manager = new comment($cmt);
1113     if ($editor == 'creole') {
1114         $manager->add($content, FORMAT_CREOLE);
1115     } else if ($editor == 'html') {
1116         $manager->add($content, FORMAT_HTML);
1117     } else if ($editor == 'nwiki') {
1118         $manager->add($content, FORMAT_NWIKI);
1119     }
1123 /**
1124  * Delete comments from database
1125  *
1126  * @param $idcomment. Id of comment which will be deleted
1127  * @param $context. Current context
1128  * @param $pageid. Current pageid
1129  **/
1130 function wiki_delete_comment($idcomment, $context, $pageid) {
1131     global $CFG;
1132     require_once($CFG->dirroot . '/comment/lib.php');
1134     list($context, $course, $cm) = get_context_info_array($context->id);
1135     $cmt = new stdclass;
1136     $cmt->context = $context;
1137     $cmt->itemid = $pageid;
1138     $cmt->area = 'wiki_page';
1139     $cmt->pluginname = 'wiki';
1140     $cmt->course = $course;
1142     $manager = new comment($cmt);
1143     $manager->delete($idcomment);
1147 /**
1148  * Delete al comments from wiki
1149  *
1150  **/
1151 function wiki_delete_comments_wiki() {
1152     global $PAGE, $DB;
1154     $cm = $PAGE->cm;
1155     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1157     $table = 'comments';
1158     $select = 'contextid = ?';
1160     $DB->delete_records_select($table, $select, array($context->id));
1164 function wiki_add_progress($pageid, $oldversionid, $versionid, $progress) {
1165     global $DB;
1166     for ($v = $oldversionid + 1; $v <= $versionid; $v++) {
1167         $user = wiki_get_wiki_page_id($pageid, $v);
1169         $DB->insert_record('wiki_progress', array('userid' => $user->userid, 'pageid' => $pageid, 'versionid' => $v, 'progress' => $progress));
1170     }
1173 function wiki_get_wiki_page_id($pageid, $id) {
1174     global $DB;
1175     return $DB->get_record('wiki_versions', array('pageid' => $pageid, 'id' => $id));
1178 function wiki_print_page_content($page, $context, $subwikiid) {
1179     global $OUTPUT, $CFG;
1181     if ($page->timerendered + WIKI_REFRESH_CACHE_TIME < time()) {
1182         $content = wiki_refresh_cachedcontent($page);
1183         $page = $content['page'];
1184     }
1186     if (isset($content)) {
1187         $box = '';
1188         foreach ($content['sections'] as $s) {
1189             $box .= '<p>' . get_string('repeatedsection', 'wiki', $s) . '</p>';
1190         }
1192         if (!empty($box)) {
1193             echo $OUTPUT->box($box);
1194         }
1195     }
1196     $html = file_rewrite_pluginfile_urls($page->cachedcontent, 'pluginfile.php', $context->id, 'mod_wiki', 'attachments', $subwikiid);
1197     $html = format_text($html);
1198     echo $OUTPUT->box($html);
1200     if (!empty($CFG->usetags)) {
1201         $tags = tag_get_tags_array('wiki_page', $page->id);
1202         echo '<p class="wiki-tags"><span>Tags: </span>' . join($tags, ", ") . '</p>';
1203     }
1205     wiki_increment_pageviews($page);
1208 /**
1209  * This function trims any given text and returns it with some dots at the end
1210  *
1211  * @param string $text
1212  * @param string $limit
1213  *
1214  * @return string
1215  */
1216 function wiki_trim_string($text, $limit = 25) {
1218     if (strlen($text) > $limit) {
1219         $text = substr($text, 0, $limit) . '...';
1220     }
1222     return $text;
1225 /**
1226  * Prints default edit form fields and buttons
1227  *
1228  * @param string $format Edit form format (html, creole...)
1229  * @param integer $version Version number. A negative number means no versioning.
1230  */
1232 function wiki_print_edit_form_default_fields($format, $pageid, $version = -1, $upload = false, $deleteuploads = array()) {
1233     global $CFG, $PAGE, $OUTPUT;
1235     echo '<input type="hidden" name="sesskey" value="' . sesskey() . '" />';
1237     if ($version >= 0) {
1238         echo '<input type="hidden" name="version" value="' . $version . '" />';
1239     }
1241     echo '<input type="hidden" name="format" value="' . $format . '"/>';
1243     //attachments
1244     require_once($CFG->dirroot . '/lib/form/filemanager.php');
1246     $filemanager = new MoodleQuickForm_filemanager('attachments', get_string('wikiattachments', 'wiki'), array('id' => 'attachments'), array('subdirs' => false, 'maxfiles' => 99, 'maxbytes' => $CFG->maxbytes));
1248     $value = file_get_submitted_draft_itemid('attachments');
1249     if (!empty($value) && !$upload) {
1250         $filemanager->setValue($value);
1251     }
1253     echo "<fieldset class=\"wiki-upload-section clearfix\"><legend class=\"ftoggler\">" . get_string("uploadtitle", 'wiki') . "</legend>";
1255     echo $OUTPUT->container_start('mdl-align wiki-form-center aaaaa');
1256     print $filemanager->toHtml();
1257     echo $OUTPUT->container_end();
1259     $cm = $PAGE->cm;
1260     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1262     echo $OUTPUT->container_start('mdl-align wiki-form-center wiki-upload-table');
1263     wiki_print_upload_table($context, 'wiki_upload', $pageid, $deleteuploads);
1264     echo $OUTPUT->container_end();
1266     echo "</fieldset>";
1268     echo '<input class="wiki_button" type="submit" name="editoption" value="' . get_string('save', 'wiki') . '"/>';
1269     echo '<input class="wiki_button" type="submit" name="editoption" value="' . get_string('upload', 'wiki') . '"/>';
1270     echo '<input class="wiki_button" type="submit" name="editoption" value="' . get_string('preview') . '"/>';
1271     echo '<input class="wiki_button" type="submit" name="editoption" value="' . get_string('cancel') . '" />';
1274 /**
1275  * Prints a table with the files attached to a wiki page
1276  * @param object $context
1277  * @param string $filearea
1278  * @param int $fileitemid
1279  * @param array deleteuploads
1280  */
1281 function wiki_print_upload_table($context, $filearea, $fileitemid, $deleteuploads = array()) {
1282     global $CFG, $OUTPUT;
1284     $htmltable = new html_table();
1286     $htmltable->head = array(get_string('deleteupload', 'wiki'), get_string('uploadname', 'wiki'), get_string('uploadactions', 'wiki'));
1288     $fs = get_file_storage();
1289     $files = $fs->get_area_files($context->id, 'mod_wiki', $filearea, $fileitemid); //TODO: this is weird (skodak)
1291     foreach ($files as $file) {
1292         if (!$file->is_directory()) {
1293             $checkbox = '<input type="checkbox" name="deleteupload[]", value="' . $file->get_pathnamehash() . '"';
1295             if (in_array($file->get_pathnamehash(), $deleteuploads)) {
1296                 $checkbox .= ' checked="checked"';
1297             }
1299             $checkbox .= " />";
1301             $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>', "");
1302         }
1303     }
1305     print '<h3 class="upload-table-title">' . get_string('uploadfiletitle', 'wiki') . "</h3>";
1306     print html_writer::table($htmltable);
1309 /**
1310  * Generate wiki's page tree
1311  *
1312  * @param $page. A wiki page object
1313  * @param $node. Starting navigation_node
1314  * @param $keys. An array to store keys
1315  * @return an array with all tree nodes
1316  */
1317 function wiki_build_tree($page, $node, &$keys) {
1318     $content = array();
1319     static $icon;
1320     $icon = new pix_icon('f/odt', '');
1321     $pages = wiki_get_linked_pages($page->id);
1322     foreach ($pages as $p) {
1323         $key = $page->id . ':' . $p->id;
1324         if (in_array($key, $keys)) {
1325             break;
1326         }
1327         array_push($keys, $key);
1328         $l = wiki_parser_link($p);
1329         $link = new moodle_url('/mod/wiki/view.php', array('pageid' => $p->id));
1330         $nodeaux = $node->add($p->title, $link, null, null, null, $icon);
1331         if ($l['new']) {
1332             $nodeaux->add_class('wiki_newentry');
1333         }
1334         wiki_build_tree($p, $nodeaux, $keys);
1335     }
1336     $content[] = $node;
1337     return $content;
1340 /**
1341  * Get linked pages from page
1342  * @param int $pageid
1343  */
1344 function wiki_get_linked_pages($pageid) {
1345     global $DB;
1347     $sql = "SELECT p.id, p.title
1348             FROM mdl_wiki_pages p
1349             JOIN mdl_wiki_links l ON l.topageid = p.id
1350             WHERE l.frompageid = ?
1351             ORDER BY p.title ASC";
1352     return $DB->get_records_sql($sql, array($pageid));
1355 /**
1356  * Get updated pages from wiki
1357  * @param int $pageid
1358  */
1359 function wiki_get_updated_pages_by_subwiki($swid) {
1360     global $DB, $USER;
1362     $sql = "SELECT *
1363             FROM {wiki_pages}
1364             WHERE subwikiid = ? AND timemodified > ?
1365             ORDER BY timemodified DESC";
1366     return $DB->get_records_sql($sql, array($swid, $USER->lastlogin));