35fb5cd58850e69610c660c71bca415fe098fafb
[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         $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 (!isset($newcontent)) {
266         $newcontent = $version->content;
267     }
269     $options = array('swid' => $page->subwikiid, 'pageid' => $page->id);
270     $parseroutput = wiki_parse_content($version->contentformat, $newcontent, $options);
271     $page->cachedcontent = $parseroutput['toc'] . $parseroutput['parsed_text'];
272     $page->timerendered = time();
273     $DB->update_record('wiki_pages', $page);
275     wiki_refresh_page_links($page, $parseroutput['link_count']);
277     return array('page' => $page, 'sections' => $parseroutput['repeated_sections'], 'version' => $version->version);
279 /**
280  * Restore a page
281  */
282 function wiki_restore_page($wikipage, $newcontent, $userid) {
283     $return = wiki_save_page($wikipage, $newcontent, $userid);
284     return $return['page'];
287 function wiki_refresh_page_links($page, $links) {
288     global $DB;
290     $DB->delete_records('wiki_links', array('frompageid' => $page->id));
291     foreach ($links as $linkname => $linkinfo) {
293         $newlink = new stdClass();
294         $newlink->subwikiid = $page->subwikiid;
295         $newlink->frompageid = $page->id;
297         if ($linkinfo['new']) {
298             $newlink->tomissingpage = $linkname;
299         } else {
300             $newlink->topageid = $linkinfo['pageid'];
301         }
303         $DB->insert_record('wiki_links', $newlink);
305     }
308 /**
309  * Create a new wiki page, if the page exists, return existing pageid
310  * @param int $swid
311  * @param string $title
312  * @param string $format
313  * @param int $userid
314  */
315 function wiki_create_page($swid, $title, $format, $userid) {
316     global $DB, $PAGE;
317     $subwiki = wiki_get_subwiki($swid);
318     $cm = get_coursemodule_from_instance('wiki', $subwiki->wikiid);
319     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
320     require_capability('mod/wiki:editpage', $context);
321     // if page exists
322     if ($page = wiki_get_page_by_title($swid, $title)) {
323         return $page->id;
324     }
326     // Creating a new empty version
327     $version = new stdClass();
328     $version->content = '';
329     $version->contentformat = $format;
330     $version->version = 0;
331     $version->timecreated = time();
332     $version->userid = $userid;
334     $versionid = null;
335     $versionid = $DB->insert_record('wiki_versions', $version);
337     // Createing a new empty page
338     $page = new stdClass();
339     $page->subwikiid = $swid;
340     $page->title = $title;
341     $page->cachedcontent = '';
342     $page->timecreated = $version->timecreated;
343     $page->timemodified = $version->timecreated;
344     $page->timerendered = $version->timecreated;
345     $page->userid = $userid;
346     $page->pageviews = 0;
347     $page->readonly = 0;
349     $pageid = $DB->insert_record('wiki_pages', $page);
351     // Setting the pageid
352     $version->id = $versionid;
353     $version->pageid = $pageid;
354     $DB->update_record('wiki_versions', $version);
356     wiki_make_cache_expire($page->title);
357     return $pageid;
360 function wiki_make_cache_expire($pagename) {
361     global $DB;
363     $sql = "UPDATE {wiki_pages}
364             SET timerendered = 0
365             WHERE id IN ( SELECT l.frompageid
366                 FROM {wiki_links} l
367                 WHERE l.tomissingpage = ?
368             )";
369     $DB->execute ($sql, array($pagename));
372 /**
373  * Get a specific version of page
374  * @param int $pageid
375  * @param int $version
376  */
377 function wiki_get_wiki_page_version($pageid, $version) {
378     global $DB;
379     return $DB->get_record('wiki_versions', array('pageid' => $pageid, 'version' => $version));
382 /**
383  * Get version list
384  * @param int $pageid
385  * @param int $limitfrom
386  * @param int $limitnum
387  */
388 function wiki_get_wiki_page_versions($pageid, $limitfrom, $limitnum) {
389     global $DB;
390     return $DB->get_records('wiki_versions', array('pageid' => $pageid), 'version DESC', '*', $limitfrom, $limitnum);
393 /**
394  * Count the number of page version
395  * @param int $pageid
396  */
397 function wiki_count_wiki_page_versions($pageid) {
398     global $DB;
399     return $DB->count_records('wiki_versions', array('pageid' => $pageid));
402 /**
403  * Get linked from page
404  * @param int $pageid
405  */
406 function wiki_get_linked_to_pages($pageid) {
407     global $DB;
408     return $DB->get_records('wiki_links', array('frompageid' => $pageid));
411 /**
412  * Get linked from page
413  * @param int $pageid
414  */
415 function wiki_get_linked_from_pages($pageid) {
416     global $DB;
417     return $DB->get_records('wiki_links', array('topageid' => $pageid));
420 /**
421  * Get pages which user have been edited
422  * @param int $swid
423  * @param int $userid
424  */
425 function wiki_get_contributions($swid, $userid) {
426     global $DB;
428     $sql = "SELECT v.*
429             FROM {wiki_versions} v, {wiki_pages} p
430             WHERE p.subwikiid = ? AND
431             v.pageid = p.id AND
432             v.userid = ?";
434     return $DB->get_records_sql($sql, array($swid, $userid));
437 /**
438  * Get missing or empty pages in wiki
439  * @param int $swid sub wiki id
440  */
441 function wiki_get_missing_or_empty_pages($swid) {
442     global $DB;
444     $sql = "SELECT DISTINCT p.title, p.id, p.subwikiid
445             FROM {wiki} w, {wiki_subwikis} s, {wiki_pages} p
446             WHERE s.wikiid = w.id and
447             s.id = ? and
448             w.firstpagetitle != p.title and
449             p.subwikiid = ? and
450             1 =  (SELECT count(*)
451                 FROM {wiki_versions} v
452                 WHERE v.pageid = p.id)
453             UNION
454             SELECT DISTINCT l.tomissingpage as title, 0 as id, l.subwikiid
455             FROM {wiki_links} l
456             WHERE l.subwikiid = ? and
457             l.topageid = 0";
459     return $DB->get_records_sql($sql, array($swid, $swid, $swid));
462 /**
463  * Get pages list in wiki
464  * @param int $swid sub wiki id
465  */
466 function wiki_get_page_list($swid) {
467     global $DB;
468     $records = $DB->get_records('wiki_pages', array('subwikiid' => $swid), 'title ASC');
469     return $records;
472 /**
473  * Return a list of orphaned wikis for one specific subwiki
474  * @global object
475  * @param int $swid sub wiki id
476  */
477 function wiki_get_orphaned_pages($swid) {
478     global $DB;
480     $sql = "SELECT p.id, p.title
481             FROM {wiki_pages} p, {wiki} w , {wiki_subwikis} s
482             WHERE p.subwikiid = ?
483             AND s.id = ?
484             AND w.id = s.wikiid
485             AND p.title != w.firstpagetitle
486             AND p.id NOT IN (SELECT topageid FROM {wiki_links} WHERE subwikiid = ?);";
488     return $DB->get_records_sql($sql, array($swid, $swid, $swid));
491 /**
492  * Search wiki title
493  * @param int $swid sub wiki id
494  * @param string $search
495  */
496 function wiki_search_title($swid, $search) {
497     global $DB;
499     return $DB->get_records_select('wiki_pages', "subwikiid = ? AND title LIKE ?", array($swid, '%'.$search.'%'));
502 /**
503  * Search wiki content
504  * @param int $swid sub wiki id
505  * @param string $search
506  */
507 function wiki_search_content($swid, $search) {
508     global $DB;
510     return $DB->get_records_select('wiki_pages', "subwikiid = ? AND cachedcontent LIKE ?", array($swid, '%'.$search.'%'));
513 /**
514  * Search wiki title and content
515  * @param int $swid sub wiki id
516  * @param string $search
517  */
518 function wiki_search_all($swid, $search) {
519     global $DB;
521     return $DB->get_records_select('wiki_pages', "subwikiid = ? AND (cachedcontent LIKE ? OR title LIKE ?)", array($swid, '%'.$search.'%', '%'.$search.'%'));
524 /**
525  * Get user data
526  */
527 function wiki_get_user_info($userid) {
528     global $DB;
529     return $DB->get_record('user', array('id' => $userid));
532 /**
533  * Increase page view nubmer
534  * @param int $page, database record
535  */
536 function wiki_increment_pageviews($page) {
537     global $DB;
539     $page->pageviews++;
540     $DB->update_record('wiki_pages', $page);
543 //----------------------------------------------------------
544 //----------------------------------------------------------
546 /**
547  * Text format supported by wiki module
548  */
549 function wiki_get_formats() {
550     return array('html', 'creole', 'nwiki');
553 /**
554  * Parses a string with the wiki markup language in $markup.
555  *
556  * @return Array or false when something wrong has happened.
557  *
558  * Returned array contains the following fields:
559  *     'parsed_text' => String. Contains the parsed wiki content.
560  *     'unparsed_text' => String. Constains the original wiki content.
561  *     'link_count' => Array of array('destination' => ..., 'new' => "is new?"). Contains the internal wiki links found in the wiki content.
562  *      'deleted_sections' => the list of deleted sections.
563  *              '' =>
564  *
565  * @author Josep Arús Pous
566  **/
567 function wiki_parse_content($markup, $pagecontent, $options = array()) {
568     global $PAGE;
570     $subwiki = wiki_get_subwiki($options['swid']);
571     $cm = get_coursemodule_from_instance("wiki", $subwiki->wikiid);
572     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
574     $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']));
576     return wiki_parser_proxy::parse($pagecontent, $markup, $parser_options);
579 /**
580  * This function is the parser callback to parse wiki links.
581  *
582  * It returns the necesary information to print a link.
583  *
584  * NOTE: Empty pages and non-existent pages must be print in red color.
585  *
586  * @param link name of a page
587  * @param $options
588  *
589  * @return
590  *
591  * @TODO Doc return and options
592  */
593 function wiki_parser_link($link, $options = null) {
594     global $CFG;
596     if (is_object($link)) {
597         $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));
599         $version = wiki_get_current_version($link->id);
600         if ($version->version == 0) {
601             $parsedlink['new'] = true;
602         }
603         return $parsedlink;
604     } else {
605         $swid = $options['swid'];
607         if ($page = wiki_get_page_by_title($swid, $link)) {
608             $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));
610             $version = wiki_get_current_version($page->id);
611             if ($version->version == 0) {
612                 $parsedlink['new'] = true;
613             }
615             return $parsedlink;
617         } else {
618             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));
619         }
620     }
623 /**
624  * Returns the table fully parsed (HTML)
625  *
626  * @return HTML for the table $table
627  * @author Josep Arús Pous
628  *
629  **/
630 function wiki_parser_table($table) {
631     global $OUTPUT;
633     $htmltable = new html_table();
635     $headers = $table[0];
636     $htmltable->head = array();
637     foreach ($headers as $h) {
638         $htmltable->head[] = $h[1];
639     }
641     array_shift($table);
642     $htmltable->data = array();
643     foreach ($table as $row) {
644         $row_data = array();
645         foreach ($row as $r) {
646             $row_data[] = $r[1];
647         }
648         $htmltable->data[] = $row_data;
649     }
651     return html_writer::table($htmltable);
654 /**
655  * Returns an absolute path link, unless there is no such link.
656  *
657  * @param string url Link's URL
658  * @param stdClass context filearea params
659  * @param string filearea
660  * @param int fileareaid
661  *
662  * @return File full path
663  */
665 function wiki_parser_real_path($url, $context, $filearea, $fileareaid) {
666     global $CFG;
668     if (preg_match("/^(?:http|ftp)s?\:\/\//", $url)) {
669         return $url;
670     } else {
671         return "{$CFG->wwwroot}/pluginfile.php/{$context->id}/$filearea/$fileareaid/$url";
672     }
675 /**
676  * Returns the token used by a wiki language to represent a given tag or "object" (bold -> **)
677  *
678  * @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.
679  * @author Josep Arús Pous
680  **/
681 function wiki_parser_get_token($markup, $name) {
683     return wiki_parser_proxy::get_token($name, $markup);
686 /**
687  * Checks if current user can view a subwiki
688  *
689  * @param $subwiki
690  */
691 function wiki_user_can_view($subwiki) {
692     global $USER;
694     $wiki = wiki_get_wiki($subwiki->wikiid);
695     $cm = get_coursemodule_from_instance('wiki', $wiki->id);
696     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
698     // Working depending on activity groupmode
699     switch (groups_get_activity_groupmode($cm)) {
700     case NOGROUPS:
702         if ($wiki->wikimode == 'collaborative') {
703             // Collaborative Mode:
704             // There is one wiki for all the class.
705             //
706             // Only view capbility needed
707             return has_capability('mod/wiki:viewpage', $context, $USER);
708         } else if ($wiki->wikimode == 'individual') {
709             // Individual Mode:
710             // Each person owns a wiki.
711             if ($subwiki->userid == $USER->id) {
712                 // Only the owner of the wiki can view it
713                 return has_capability('mod/wiki:viewpage', $context, $USER);
714             } else { // User has special capabilities
715                 // User must have:
716                 //      mod/wiki:viewpage capability
717                 // and
718                 //      mod/wiki:managewiki capability
719                 $view = has_capability('mod/wiki:viewpage', $context, $USER);
720                 $manage = has_capability('mod/wiki:managewiki', $context, $USER);
722                 return $view && $manage;
723             }
724         } else {
725             //Error
726             return false;
727         }
728     case SEPARATEGROUPS:
729         // Collaborative and Individual Mode
730         //
731         // Collaborative Mode:
732         //      There is one wiki per group.
733         // Individual Mode:
734         //      Each person owns a wiki.
735         if ($wiki->wikimode == 'collaborative' || $wiki->wikimode == 'individual') {
736             // Only members of subwiki group could view that wiki
737             if ($subwiki->groupid == groups_get_activity_group($cm)) {
738                 // Only view capability needed
739                 return has_capability('mod/wiki:viewpage', $context, $USER);
741             } else { // User is not part of that group
742                 // User must have:
743                 //      mod/wiki:managewiki capability
744                 // or
745                 //      moodle/site:accessallgroups capability
746                 // and
747                 //      mod/wiki:viewpage capability
748                 $view = has_capability('mod/wiki:viewpage', $context, $USER);
749                 $manage = has_capability('mod/wiki:managewiki', $context, $USER);
750                 $access = has_capability('moodle/site:accessallgroups', $context, $USER);
751                 return ($manage || $access) && $view;
752             }
753         } else {
754             //Error
755             return false;
756         }
757     case VISIBLEGROUPS:
758         // Collaborative and Individual Mode
759         //
760         // Collaborative Mode:
761         //      There is one wiki per group.
762         // Individual Mode:
763         //      Each person owns a wiki.
764         if ($wiki->wikimode == 'collaborative' || $wiki->wikimode == 'individual') {
765             // Everybody can read all wikis
766             //
767             // Only view capability needed
768             return has_capability('mod/wiki:viewpage', $context, $USER);
769         } else {
770             //Error
771             return false;
772         }
773     default: // Error
774         return false;
775     }
778 /**
779  * Checks if current user can edit a subwiki
780  *
781  * @param $subwiki
782  */
783 function wiki_user_can_edit($subwiki) {
784     global $USER;
786     $wiki = wiki_get_wiki($subwiki->wikiid);
787     $cm = get_coursemodule_from_instance('wiki', $wiki->id);
788     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
790     // Working depending on activity groupmode
791     switch (groups_get_activity_groupmode($cm)) {
792     case NOGROUPS:
794         if ($wiki->wikimode == 'collaborative') {
795             // Collaborative Mode:
796             // There is a wiki for all the class.
797             //
798             // Only edit capbility needed
799             return has_capability('mod/wiki:editpage', $context, $USER);
800         } else if ($wiki->wikimode == 'individual') {
801             // Individual Mode
802             // There is a wiki per user
804             // Only the owner of that wiki can edit it
805             if ($subwiki->userid == $USER->id) {
806                 return has_capability('mod/wiki:editpage', $context, $USER);
807             } else { // Current user is not the owner of that wiki.
809                 // User must have:
810                 //      mod/wiki:editpage capability
811                 // and
812                 //      mod/wiki:managewiki capability
813                 $edit = has_capability('mod/wiki:editpage', $context, $USER);
814                 $manage = has_capability('mod/wiki:managewiki', $context, $USER);
816                 return $edit && $manage;
817             }
818         } else {
819             //Error
820             return false;
821         }
822     case SEPARATEGROUPS:
823         if ($wiki->wikimode == 'collaborative') {
824             // Collaborative Mode:
825             // There is one wiki per group.
826             //
827             // Only members of subwiki group could edit that wiki
828             if ($subwiki->groupid == groups_get_activity_group($cm)) {
829                 // Only edit capability needed
830                 return has_capability('mod/wiki:editpage', $context, $USER);
831             } else { // User is not part of that group
832                 // User must have:
833                 //      mod/wiki:managewiki capability
834                 // and
835                 //      moodle/site:accessallgroups capability
836                 // and
837                 //      mod/wiki:editpage capability
838                 $manage = has_capability('mod/wiki:managewiki', $context, $USER);
839                 $access = has_capability('moodle/site:accessallgroups', $context, $USER);
840                 $edit = has_capability('mod/wiki:editpage', $context, $USER);
841                 return $manage && $access && $edit;
842             }
843         } else if ($wiki->wikimode == 'individual') {
844             // Individual Mode:
845             // Each person owns a wiki.
846             //
847             // Only the owner of that wiki can edit it
848             if ($subwiki->userid == $USER->id) {
849                 return has_capability('mod/wiki:editpage', $context, $USER);
850             } else { // Current user is not the owner of that wiki.
851                 // User must have:
852                 //      mod/wiki:managewiki capability
853                 // and
854                 //      moodle/site:accessallgroups capability
855                 // and
856                 //      mod/wiki:editpage capability
857                 $manage = has_capability('mod/wiki:managewiki', $context, $USER);
858                 $access = has_capability('moodle/site:accessallgroups', $context, $USER);
859                 $edit = has_capability('mod/wiki:editpage', $context, $USER);
860                 return $manage && $access && $edit;
861             }
862         } else {
863             //Error
864             return false;
865         }
866     case VISIBLEGROUPS:
867         if ($wiki->wikimode == 'collaborative') {
868             // Collaborative Mode:
869             // There is one wiki per group.
870             //
871             // Only members of subwiki group could edit that wiki
872             if ($subwiki->groupid == groups_get_activity_group($cm)) {
873                 // Only edit capability needed
874                 return has_capability('mod/wiki:editpage', $context, $USER);
875             } else { // User is not part of that group
876                 // User must have:
877                 //      mod/wiki:managewiki capability
878                 // and
879                 //      mod/wiki:editpage capability
880                 $manage = has_capability('mod/wiki:managewiki', $context, $USER);
881                 $edit = has_capability('mod/wiki:editpage', $context, $USER);
882                 return $manage && $edit;
883             }
884         } else if ($wiki->wikimode == 'individual') {
885             // Individual Mode:
886             // Each person owns a wiki.
887             //
888             // Only the owner of that wiki can edit it
889             if ($subwiki->userid == $USER->id) {
890                 return has_capability('mod/wiki:editpage', $context, $USER);
891             } else { // Current user is not the owner of that wiki.
892                 // User must have:
893                 //      mod/wiki:managewiki capability
894                 // and
895                 //      mod/wiki:editpage capability
896                 $manage = has_capability('mod/wiki:managewiki', $context, $USER);
897                 $edit = has_capability('mod/wiki:editpage', $context, $USER);
898                 return $manage && $edit;
899             }
900         } else {
901             //Error
902             return false;
903         }
904     default: // Error
905         return false;
906     }
909 //----------------
910 // Locks
911 //----------------
913 /**
914  * Checks if a page-section is locked.
915  *
916  * @return true if the combination of section and page is locked, FALSE otherwise.
917  */
918 function wiki_is_page_section_locked($pageid, $userid, $section = null) {
919     global $DB;
921     $sql = "pageid = ? AND lockedat > ? AND userid != ?";
922     $params = array($pageid, time(), $userid);
924     if (!empty($section)) {
925         $sql .= " AND (sectionname = ? OR sectionname IS null)";
926         $params[] = $section;
927     }
929     return $DB->record_exists_select('wiki_locks', $sql, $params);
932 /**
933  * Inserts or updates a wiki_locks record.
934  */
935 function wiki_set_lock($pageid, $userid, $section = null, $insert = false) {
936     global $DB;
938     if (wiki_is_page_section_locked($pageid, $userid, $section)) {
939         return false;
940     }
942     $params = array('pageid' => $pageid, 'userid' => $userid, 'sectionname' => $section);
944     $lock = $DB->get_record('wiki_locks', $params);
946     if (!empty($lock)) {
947         $DB->update_record('wiki_locks', array('id' => $lock->id, 'lockedat' => time() + LOCK_TIMEOUT));
948     } else if ($insert) {
949         $DB->insert_record('wiki_locks', array('pageid' => $pageid, 'sectionname' => $section, 'userid' => $userid, 'lockedat' => time() + 30));
950     }
952     return true;
955 /**
956  * 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.
957  */
958 function wiki_delete_locks($pageid, $userid = null, $section = null, $delete_from_db = true, $delete_section_and_page = false) {
959     global $DB;
961     $params = array('pageid' => $pageid);
963     if (!empty($userid)) {
964         $params['userid'] = $userid;
965     }
967     if (!empty($section)) {
968         $params['sectionname'] = $section;
969     }
971     if ($delete_from_db) {
972         $DB->delete_records('wiki_locks', $params);
973         if ($delete_section_and_page && !empty($section)) {
974             $params['sectionname'] = null;
975             $DB->delete_records('wiki_locks', $params);
976         }
977     } else {
978         $DB->set_field('wiki_locks', 'lockedat', time(), $params);
979     }
982 /**
983  * Deletes wiki_locks that expired 1 hour ago.
984  */
985 function wiki_delete_old_locks() {
986     global $DB;
988     $DB->delete_records_select('wiki_locks', "lockedat < ?", array(time() - 3600));
991 /**
992  * File processing
993  */
995 /**
996  * Uploads files to permanent disk space.
997  *
998  * @param int draftitemid Draft space ID
999  * @param int contextid
1000  *
1001  * @return array of files that have not been inserted.
1002  */
1004 function wiki_process_attachments($draftitemid, $deleteuploads, $contextid, $filearea, $itemid, $options = null) {
1005     global $CFG, $USER;
1007     if (empty($options)) {
1008         $options = page_wiki_edit::$attachmentoptions;
1009     }
1011     $errors = array();
1013     $usercontext = get_context_instance(CONTEXT_USER, $USER->id);
1014     $fs = get_file_storage();
1016     $oldfiles = $fs->get_area_files($contextid, 'mod_wiki', 'attachments', $itemid, 'id');
1018     foreach ($oldfiles as $file) {
1019         if (in_array($file->get_pathnamehash(), $deleteuploads)) {
1020             $file->delete();
1021         }
1022     }
1024     $draftfiles = $fs->get_area_files($usercontext->id, 'user', 'draft', $draftitemid, 'id');
1025     $oldfiles = $fs->get_area_files($contextid, 'mod_wiki', 'attachments', $itemid, 'id');
1027     $file_record = array('contextid' => $contextid, 'component' => 'mod_wiki', 'filearea' => 'attachments', 'itemid' => $itemid);
1028     //more or less a merge...
1029     $newhashes = array();
1030     foreach ($draftfiles as $file) {
1031         $newhash = sha1("/$contextid/mod_wiki/attachments/$itemid" . $file->get_filepath() . $file->get_filename());
1032         $newhashes[$newhash] = $file;
1033     }
1035     $filecount = 0;
1036     foreach ($oldfiles as $file) {
1037         $oldhash = $file->get_pathnamehash();
1038         if (!$file->is_directory() && isset($newhashes[$oldhash])) {
1039             //repeated file: ERROR!!!
1040             unset($newhashes[$oldhash]);
1041             $errors[] = $file;
1042         }
1044         if (!$file->is_directory()) {
1045             $filecount++;
1046         }
1047     }
1049     foreach ($newhashes as $file) {
1050         if ($file->get_filepath() !== '/' or $file->is_directory()) {
1051             continue;
1052         }
1054         if ($options['maxfiles'] and $options['maxfiles'] <= $filecount) {
1055             break;
1056         }
1058         if (!$file->is_directory()) {
1059             $filecount++;
1060             $fs->create_file_from_storedfile($file_record, $file);
1061         }
1062     }
1064     //delete all draft files
1065     $fs->delete_area_files($usercontext->id, 'user', 'draft', $draftitemid);
1067     return $errors;
1070 function wiki_get_comment($commentid){
1071     global $DB;
1072     return $DB->get_record('comments', array('id' => $commentid));
1075 /**
1076  * Returns all comments by context and pageid
1077  *
1078  * @param $context. Current context
1079  * @param $pageid. Current pageid
1080  **/
1081 function wiki_get_comments($contextid, $pageid) {
1082     global $DB;
1084     return $DB->get_records('comments', array('contextid' => $contextid, 'itemid' => $pageid, 'commentarea' => 'wiki_page'));
1087 /**
1088  * Add comments ro database
1089  *
1090  * @param object $context. Current context
1091  * @param int $pageid. Current pageid
1092  * @param string $content. Content of the comment
1093  * @param string editor. Version of editor we are using.
1094  **/
1095 function wiki_add_comment($context, $pageid, $content, $editor) {
1096     global $CFG;
1097     require_once($CFG->dirroot . '/comment/lib.php');
1099     list($context, $course, $cm) = get_context_info_array($context->id);
1100     $cmt = new stdclass();
1101     $cmt->context = $context;
1102     $cmt->itemid = $pageid;
1103     $cmt->area = 'wiki_page';
1104     $cmt->course = $course;
1105     $cmt->component = 'mod_wiki';
1107     $manager = new comment($cmt);
1109     if ($editor == 'creole') {
1110         $manager->add($content, FORMAT_CREOLE);
1111     } else if ($editor == 'html') {
1112         $manager->add($content, FORMAT_HTML);
1113     } else if ($editor == 'nwiki') {
1114         $manager->add($content, FORMAT_NWIKI);
1115     }
1119 /**
1120  * Delete comments from database
1121  *
1122  * @param $idcomment. Id of comment which will be deleted
1123  * @param $context. Current context
1124  * @param $pageid. Current pageid
1125  **/
1126 function wiki_delete_comment($idcomment, $context, $pageid) {
1127     global $CFG;
1128     require_once($CFG->dirroot . '/comment/lib.php');
1130     list($context, $course, $cm) = get_context_info_array($context->id);
1131     $cmt = new stdClass();
1132     $cmt->context = $context;
1133     $cmt->itemid = $pageid;
1134     $cmt->area = 'wiki_page';
1135     $cmt->course = $course;
1136     $cmt->component = 'mod_wiki';
1138     $manager = new comment($cmt);
1139     $manager->delete($idcomment);
1143 /**
1144  * Delete al comments from wiki
1145  *
1146  **/
1147 function wiki_delete_comments_wiki() {
1148     global $PAGE, $DB;
1150     $cm = $PAGE->cm;
1151     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1153     $table = 'comments';
1154     $select = 'contextid = ?';
1156     $DB->delete_records_select($table, $select, array($context->id));
1160 function wiki_add_progress($pageid, $oldversionid, $versionid, $progress) {
1161     global $DB;
1162     for ($v = $oldversionid + 1; $v <= $versionid; $v++) {
1163         $user = wiki_get_wiki_page_id($pageid, $v);
1165         $DB->insert_record('wiki_progress', array('userid' => $user->userid, 'pageid' => $pageid, 'versionid' => $v, 'progress' => $progress));
1166     }
1169 function wiki_get_wiki_page_id($pageid, $id) {
1170     global $DB;
1171     return $DB->get_record('wiki_versions', array('pageid' => $pageid, 'id' => $id));
1174 function wiki_print_page_content($page, $context, $subwikiid) {
1175     global $OUTPUT, $CFG;
1177     if ($page->timerendered + WIKI_REFRESH_CACHE_TIME < time()) {
1178         $content = wiki_refresh_cachedcontent($page);
1179         $page = $content['page'];
1180     }
1182     if (isset($content)) {
1183         $box = '';
1184         foreach ($content['sections'] as $s) {
1185             $box .= '<p>' . get_string('repeatedsection', 'wiki', $s) . '</p>';
1186         }
1188         if (!empty($box)) {
1189             echo $OUTPUT->box($box);
1190         }
1191     }
1192     $html = file_rewrite_pluginfile_urls($page->cachedcontent, 'pluginfile.php', $context->id, 'mod_wiki', 'attachments', $subwikiid);
1193     $html = format_text($html);
1194     echo $OUTPUT->box($html);
1196     if (!empty($CFG->usetags)) {
1197         $tags = tag_get_tags_array('wiki_page', $page->id);
1198         echo '<p class="wiki-tags"><span>Tags: </span>' . join($tags, ", ") . '</p>';
1199     }
1201     wiki_increment_pageviews($page);
1204 /**
1205  * This function trims any given text and returns it with some dots at the end
1206  *
1207  * @param string $text
1208  * @param string $limit
1209  *
1210  * @return string
1211  */
1212 function wiki_trim_string($text, $limit = 25) {
1214     if (strlen($text) > $limit) {
1215         $text = substr($text, 0, $limit) . '...';
1216     }
1218     return $text;
1221 /**
1222  * Prints default edit form fields and buttons
1223  *
1224  * @param string $format Edit form format (html, creole...)
1225  * @param integer $version Version number. A negative number means no versioning.
1226  */
1228 function wiki_print_edit_form_default_fields($format, $pageid, $version = -1, $upload = false, $deleteuploads = array()) {
1229     global $CFG, $PAGE, $OUTPUT;
1231     echo '<input type="hidden" name="sesskey" value="' . sesskey() . '" />';
1233     if ($version >= 0) {
1234         echo '<input type="hidden" name="version" value="' . $version . '" />';
1235     }
1237     echo '<input type="hidden" name="format" value="' . $format . '"/>';
1239     //attachments
1240     require_once($CFG->dirroot . '/lib/form/filemanager.php');
1242     $filemanager = new MoodleQuickForm_filemanager('attachments', get_string('wikiattachments', 'wiki'), array('id' => 'attachments'), array('subdirs' => false, 'maxfiles' => 99, 'maxbytes' => $CFG->maxbytes));
1244     $value = file_get_submitted_draft_itemid('attachments');
1245     if (!empty($value) && !$upload) {
1246         $filemanager->setValue($value);
1247     }
1249     echo "<fieldset class=\"wiki-upload-section clearfix\"><legend class=\"ftoggler\">" . get_string("uploadtitle", 'wiki') . "</legend>";
1251     echo $OUTPUT->container_start('mdl-align wiki-form-center aaaaa');
1252     print $filemanager->toHtml();
1253     echo $OUTPUT->container_end();
1255     $cm = $PAGE->cm;
1256     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1258     echo $OUTPUT->container_start('mdl-align wiki-form-center wiki-upload-table');
1259     wiki_print_upload_table($context, 'wiki_upload', $pageid, $deleteuploads);
1260     echo $OUTPUT->container_end();
1262     echo "</fieldset>";
1264     echo '<input class="wiki_button" type="submit" name="editoption" value="' . get_string('save', 'wiki') . '"/>';
1265     echo '<input class="wiki_button" type="submit" name="editoption" value="' . get_string('upload', 'wiki') . '"/>';
1266     echo '<input class="wiki_button" type="submit" name="editoption" value="' . get_string('preview') . '"/>';
1267     echo '<input class="wiki_button" type="submit" name="editoption" value="' . get_string('cancel') . '" />';
1270 /**
1271  * Prints a table with the files attached to a wiki page
1272  * @param object $context
1273  * @param string $filearea
1274  * @param int $fileitemid
1275  * @param array deleteuploads
1276  */
1277 function wiki_print_upload_table($context, $filearea, $fileitemid, $deleteuploads = array()) {
1278     global $CFG, $OUTPUT;
1280     $htmltable = new html_table();
1282     $htmltable->head = array(get_string('deleteupload', 'wiki'), get_string('uploadname', 'wiki'), get_string('uploadactions', 'wiki'));
1284     $fs = get_file_storage();
1285     $files = $fs->get_area_files($context->id, 'mod_wiki', $filearea, $fileitemid); //TODO: this is weird (skodak)
1287     foreach ($files as $file) {
1288         if (!$file->is_directory()) {
1289             $checkbox = '<input type="checkbox" name="deleteupload[]", value="' . $file->get_pathnamehash() . '"';
1291             if (in_array($file->get_pathnamehash(), $deleteuploads)) {
1292                 $checkbox .= ' checked="checked"';
1293             }
1295             $checkbox .= " />";
1297             $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>', "");
1298         }
1299     }
1301     print '<h3 class="upload-table-title">' . get_string('uploadfiletitle', 'wiki') . "</h3>";
1302     print html_writer::table($htmltable);
1305 /**
1306  * Generate wiki's page tree
1307  *
1308  * @param $page. A wiki page object
1309  * @param $node. Starting navigation_node
1310  * @param $keys. An array to store keys
1311  * @return an array with all tree nodes
1312  */
1313 function wiki_build_tree($page, $node, &$keys) {
1314     $content = array();
1315     static $icon;
1316     $icon = new pix_icon('f/odt', '');
1317     $pages = wiki_get_linked_pages($page->id);
1318     foreach ($pages as $p) {
1319         $key = $page->id . ':' . $p->id;
1320         if (in_array($key, $keys)) {
1321             break;
1322         }
1323         array_push($keys, $key);
1324         $l = wiki_parser_link($p);
1325         $link = new moodle_url('/mod/wiki/view.php', array('pageid' => $p->id));
1326         $nodeaux = $node->add($p->title, $link, null, null, null, $icon);
1327         if ($l['new']) {
1328             $nodeaux->add_class('wiki_newentry');
1329         }
1330         wiki_build_tree($p, $nodeaux, $keys);
1331     }
1332     $content[] = $node;
1333     return $content;
1336 /**
1337  * Get linked pages from page
1338  * @param int $pageid
1339  */
1340 function wiki_get_linked_pages($pageid) {
1341     global $DB;
1343     $sql = "SELECT p.id, p.title
1344             FROM mdl_wiki_pages p
1345             JOIN mdl_wiki_links l ON l.topageid = p.id
1346             WHERE l.frompageid = ?
1347             ORDER BY p.title ASC";
1348     return $DB->get_records_sql($sql, array($pageid));
1351 /**
1352  * Get updated pages from wiki
1353  * @param int $pageid
1354  */
1355 function wiki_get_updated_pages_by_subwiki($swid) {
1356     global $DB, $USER;
1358     $sql = "SELECT *
1359             FROM {wiki_pages}
1360             WHERE subwikiid = ? AND timemodified > ?
1361             ORDER BY timemodified DESC";
1362     return $DB->get_records_sql($sql, array($swid, $USER->lastlogin));