2ff2741b5ecc0b75eaae909181d21b90bb0b6e55
[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     return array_pop($DB->get_records_sql($sql, array($pageid), 0, 1));
151 /**
152  * Alias of wiki_get_current_version
153  * @TODO, does the exactly same thing as wiki_get_current_version, should be removed
154  * @param int $pageid
155  * @return object
156  */
157 function wiki_get_last_version($pageid) {
158     return wiki_get_current_version($pageid);
161 /**
162  * Get page section
163  * @param int $pageid
164  * @param string $section
165  */
166 function wiki_get_section_page($page, $section) {
168     $version = wiki_get_current_version($page->id);
169     return wiki_parser_proxy::get_section($version->content, $version->contentformat, $section);
172 /**
173  * Get a wiki page by page title
174  * @param int $swid, sub wiki id
175  * @param string $title
176  * @return object
177  */
178 function wiki_get_page_by_title($swid, $title) {
179     global $DB;
180     return $DB->get_record('wiki_pages', array('subwikiid' => $swid, 'title' => $title));
183 /**
184  * Get a version record by record id
185  * @param int $versionid, the version id
186  * @return object
187  */
188 function wiki_get_version($versionid) {
189     global $DB;
190     return $DB->get_record('wiki_versions', array('id' => $versionid));
193 /**
194  * Get first page of wiki instace
195  * @param int $subwikiid
196  * @param int $module, wiki instance object
197  */
198 function wiki_get_first_page($subwikid, $module = null) {
199     global $DB, $USER;
201     $sql = "SELECT p.*
202             FROM {wiki} w, {wiki_subwikis} s, {wiki_pages} p
203             WHERE s.id = ? AND
204             s.wikiid = w.id AND
205             w.firstpagetitle = p.title AND
206             p.subwikiid = s.id";
207     return $DB->get_record_sql($sql, array($subwikid));
210 function wiki_save_section($wikipage, $sectiontitle, $sectioncontent, $userid) {
212     $wiki = wiki_get_wiki_from_pageid($wikipage->id);
213     $cm = get_coursemodule_from_instance('wiki', $wiki->id);
214     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
216     if (has_capability('mod/wiki:editpage', $context)) {
217         $version = wiki_get_current_version($wikipage->id);
218         $content = wiki_parser_proxy::get_section($version->content, $version->contentformat, $sectiontitle, true);
220         $newcontent = $content[0] . $sectioncontent . $content[2];
222         return wiki_save_page($wikipage, $newcontent, $userid);
223     } else {
224         return false;
225     }
228 /**
229  * Save page content
230  * @param object $wikipage
231  * @param string $newcontent
232  * @param int $userid
233  */
234 function wiki_save_page($wikipage, $newcontent, $userid) {
235     global $DB;
237     $wiki = wiki_get_wiki_from_pageid($wikipage->id);
238     $cm = get_coursemodule_from_instance('wiki', $wiki->id);
239     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
241     if (has_capability('mod/wiki:editpage', $context)) {
242         $version = wiki_get_current_version($wikipage->id);
244         $version->content = $newcontent;
245         $version->userid = $userid;
246         $version->version++;
247         $version->timecreated = time();
248         $versionid = $DB->insert_record('wiki_versions', $version);
250         $wikipage->timemodified = $version->timecreated;
251         $wikipage->userid = $userid;
252         $return = wiki_refresh_cachedcontent($wikipage, $newcontent);
254         return $return;
255     } else {
256         return false;
257     }
260 function wiki_refresh_cachedcontent($page, $newcontent = null) {
261     global $DB;
263     $version = wiki_get_current_version($page->id);
264     if (empty($version)) {
265         return null;
266     }
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         try {
306             $DB->insert_record('wiki_links', $newlink);
307         } catch (dml_exception $e) {
308             debugging($e->getMessage());
309         }
311     }
314 /**
315  * Create a new wiki page, if the page exists, return existing pageid
316  * @param int $swid
317  * @param string $title
318  * @param string $format
319  * @param int $userid
320  */
321 function wiki_create_page($swid, $title, $format, $userid) {
322     global $DB, $PAGE;
323     $subwiki = wiki_get_subwiki($swid);
324     $cm = get_coursemodule_from_instance('wiki', $subwiki->wikiid);
325     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
326     require_capability('mod/wiki:editpage', $context);
327     // if page exists
328     if ($page = wiki_get_page_by_title($swid, $title)) {
329         return $page->id;
330     }
332     // Creating a new empty version
333     $version = new stdClass();
334     $version->content = '';
335     $version->contentformat = $format;
336     $version->version = 0;
337     $version->timecreated = time();
338     $version->userid = $userid;
340     $versionid = null;
341     $versionid = $DB->insert_record('wiki_versions', $version);
343     // Createing a new empty page
344     $page = new stdClass();
345     $page->subwikiid = $swid;
346     $page->title = $title;
347     $page->cachedcontent = '';
348     $page->timecreated = $version->timecreated;
349     $page->timemodified = $version->timecreated;
350     $page->timerendered = $version->timecreated;
351     $page->userid = $userid;
352     $page->pageviews = 0;
353     $page->readonly = 0;
355     $pageid = $DB->insert_record('wiki_pages', $page);
357     // Setting the pageid
358     $version->id = $versionid;
359     $version->pageid = $pageid;
360     $DB->update_record('wiki_versions', $version);
362     wiki_make_cache_expire($page->title);
363     return $pageid;
366 function wiki_make_cache_expire($pagename) {
367     global $DB;
369     $sql = "UPDATE {wiki_pages}
370             SET timerendered = 0
371             WHERE id IN ( SELECT l.frompageid
372                 FROM {wiki_links} l
373                 WHERE l.tomissingpage = ?
374             )";
375     $DB->execute ($sql, array($pagename));
378 /**
379  * Get a specific version of page
380  * @param int $pageid
381  * @param int $version
382  */
383 function wiki_get_wiki_page_version($pageid, $version) {
384     global $DB;
385     return $DB->get_record('wiki_versions', array('pageid' => $pageid, 'version' => $version));
388 /**
389  * Get version list
390  * @param int $pageid
391  * @param int $limitfrom
392  * @param int $limitnum
393  */
394 function wiki_get_wiki_page_versions($pageid, $limitfrom, $limitnum) {
395     global $DB;
396     return $DB->get_records('wiki_versions', array('pageid' => $pageid), 'version DESC', '*', $limitfrom, $limitnum);
399 /**
400  * Count the number of page version
401  * @param int $pageid
402  */
403 function wiki_count_wiki_page_versions($pageid) {
404     global $DB;
405     return $DB->count_records('wiki_versions', array('pageid' => $pageid));
408 /**
409  * Get linked from page
410  * @param int $pageid
411  */
412 function wiki_get_linked_to_pages($pageid) {
413     global $DB;
414     return $DB->get_records('wiki_links', array('frompageid' => $pageid));
417 /**
418  * Get linked from page
419  * @param int $pageid
420  */
421 function wiki_get_linked_from_pages($pageid) {
422     global $DB;
423     return $DB->get_records('wiki_links', array('topageid' => $pageid));
426 /**
427  * Get pages which user have been edited
428  * @param int $swid
429  * @param int $userid
430  */
431 function wiki_get_contributions($swid, $userid) {
432     global $DB;
434     $sql = "SELECT v.*
435             FROM {wiki_versions} v, {wiki_pages} p
436             WHERE p.subwikiid = ? AND
437             v.pageid = p.id AND
438             v.userid = ?";
440     return $DB->get_records_sql($sql, array($swid, $userid));
443 /**
444  * Get missing or empty pages in wiki
445  * @param int $swid sub wiki id
446  */
447 function wiki_get_missing_or_empty_pages($swid) {
448     global $DB;
450     $sql = "SELECT DISTINCT p.title, p.id, p.subwikiid
451             FROM {wiki} w, {wiki_subwikis} s, {wiki_pages} p
452             WHERE s.wikiid = w.id and
453             s.id = ? and
454             w.firstpagetitle != p.title and
455             p.subwikiid = ? and
456             1 =  (SELECT count(*)
457                 FROM {wiki_versions} v
458                 WHERE v.pageid = p.id)
459             UNION
460             SELECT DISTINCT l.tomissingpage as title, 0 as id, l.subwikiid
461             FROM {wiki_links} l
462             WHERE l.subwikiid = ? and
463             l.topageid = 0";
465     return $DB->get_records_sql($sql, array($swid, $swid, $swid));
468 /**
469  * Get pages list in wiki
470  * @param int $swid sub wiki id
471  */
472 function wiki_get_page_list($swid) {
473     global $DB;
474     $records = $DB->get_records('wiki_pages', array('subwikiid' => $swid), 'title ASC');
475     return $records;
478 /**
479  * Return a list of orphaned wikis for one specific subwiki
480  * @global object
481  * @param int $swid sub wiki id
482  */
483 function wiki_get_orphaned_pages($swid) {
484     global $DB;
486     $sql = "SELECT p.id, p.title
487             FROM {wiki_pages} p, {wiki} w , {wiki_subwikis} s
488             WHERE p.subwikiid = ?
489             AND s.id = ?
490             AND w.id = s.wikiid
491             AND p.title != w.firstpagetitle
492             AND p.id NOT IN (SELECT topageid FROM {wiki_links} WHERE subwikiid = ?);";
494     return $DB->get_records_sql($sql, array($swid, $swid, $swid));
497 /**
498  * Search wiki title
499  * @param int $swid sub wiki id
500  * @param string $search
501  */
502 function wiki_search_title($swid, $search) {
503     global $DB;
505     return $DB->get_records_select('wiki_pages', "subwikiid = ? AND title LIKE ?", array($swid, '%'.$search.'%'));
508 /**
509  * Search wiki content
510  * @param int $swid sub wiki id
511  * @param string $search
512  */
513 function wiki_search_content($swid, $search) {
514     global $DB;
516     return $DB->get_records_select('wiki_pages', "subwikiid = ? AND cachedcontent LIKE ?", array($swid, '%'.$search.'%'));
519 /**
520  * Search wiki title and content
521  * @param int $swid sub wiki id
522  * @param string $search
523  */
524 function wiki_search_all($swid, $search) {
525     global $DB;
527     return $DB->get_records_select('wiki_pages', "subwikiid = ? AND (cachedcontent LIKE ? OR title LIKE ?)", array($swid, '%'.$search.'%', '%'.$search.'%'));
530 /**
531  * Get user data
532  */
533 function wiki_get_user_info($userid) {
534     global $DB;
535     return $DB->get_record('user', array('id' => $userid));
538 /**
539  * Increase page view nubmer
540  * @param int $page, database record
541  */
542 function wiki_increment_pageviews($page) {
543     global $DB;
545     $page->pageviews++;
546     $DB->update_record('wiki_pages', $page);
549 //----------------------------------------------------------
550 //----------------------------------------------------------
552 /**
553  * Text format supported by wiki module
554  */
555 function wiki_get_formats() {
556     return array('html', 'creole', 'nwiki');
559 /**
560  * Parses a string with the wiki markup language in $markup.
561  *
562  * @return Array or false when something wrong has happened.
563  *
564  * Returned array contains the following fields:
565  *     'parsed_text' => String. Contains the parsed wiki content.
566  *     'unparsed_text' => String. Constains the original wiki content.
567  *     'link_count' => Array of array('destination' => ..., 'new' => "is new?"). Contains the internal wiki links found in the wiki content.
568  *      'deleted_sections' => the list of deleted sections.
569  *              '' =>
570  *
571  * @author Josep Arús Pous
572  **/
573 function wiki_parse_content($markup, $pagecontent, $options = array()) {
574     global $PAGE;
576     $subwiki = wiki_get_subwiki($options['swid']);
577     $cm = get_coursemodule_from_instance("wiki", $subwiki->wikiid);
578     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
580     $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']));
582     return wiki_parser_proxy::parse($pagecontent, $markup, $parser_options);
585 /**
586  * This function is the parser callback to parse wiki links.
587  *
588  * It returns the necesary information to print a link.
589  *
590  * NOTE: Empty pages and non-existent pages must be print in red color.
591  *
592  * @param link name of a page
593  * @param $options
594  *
595  * @return
596  *
597  * @TODO Doc return and options
598  */
599 function wiki_parser_link($link, $options = null) {
600     global $CFG;
602     if (is_object($link)) {
603         $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));
605         $version = wiki_get_current_version($link->id);
606         if ($version->version == 0) {
607             $parsedlink['new'] = true;
608         }
609         return $parsedlink;
610     } else {
611         $swid = $options['swid'];
613         if ($page = wiki_get_page_by_title($swid, $link)) {
614             $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));
616             $version = wiki_get_current_version($page->id);
617             if ($version->version == 0) {
618                 $parsedlink['new'] = true;
619             }
621             return $parsedlink;
623         } else {
624             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));
625         }
626     }
629 /**
630  * Returns the table fully parsed (HTML)
631  *
632  * @return HTML for the table $table
633  * @author Josep Arús Pous
634  *
635  **/
636 function wiki_parser_table($table) {
637     global $OUTPUT;
639     $htmltable = new html_table();
641     $headers = $table[0];
642     $htmltable->head = array();
643     foreach ($headers as $h) {
644         $htmltable->head[] = $h[1];
645     }
647     array_shift($table);
648     $htmltable->data = array();
649     foreach ($table as $row) {
650         $row_data = array();
651         foreach ($row as $r) {
652             $row_data[] = $r[1];
653         }
654         $htmltable->data[] = $row_data;
655     }
657     return html_writer::table($htmltable);
660 /**
661  * Returns an absolute path link, unless there is no such link.
662  *
663  * @param string url Link's URL
664  * @param stdClass context filearea params
665  * @param string filearea
666  * @param int fileareaid
667  *
668  * @return File full path
669  */
671 function wiki_parser_real_path($url, $context, $filearea, $fileareaid) {
672     global $CFG;
674     if (preg_match("/^(?:http|ftp)s?\:\/\//", $url)) {
675         return $url;
676     } else {
677         return "{$CFG->wwwroot}/pluginfile.php/{$context->id}/$filearea/$fileareaid/$url";
678     }
681 /**
682  * Returns the token used by a wiki language to represent a given tag or "object" (bold -> **)
683  *
684  * @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.
685  * @author Josep Arús Pous
686  **/
687 function wiki_parser_get_token($markup, $name) {
689     return wiki_parser_proxy::get_token($name, $markup);
692 /**
693  * Checks if current user can view a subwiki
694  *
695  * @param $subwiki
696  */
697 function wiki_user_can_view($subwiki) {
698     global $USER;
700     $wiki = wiki_get_wiki($subwiki->wikiid);
701     $cm = get_coursemodule_from_instance('wiki', $wiki->id);
702     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
704     // Working depending on activity groupmode
705     switch (groups_get_activity_groupmode($cm)) {
706     case NOGROUPS:
708         if ($wiki->wikimode == 'collaborative') {
709             // Collaborative Mode:
710             // There is one wiki for all the class.
711             //
712             // Only view capbility needed
713             return has_capability('mod/wiki:viewpage', $context);
714         } else if ($wiki->wikimode == 'individual') {
715             // Individual Mode:
716             // Each person owns a wiki.
717             if ($subwiki->userid == $USER->id) {
718                 // Only the owner of the wiki can view it
719                 return has_capability('mod/wiki:viewpage', $context);
720             } else { // User has special capabilities
721                 // User must have:
722                 //      mod/wiki:viewpage capability
723                 // and
724                 //      mod/wiki:managewiki capability
725                 $view = has_capability('mod/wiki:viewpage', $context);
726                 $manage = has_capability('mod/wiki:managewiki', $context);
728                 return $view && $manage;
729             }
730         } else {
731             //Error
732             return false;
733         }
734     case SEPARATEGROUPS:
735         // Collaborative and Individual Mode
736         //
737         // Collaborative Mode:
738         //      There is one wiki per group.
739         // Individual Mode:
740         //      Each person owns a wiki.
741         if ($wiki->wikimode == 'collaborative' || $wiki->wikimode == 'individual') {
742             // Only members of subwiki group could view that wiki
743             if ($subwiki->groupid == groups_get_activity_group($cm)) {
744                 // Only view capability needed
745                 return has_capability('mod/wiki:viewpage', $context);
747             } else { // User is not part of that group
748                 // User must have:
749                 //      mod/wiki:managewiki capability
750                 // or
751                 //      moodle/site:accessallgroups capability
752                 // and
753                 //      mod/wiki:viewpage capability
754                 $view = has_capability('mod/wiki:viewpage', $context);
755                 $manage = has_capability('mod/wiki:managewiki', $context);
756                 $access = has_capability('moodle/site:accessallgroups', $context);
757                 return ($manage || $access) && $view;
758             }
759         } else {
760             //Error
761             return false;
762         }
763     case VISIBLEGROUPS:
764         // Collaborative and Individual Mode
765         //
766         // Collaborative Mode:
767         //      There is one wiki per group.
768         // Individual Mode:
769         //      Each person owns a wiki.
770         if ($wiki->wikimode == 'collaborative' || $wiki->wikimode == 'individual') {
771             // Everybody can read all wikis
772             //
773             // Only view capability needed
774             return has_capability('mod/wiki:viewpage', $context);
775         } else {
776             //Error
777             return false;
778         }
779     default: // Error
780         return false;
781     }
784 /**
785  * Checks if current user can edit a subwiki
786  *
787  * @param $subwiki
788  */
789 function wiki_user_can_edit($subwiki) {
790     global $USER;
792     $wiki = wiki_get_wiki($subwiki->wikiid);
793     $cm = get_coursemodule_from_instance('wiki', $wiki->id);
794     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
796     // Working depending on activity groupmode
797     switch (groups_get_activity_groupmode($cm)) {
798     case NOGROUPS:
800         if ($wiki->wikimode == 'collaborative') {
801             // Collaborative Mode:
802             // There is a wiki for all the class.
803             //
804             // Only edit capbility needed
805             return has_capability('mod/wiki:editpage', $context);
806         } else if ($wiki->wikimode == 'individual') {
807             // Individual Mode
808             // There is a wiki per user
810             // Only the owner of that wiki can edit it
811             if ($subwiki->userid == $USER->id) {
812                 return has_capability('mod/wiki:editpage', $context);
813             } else { // Current user is not the owner of that wiki.
815                 // User must have:
816                 //      mod/wiki:editpage capability
817                 // and
818                 //      mod/wiki:managewiki capability
819                 $edit = has_capability('mod/wiki:editpage', $context);
820                 $manage = has_capability('mod/wiki:managewiki', $context);
822                 return $edit && $manage;
823             }
824         } else {
825             //Error
826             return false;
827         }
828     case SEPARATEGROUPS:
829         if ($wiki->wikimode == 'collaborative') {
830             // Collaborative Mode:
831             // There is one wiki per group.
832             //
833             // Only members of subwiki group could edit that wiki
834             if ($subwiki->groupid == groups_get_activity_group($cm)) {
835                 // Only edit capability needed
836                 return has_capability('mod/wiki:editpage', $context);
837             } else { // User is not part of that group
838                 // User must have:
839                 //      mod/wiki:managewiki capability
840                 // and
841                 //      moodle/site:accessallgroups capability
842                 // and
843                 //      mod/wiki:editpage capability
844                 $manage = has_capability('mod/wiki:managewiki', $context);
845                 $access = has_capability('moodle/site:accessallgroups', $context);
846                 $edit = has_capability('mod/wiki:editpage', $context);
847                 return $manage && $access && $edit;
848             }
849         } else if ($wiki->wikimode == 'individual') {
850             // Individual Mode:
851             // Each person owns a wiki.
852             //
853             // Only the owner of that wiki can edit it
854             if ($subwiki->userid == $USER->id) {
855                 return has_capability('mod/wiki:editpage', $context);
856             } else { // Current user is not the owner of that wiki.
857                 // User must have:
858                 //      mod/wiki:managewiki capability
859                 // and
860                 //      moodle/site:accessallgroups capability
861                 // and
862                 //      mod/wiki:editpage capability
863                 $manage = has_capability('mod/wiki:managewiki', $context);
864                 $access = has_capability('moodle/site:accessallgroups', $context);
865                 $edit = has_capability('mod/wiki:editpage', $context);
866                 return $manage && $access && $edit;
867             }
868         } else {
869             //Error
870             return false;
871         }
872     case VISIBLEGROUPS:
873         if ($wiki->wikimode == 'collaborative') {
874             // Collaborative Mode:
875             // There is one wiki per group.
876             //
877             // Only members of subwiki group could edit that wiki
878             if ($subwiki->groupid == groups_get_activity_group($cm)) {
879                 // Only edit capability needed
880                 return has_capability('mod/wiki:editpage', $context);
881             } else { // User is not part of that group
882                 // User must have:
883                 //      mod/wiki:managewiki capability
884                 // and
885                 //      mod/wiki:editpage capability
886                 $manage = has_capability('mod/wiki:managewiki', $context);
887                 $edit = has_capability('mod/wiki:editpage', $context);
888                 return $manage && $edit;
889             }
890         } else if ($wiki->wikimode == 'individual') {
891             // Individual Mode:
892             // Each person owns a wiki.
893             //
894             // Only the owner of that wiki can edit it
895             if ($subwiki->userid == $USER->id) {
896                 return has_capability('mod/wiki:editpage', $context);
897             } else { // Current user is not the owner of that wiki.
898                 // User must have:
899                 //      mod/wiki:managewiki capability
900                 // and
901                 //      mod/wiki:editpage capability
902                 $manage = has_capability('mod/wiki:managewiki', $context);
903                 $edit = has_capability('mod/wiki:editpage', $context);
904                 return $manage && $edit;
905             }
906         } else {
907             //Error
908             return false;
909         }
910     default: // Error
911         return false;
912     }
915 //----------------
916 // Locks
917 //----------------
919 /**
920  * Checks if a page-section is locked.
921  *
922  * @return true if the combination of section and page is locked, FALSE otherwise.
923  */
924 function wiki_is_page_section_locked($pageid, $userid, $section = null) {
925     global $DB;
927     $sql = "pageid = ? AND lockedat > ? AND userid != ?";
928     $params = array($pageid, time(), $userid);
930     if (!empty($section)) {
931         $sql .= " AND (sectionname = ? OR sectionname IS null)";
932         $params[] = $section;
933     }
935     return $DB->record_exists_select('wiki_locks', $sql, $params);
938 /**
939  * Inserts or updates a wiki_locks record.
940  */
941 function wiki_set_lock($pageid, $userid, $section = null, $insert = false) {
942     global $DB;
944     if (wiki_is_page_section_locked($pageid, $userid, $section)) {
945         return false;
946     }
948     $params = array('pageid' => $pageid, 'userid' => $userid, 'sectionname' => $section);
950     $lock = $DB->get_record('wiki_locks', $params);
952     if (!empty($lock)) {
953         $DB->update_record('wiki_locks', array('id' => $lock->id, 'lockedat' => time() + LOCK_TIMEOUT));
954     } else if ($insert) {
955         $DB->insert_record('wiki_locks', array('pageid' => $pageid, 'sectionname' => $section, 'userid' => $userid, 'lockedat' => time() + 30));
956     }
958     return true;
961 /**
962  * 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.
963  */
964 function wiki_delete_locks($pageid, $userid = null, $section = null, $delete_from_db = true, $delete_section_and_page = false) {
965     global $DB;
967     $params = array('pageid' => $pageid);
969     if (!empty($userid)) {
970         $params['userid'] = $userid;
971     }
973     if (!empty($section)) {
974         $params['sectionname'] = $section;
975     }
977     if ($delete_from_db) {
978         $DB->delete_records('wiki_locks', $params);
979         if ($delete_section_and_page && !empty($section)) {
980             $params['sectionname'] = null;
981             $DB->delete_records('wiki_locks', $params);
982         }
983     } else {
984         $DB->set_field('wiki_locks', 'lockedat', time(), $params);
985     }
988 /**
989  * Deletes wiki_locks that expired 1 hour ago.
990  */
991 function wiki_delete_old_locks() {
992     global $DB;
994     $DB->delete_records_select('wiki_locks', "lockedat < ?", array(time() - 3600));
997 /**
998  * File processing
999  */
1001 /**
1002  * Uploads files to permanent disk space.
1003  *
1004  * @param int draftitemid Draft space ID
1005  * @param int contextid
1006  *
1007  * @return array of files that have not been inserted.
1008  */
1010 function wiki_process_attachments($draftitemid, $deleteuploads, $contextid, $filearea, $itemid, $options = null) {
1011     global $CFG, $USER;
1013     if (empty($options)) {
1014         $options = page_wiki_edit::$attachmentoptions;
1015     }
1017     $errors = array();
1019     $usercontext = get_context_instance(CONTEXT_USER, $USER->id);
1020     $fs = get_file_storage();
1022     $oldfiles = $fs->get_area_files($contextid, 'mod_wiki', 'attachments', $itemid, 'id');
1024     foreach ($oldfiles as $file) {
1025         if (in_array($file->get_pathnamehash(), $deleteuploads)) {
1026             $file->delete();
1027         }
1028     }
1030     $draftfiles = $fs->get_area_files($usercontext->id, 'user', 'draft', $draftitemid, 'id');
1031     $oldfiles = $fs->get_area_files($contextid, 'mod_wiki', 'attachments', $itemid, 'id');
1033     $file_record = array('contextid' => $contextid, 'component' => 'mod_wiki', 'filearea' => 'attachments', 'itemid' => $itemid);
1034     //more or less a merge...
1035     $newhashes = array();
1036     foreach ($draftfiles as $file) {
1037         $newhash = sha1("/$contextid/mod_wiki/attachments/$itemid" . $file->get_filepath() . $file->get_filename());
1038         $newhashes[$newhash] = $file;
1039     }
1041     $filecount = 0;
1042     foreach ($oldfiles as $file) {
1043         $oldhash = $file->get_pathnamehash();
1044         if (!$file->is_directory() && isset($newhashes[$oldhash])) {
1045             //repeated file: ERROR!!!
1046             unset($newhashes[$oldhash]);
1047             $errors[] = $file;
1048         }
1050         if (!$file->is_directory()) {
1051             $filecount++;
1052         }
1053     }
1055     foreach ($newhashes as $file) {
1056         if ($file->get_filepath() !== '/' or $file->is_directory()) {
1057             continue;
1058         }
1060         if ($options['maxfiles'] and $options['maxfiles'] <= $filecount) {
1061             break;
1062         }
1064         if (!$file->is_directory()) {
1065             $filecount++;
1066             $fs->create_file_from_storedfile($file_record, $file);
1067         }
1068     }
1070     //delete all draft files
1071     $fs->delete_area_files($usercontext->id, 'user', 'draft', $draftitemid);
1073     return $errors;
1076 function wiki_get_comment($commentid){
1077     global $DB;
1078     return $DB->get_record('comments', array('id' => $commentid));
1081 /**
1082  * Returns all comments by context and pageid
1083  *
1084  * @param $context. Current context
1085  * @param $pageid. Current pageid
1086  **/
1087 function wiki_get_comments($contextid, $pageid) {
1088     global $DB;
1090     return $DB->get_records('comments', array('contextid' => $contextid, 'itemid' => $pageid, 'commentarea' => 'wiki_page'));
1093 /**
1094  * Add comments ro database
1095  *
1096  * @param object $context. Current context
1097  * @param int $pageid. Current pageid
1098  * @param string $content. Content of the comment
1099  * @param string editor. Version of editor we are using.
1100  **/
1101 function wiki_add_comment($context, $pageid, $content, $editor) {
1102     global $CFG;
1103     require_once($CFG->dirroot . '/comment/lib.php');
1105     list($context, $course, $cm) = get_context_info_array($context->id);
1106     $cmt = new stdclass();
1107     $cmt->context = $context;
1108     $cmt->itemid = $pageid;
1109     $cmt->area = 'wiki_page';
1110     $cmt->course = $course;
1111     $cmt->component = 'mod_wiki';
1113     $manager = new comment($cmt);
1115     if ($editor == 'creole') {
1116         $manager->add($content, FORMAT_CREOLE);
1117     } else if ($editor == 'html') {
1118         $manager->add($content, FORMAT_HTML);
1119     } else if ($editor == 'nwiki') {
1120         $manager->add($content, FORMAT_NWIKI);
1121     }
1125 /**
1126  * Delete comments from database
1127  *
1128  * @param $idcomment. Id of comment which will be deleted
1129  * @param $context. Current context
1130  * @param $pageid. Current pageid
1131  **/
1132 function wiki_delete_comment($idcomment, $context, $pageid) {
1133     global $CFG;
1134     require_once($CFG->dirroot . '/comment/lib.php');
1136     list($context, $course, $cm) = get_context_info_array($context->id);
1137     $cmt = new stdClass();
1138     $cmt->context = $context;
1139     $cmt->itemid = $pageid;
1140     $cmt->area = 'wiki_page';
1141     $cmt->course = $course;
1142     $cmt->component = 'mod_wiki';
1144     $manager = new comment($cmt);
1145     $manager->delete($idcomment);
1149 /**
1150  * Delete al comments from wiki
1151  *
1152  **/
1153 function wiki_delete_comments_wiki() {
1154     global $PAGE, $DB;
1156     $cm = $PAGE->cm;
1157     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1159     $table = 'comments';
1160     $select = 'contextid = ?';
1162     $DB->delete_records_select($table, $select, array($context->id));
1166 function wiki_add_progress($pageid, $oldversionid, $versionid, $progress) {
1167     global $DB;
1168     for ($v = $oldversionid + 1; $v <= $versionid; $v++) {
1169         $user = wiki_get_wiki_page_id($pageid, $v);
1171         $DB->insert_record('wiki_progress', array('userid' => $user->userid, 'pageid' => $pageid, 'versionid' => $v, 'progress' => $progress));
1172     }
1175 function wiki_get_wiki_page_id($pageid, $id) {
1176     global $DB;
1177     return $DB->get_record('wiki_versions', array('pageid' => $pageid, 'id' => $id));
1180 function wiki_print_page_content($page, $context, $subwikiid) {
1181     global $OUTPUT, $CFG;
1183     if ($page->timerendered + WIKI_REFRESH_CACHE_TIME < time()) {
1184         $content = wiki_refresh_cachedcontent($page);
1185         $page = $content['page'];
1186     }
1188     if (isset($content)) {
1189         $box = '';
1190         foreach ($content['sections'] as $s) {
1191             $box .= '<p>' . get_string('repeatedsection', 'wiki', $s) . '</p>';
1192         }
1194         if (!empty($box)) {
1195             echo $OUTPUT->box($box);
1196         }
1197     }
1198     $html = file_rewrite_pluginfile_urls($page->cachedcontent, 'pluginfile.php', $context->id, 'mod_wiki', 'attachments', $subwikiid);
1199     $html = format_text($html, FORMAT_MOODLE, array('overflowdiv'=>true));
1200     echo $OUTPUT->box($html);
1202     if (!empty($CFG->usetags)) {
1203         $tags = tag_get_tags_array('wiki_pages', $page->id);
1204         echo $OUTPUT->container_start('wiki-tags');
1205         echo '<span class="wiki-tags-title">'.get_string('tags').': </span>';
1206         $links = array();
1207         foreach ($tags as $tagid=>$tag) {
1208             $url = new moodle_url('/tag/index.php', array('tag'=>$tag));
1209             $links[] = html_writer::link($url, $tag, array('title'=>get_string('tagtitle', 'wiki', $tag)));
1210         }
1211         echo join($links, ", ");
1212         echo $OUTPUT->container_end();
1213     }
1215     wiki_increment_pageviews($page);
1218 /**
1219  * This function trims any given text and returns it with some dots at the end
1220  *
1221  * @param string $text
1222  * @param string $limit
1223  *
1224  * @return string
1225  */
1226 function wiki_trim_string($text, $limit = 25) {
1228     if (strlen($text) > $limit) {
1229         $text = substr($text, 0, $limit) . '...';
1230     }
1232     return $text;
1235 /**
1236  * Prints default edit form fields and buttons
1237  *
1238  * @param string $format Edit form format (html, creole...)
1239  * @param integer $version Version number. A negative number means no versioning.
1240  */
1242 function wiki_print_edit_form_default_fields($format, $pageid, $version = -1, $upload = false, $deleteuploads = array()) {
1243     global $CFG, $PAGE, $OUTPUT;
1245     echo '<input type="hidden" name="sesskey" value="' . sesskey() . '" />';
1247     if ($version >= 0) {
1248         echo '<input type="hidden" name="version" value="' . $version . '" />';
1249     }
1251     echo '<input type="hidden" name="format" value="' . $format . '"/>';
1253     //attachments
1254     require_once($CFG->dirroot . '/lib/form/filemanager.php');
1256     $filemanager = new MoodleQuickForm_filemanager('attachments', get_string('wikiattachments', 'wiki'), array('id' => 'attachments'), array('subdirs' => false, 'maxfiles' => 99, 'maxbytes' => $CFG->maxbytes));
1258     $value = file_get_submitted_draft_itemid('attachments');
1259     if (!empty($value) && !$upload) {
1260         $filemanager->setValue($value);
1261     }
1263     echo "<fieldset class=\"wiki-upload-section clearfix\"><legend class=\"ftoggler\">" . get_string("uploadtitle", 'wiki') . "</legend>";
1265     echo $OUTPUT->container_start('mdl-align wiki-form-center aaaaa');
1266     print $filemanager->toHtml();
1267     echo $OUTPUT->container_end();
1269     $cm = $PAGE->cm;
1270     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1272     echo $OUTPUT->container_start('mdl-align wiki-form-center wiki-upload-table');
1273     wiki_print_upload_table($context, 'wiki_upload', $pageid, $deleteuploads);
1274     echo $OUTPUT->container_end();
1276     echo "</fieldset>";
1278     echo '<input class="wiki_button" type="submit" name="editoption" value="' . get_string('save', 'wiki') . '"/>';
1279     echo '<input class="wiki_button" type="submit" name="editoption" value="' . get_string('upload', 'wiki') . '"/>';
1280     echo '<input class="wiki_button" type="submit" name="editoption" value="' . get_string('preview') . '"/>';
1281     echo '<input class="wiki_button" type="submit" name="editoption" value="' . get_string('cancel') . '" />';
1284 /**
1285  * Prints a table with the files attached to a wiki page
1286  * @param object $context
1287  * @param string $filearea
1288  * @param int $fileitemid
1289  * @param array deleteuploads
1290  */
1291 function wiki_print_upload_table($context, $filearea, $fileitemid, $deleteuploads = array()) {
1292     global $CFG, $OUTPUT;
1294     $htmltable = new html_table();
1296     $htmltable->head = array(get_string('deleteupload', 'wiki'), get_string('uploadname', 'wiki'), get_string('uploadactions', 'wiki'));
1298     $fs = get_file_storage();
1299     $files = $fs->get_area_files($context->id, 'mod_wiki', $filearea, $fileitemid); //TODO: this is weird (skodak)
1301     foreach ($files as $file) {
1302         if (!$file->is_directory()) {
1303             $checkbox = '<input type="checkbox" name="deleteupload[]", value="' . $file->get_pathnamehash() . '"';
1305             if (in_array($file->get_pathnamehash(), $deleteuploads)) {
1306                 $checkbox .= ' checked="checked"';
1307             }
1309             $checkbox .= " />";
1311             $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>', "");
1312         }
1313     }
1315     print '<h3 class="upload-table-title">' . get_string('uploadfiletitle', 'wiki') . "</h3>";
1316     print html_writer::table($htmltable);
1319 /**
1320  * Generate wiki's page tree
1321  *
1322  * @param $page. A wiki page object
1323  * @param $node. Starting navigation_node
1324  * @param $keys. An array to store keys
1325  * @return an array with all tree nodes
1326  */
1327 function wiki_build_tree($page, $node, &$keys) {
1328     $content = array();
1329     static $icon;
1330     $icon = new pix_icon('f/odt', '');
1331     $pages = wiki_get_linked_pages($page->id);
1332     foreach ($pages as $p) {
1333         $key = $page->id . ':' . $p->id;
1334         if (in_array($key, $keys)) {
1335             break;
1336         }
1337         array_push($keys, $key);
1338         $l = wiki_parser_link($p);
1339         $link = new moodle_url('/mod/wiki/view.php', array('pageid' => $p->id));
1340         $nodeaux = $node->add($p->title, $link, null, null, null, $icon);
1341         if ($l['new']) {
1342             $nodeaux->add_class('wiki_newentry');
1343         }
1344         wiki_build_tree($p, $nodeaux, $keys);
1345     }
1346     $content[] = $node;
1347     return $content;
1350 /**
1351  * Get linked pages from page
1352  * @param int $pageid
1353  */
1354 function wiki_get_linked_pages($pageid) {
1355     global $DB;
1357     $sql = "SELECT p.id, p.title
1358             FROM {wiki_pages} p
1359             JOIN {wiki_links} l ON l.topageid = p.id
1360             WHERE l.frompageid = ?
1361             ORDER BY p.title ASC";
1362     return $DB->get_records_sql($sql, array($pageid));
1365 /**
1366  * Get updated pages from wiki
1367  * @param int $pageid
1368  */
1369 function wiki_get_updated_pages_by_subwiki($swid) {
1370     global $DB, $USER;
1372     $sql = "SELECT *
1373             FROM {wiki_pages}
1374             WHERE subwikiid = ? AND timemodified > ?
1375             ORDER BY timemodified DESC";
1376     return $DB->get_records_sql($sql, array($swid, $USER->lastlogin));