MDL-56019 ws: Use itemid null when getting modules intro
[moodle.git] / mod / wiki / classes / external.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Wiki module external API.
19  *
20  * @package    mod_wiki
21  * @category   external
22  * @copyright  2015 Dani Palou <dani@moodle.com>
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  * @since      Moodle 3.1
25  */
27 defined('MOODLE_INTERNAL') || die;
29 require_once($CFG->libdir . '/externallib.php');
30 require_once($CFG->dirroot . '/mod/wiki/lib.php');
31 require_once($CFG->dirroot . '/mod/wiki/locallib.php');
33 /**
34  * Wiki module external functions.
35  *
36  * @package    mod_wiki
37  * @category   external
38  * @copyright  2015 Dani Palou <dani@moodle.com>
39  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
40  * @since      Moodle 3.1
41  */
42 class mod_wiki_external extends external_api {
44     /**
45      * Describes the parameters for get_wikis_by_courses.
46      *
47      * @return external_function_parameters
48      * @since Moodle 3.1
49      */
50     public static function get_wikis_by_courses_parameters() {
51         return new external_function_parameters (
52             array(
53                 'courseids' => new external_multiple_structure(
54                     new external_value(PARAM_INT, 'Course ID'), 'Array of course ids.', VALUE_DEFAULT, array()
55                 ),
56             )
57         );
58     }
60     /**
61      * Returns a list of wikis in a provided list of courses,
62      * if no list is provided all wikis that the user can view will be returned.
63      *
64      * @param array $courseids The courses IDs.
65      * @return array Containing a list of warnings and a list of wikis.
66      * @since Moodle 3.1
67      */
68     public static function get_wikis_by_courses($courseids = array()) {
70         $returnedwikis = array();
71         $warnings = array();
73         $params = self::validate_parameters(self::get_wikis_by_courses_parameters(), array('courseids' => $courseids));
75         $mycourses = array();
76         if (empty($params['courseids'])) {
77             $mycourses = enrol_get_my_courses();
78             $params['courseids'] = array_keys($mycourses);
79         }
81         // Ensure there are courseids to loop through.
82         if (!empty($params['courseids'])) {
84             list($courses, $warnings) = external_util::validate_courses($params['courseids'], $mycourses);
86             // Get the wikis in this course, this function checks users visibility permissions.
87             // We can avoid then additional validate_context calls.
88             $wikis = get_all_instances_in_courses('wiki', $courses);
90             foreach ($wikis as $wiki) {
92                 $context = context_module::instance($wiki->coursemodule);
94                 // Entry to return.
95                 $module = array();
97                 // First, we return information that any user can see in (or can deduce from) the web interface.
98                 $module['id'] = $wiki->id;
99                 $module['coursemodule'] = $wiki->coursemodule;
100                 $module['course'] = $wiki->course;
101                 $module['name']  = external_format_string($wiki->name, $context->id);
103                 $viewablefields = [];
104                 if (has_capability('mod/wiki:viewpage', $context)) {
105                     list($module['intro'], $module['introformat']) =
106                         external_format_text($wiki->intro, $wiki->introformat, $context->id, 'mod_wiki', 'intro', null);
107                     $module['introfiles'] = external_util::get_area_files($context->id, 'mod_wiki', 'intro', false, false);
109                     $viewablefields = array('firstpagetitle', 'wikimode', 'defaultformat', 'forceformat', 'editbegin', 'editend',
110                                             'section', 'visible', 'groupmode', 'groupingid');
111                 }
113                 // Check additional permissions for returning optional private settings.
114                 if (has_capability('moodle/course:manageactivities', $context)) {
115                     $additionalfields = array('timecreated', 'timemodified');
116                     $viewablefields = array_merge($viewablefields, $additionalfields);
117                 }
119                 foreach ($viewablefields as $field) {
120                     $module[$field] = $wiki->{$field};
121                 }
123                 // Check if user can add new pages.
124                 $module['cancreatepages'] = wiki_can_create_pages($context);
126                 $returnedwikis[] = $module;
127             }
128         }
130         $result = array();
131         $result['wikis'] = $returnedwikis;
132         $result['warnings'] = $warnings;
133         return $result;
134     }
136     /**
137      * Describes the get_wikis_by_courses return value.
138      *
139      * @return external_single_structure
140      * @since Moodle 3.1
141      */
142     public static function get_wikis_by_courses_returns() {
144         return new external_single_structure(
145             array(
146                 'wikis' => new external_multiple_structure(
147                     new external_single_structure(
148                         array(
149                             'id' => new external_value(PARAM_INT, 'Wiki ID.'),
150                             'coursemodule' => new external_value(PARAM_INT, 'Course module ID.'),
151                             'course' => new external_value(PARAM_INT, 'Course ID.'),
152                             'name' => new external_value(PARAM_RAW, 'Wiki name.'),
153                             'intro' => new external_value(PARAM_RAW, 'Wiki intro.', VALUE_OPTIONAL),
154                             'introformat' => new external_format_value('Wiki intro format.', VALUE_OPTIONAL),
155                             'introfiles' => new external_files('Files in the introduction text', VALUE_OPTIONAL),
156                             'timecreated' => new external_value(PARAM_INT, 'Time of creation.', VALUE_OPTIONAL),
157                             'timemodified' => new external_value(PARAM_INT, 'Time of last modification.', VALUE_OPTIONAL),
158                             'firstpagetitle' => new external_value(PARAM_RAW, 'First page title.', VALUE_OPTIONAL),
159                             'wikimode' => new external_value(PARAM_TEXT, 'Wiki mode (individual, collaborative).', VALUE_OPTIONAL),
160                             'defaultformat' => new external_value(PARAM_TEXT, 'Wiki\'s default format (html, creole, nwiki).',
161                                                                             VALUE_OPTIONAL),
162                             'forceformat' => new external_value(PARAM_INT, '1 if format is forced, 0 otherwise.',
163                                                                             VALUE_OPTIONAL),
164                             'editbegin' => new external_value(PARAM_INT, 'Edit begin.', VALUE_OPTIONAL),
165                             'editend' => new external_value(PARAM_INT, 'Edit end.', VALUE_OPTIONAL),
166                             'section' => new external_value(PARAM_INT, 'Course section ID.', VALUE_OPTIONAL),
167                             'visible' => new external_value(PARAM_INT, '1 if visible, 0 otherwise.', VALUE_OPTIONAL),
168                             'groupmode' => new external_value(PARAM_INT, 'Group mode.', VALUE_OPTIONAL),
169                             'groupingid' => new external_value(PARAM_INT, 'Group ID.', VALUE_OPTIONAL),
170                             'cancreatepages' => new external_value(PARAM_BOOL, 'True if user can create pages.'),
171                         ), 'Wikis'
172                     )
173                 ),
174                 'warnings' => new external_warnings(),
175             )
176         );
177     }
179     /**
180      * Describes the parameters for view_wiki.
181      *
182      * @return external_function_parameters
183      * @since Moodle 3.1
184      */
185     public static function view_wiki_parameters() {
186         return new external_function_parameters (
187             array(
188                 'wikiid' => new external_value(PARAM_INT, 'Wiki instance ID.')
189             )
190         );
191     }
193     /**
194      * Trigger the course module viewed event and update the module completion status.
195      *
196      * @param int $wikiid The wiki instance ID.
197      * @return array of warnings and status result.
198      * @since Moodle 3.1
199      */
200     public static function view_wiki($wikiid) {
202         $params = self::validate_parameters(self::view_wiki_parameters(),
203                                             array(
204                                                 'wikiid' => $wikiid
205                                             ));
206         $warnings = array();
208         // Get wiki instance.
209         if (!$wiki = wiki_get_wiki($params['wikiid'])) {
210             throw new moodle_exception('incorrectwikiid', 'wiki');
211         }
213         // Permission validation.
214         list($course, $cm) = get_course_and_cm_from_instance($wiki, 'wiki');
215         $context = context_module::instance($cm->id);
216         self::validate_context($context);
218         // Check if user can view this wiki.
219         // We don't use wiki_user_can_view because it requires to have a valid subwiki for the user.
220         if (!has_capability('mod/wiki:viewpage', $context)) {
221             throw new moodle_exception('cannotviewpage', 'wiki');
222         }
224         // Trigger course_module_viewed event and completion.
225         wiki_view($wiki, $course, $cm, $context);
227         $result = array();
228         $result['status'] = true;
229         $result['warnings'] = $warnings;
230         return $result;
231     }
233     /**
234      * Describes the view_wiki return value.
235      *
236      * @return external_single_structure
237      * @since Moodle 3.1
238      */
239     public static function view_wiki_returns() {
240         return new external_single_structure(
241             array(
242                 'status' => new external_value(PARAM_BOOL, 'Status: true if success.'),
243                 'warnings' => new external_warnings()
244             )
245         );
246     }
248     /**
249      * Describes the parameters for view_page.
250      *
251      * @return external_function_parameters
252      * @since Moodle 3.1
253      */
254     public static function view_page_parameters() {
255         return new external_function_parameters (
256             array(
257                 'pageid' => new external_value(PARAM_INT, 'Wiki page ID.'),
258             )
259         );
260     }
262     /**
263      * Trigger the page viewed event and update the module completion status.
264      *
265      * @param int $pageid The page ID.
266      * @return array of warnings and status result.
267      * @since Moodle 3.1
268      * @throws moodle_exception if page is not valid.
269      */
270     public static function view_page($pageid) {
272         $params = self::validate_parameters(self::view_page_parameters(),
273                                             array(
274                                                 'pageid' => $pageid
275                                             ));
276         $warnings = array();
278         // Get wiki page.
279         if (!$page = wiki_get_page($params['pageid'])) {
280             throw new moodle_exception('incorrectpageid', 'wiki');
281         }
283         // Get wiki instance.
284         if (!$wiki = wiki_get_wiki_from_pageid($params['pageid'])) {
285             throw new moodle_exception('incorrectwikiid', 'wiki');
286         }
288         // Permission validation.
289         list($course, $cm) = get_course_and_cm_from_instance($wiki, 'wiki');
290         $context = context_module::instance($cm->id);
291         self::validate_context($context);
293         // Check if user can view this wiki.
294         if (!$subwiki = wiki_get_subwiki($page->subwikiid)) {
295             throw new moodle_exception('incorrectsubwikiid', 'wiki');
296         }
297         if (!wiki_user_can_view($subwiki, $wiki)) {
298             throw new moodle_exception('cannotviewpage', 'wiki');
299         }
301         // Trigger page_viewed event and completion.
302         wiki_page_view($wiki, $page, $course, $cm, $context);
304         $result = array();
305         $result['status'] = true;
306         $result['warnings'] = $warnings;
307         return $result;
308     }
310     /**
311      * Describes the view_page return value.
312      *
313      * @return external_single_structure
314      * @since Moodle 3.1
315      */
316     public static function view_page_returns() {
317         return new external_single_structure(
318             array(
319                 'status' => new external_value(PARAM_BOOL, 'Status: true if success.'),
320                 'warnings' => new external_warnings()
321             )
322         );
323     }
325     /**
326      * Describes the parameters for get_subwikis.
327      *
328      * @return external_function_parameters
329      * @since Moodle 3.1
330      */
331     public static function get_subwikis_parameters() {
332         return new external_function_parameters (
333             array(
334                 'wikiid' => new external_value(PARAM_INT, 'Wiki instance ID.')
335             )
336         );
337     }
339     /**
340      * Returns the list of subwikis the user can see in a specific wiki.
341      *
342      * @param int $wikiid The wiki instance ID.
343      * @return array Containing a list of warnings and a list of subwikis.
344      * @since Moodle 3.1
345      */
346     public static function get_subwikis($wikiid) {
347         global $USER;
349         $warnings = array();
351         $params = self::validate_parameters(self::get_subwikis_parameters(), array('wikiid' => $wikiid));
353         // Get wiki instance.
354         if (!$wiki = wiki_get_wiki($params['wikiid'])) {
355             throw new moodle_exception('incorrectwikiid', 'wiki');
356         }
358         // Validate context and capabilities.
359         list($course, $cm) = get_course_and_cm_from_instance($wiki, 'wiki');
360         $context = context_module::instance($cm->id);
361         self::validate_context($context);
362         require_capability('mod/wiki:viewpage', $context);
364         $returnedsubwikis = wiki_get_visible_subwikis($wiki, $cm, $context);
365         foreach ($returnedsubwikis as $subwiki) {
366             $subwiki->canedit = wiki_user_can_edit($subwiki);
367         }
369         $result = array();
370         $result['subwikis'] = $returnedsubwikis;
371         $result['warnings'] = $warnings;
372         return $result;
373     }
375     /**
376      * Describes the get_subwikis return value.
377      *
378      * @return external_single_structure
379      * @since Moodle 3.1
380      */
381     public static function get_subwikis_returns() {
382         return new external_single_structure(
383             array(
384                 'subwikis' => new external_multiple_structure(
385                     new external_single_structure(
386                         array(
387                             'id' => new external_value(PARAM_INT, 'Subwiki ID.'),
388                             'wikiid' => new external_value(PARAM_INT, 'Wiki ID.'),
389                             'groupid' => new external_value(PARAM_RAW, 'Group ID.'),
390                             'userid' => new external_value(PARAM_INT, 'User ID.'),
391                             'canedit' => new external_value(PARAM_BOOL, 'True if user can edit the subwiki.'),
392                         ), 'Subwikis'
393                     )
394                 ),
395                 'warnings' => new external_warnings(),
396             )
397         );
398     }
400     /**
401      * Describes the parameters for get_subwiki_pages.
402      *
403      * @return external_function_parameters
404      * @since Moodle 3.1
405      */
406     public static function get_subwiki_pages_parameters() {
407         return new external_function_parameters (
408             array(
409                 'wikiid' => new external_value(PARAM_INT, 'Wiki instance ID.'),
410                 'groupid' => new external_value(PARAM_INT, 'Subwiki\'s group ID, -1 means current group. It will be ignored'
411                                         . ' if the wiki doesn\'t use groups.', VALUE_DEFAULT, -1),
412                 'userid' => new external_value(PARAM_INT, 'Subwiki\'s user ID, 0 means current user. It will be ignored'
413                                         .' in collaborative wikis.', VALUE_DEFAULT, 0),
414                 'options' => new external_single_structure(
415                             array(
416                                     'sortby' => new external_value(PARAM_ALPHA,
417                                             'Field to sort by (id, title, ...).', VALUE_DEFAULT, 'title'),
418                                     'sortdirection' => new external_value(PARAM_ALPHA,
419                                             'Sort direction: ASC or DESC.', VALUE_DEFAULT, 'ASC'),
420                                     'includecontent' => new external_value(PARAM_INT,
421                                             'Include each page contents or just the contents size.', VALUE_DEFAULT, 1),
422                             ), 'Options', VALUE_DEFAULT, array()),
423             )
424         );
425     }
427     /**
428      * Returns the list of pages from a specific subwiki.
429      *
430      * @param int $wikiid The wiki instance ID.
431      * @param int $groupid The group ID. If not defined, use current group.
432      * @param int $userid The user ID. If not defined, use current user.
433      * @param array $options Several options like sort by, sort direction, ...
434      * @return array Containing a list of warnings and a list of pages.
435      * @since Moodle 3.1
436      */
437     public static function get_subwiki_pages($wikiid, $groupid = -1, $userid = 0, $options = array()) {
439         $returnedpages = array();
440         $warnings = array();
442         $params = self::validate_parameters(self::get_subwiki_pages_parameters(),
443                                             array(
444                                                 'wikiid' => $wikiid,
445                                                 'groupid' => $groupid,
446                                                 'userid' => $userid,
447                                                 'options' => $options
448                                                 )
449             );
451         // Get wiki instance.
452         if (!$wiki = wiki_get_wiki($params['wikiid'])) {
453             throw new moodle_exception('incorrectwikiid', 'wiki');
454         }
455         list($course, $cm) = get_course_and_cm_from_instance($wiki, 'wiki');
456         $context = context_module::instance($cm->id);
457         self::validate_context($context);
459         // Determine groupid and userid to use.
460         list($groupid, $userid) = self::determine_group_and_user($cm, $wiki, $params['groupid'], $params['userid']);
462         // Get subwiki and validate it.
463         $subwiki = wiki_get_subwiki_by_group_and_user_with_validation($wiki, $groupid, $userid);
465         if ($subwiki === false) {
466             throw new moodle_exception('cannotviewpage', 'wiki');
467         } else if ($subwiki->id != -1) {
469             // Set sort param.
470             $options = $params['options'];
471             if (!empty($options['sortby'])) {
472                 if ($options['sortdirection'] != 'ASC' && $options['sortdirection'] != 'DESC') {
473                     // Invalid sort direction. Use default.
474                     $options['sortdirection'] = 'ASC';
475                 }
476                 $sort = $options['sortby'] . ' ' . $options['sortdirection'];
477             }
479             $pages = wiki_get_page_list($subwiki->id, $sort);
480             $caneditpages = wiki_user_can_edit($subwiki);
481             $firstpage = wiki_get_first_page($subwiki->id);
483             foreach ($pages as $page) {
484                 $retpage = array(
485                         'id' => $page->id,
486                         'subwikiid' => $page->subwikiid,
487                         'title' => external_format_string($page->title, $context->id),
488                         'timecreated' => $page->timecreated,
489                         'timemodified' => $page->timemodified,
490                         'timerendered' => $page->timerendered,
491                         'userid' => $page->userid,
492                         'pageviews' => $page->pageviews,
493                         'readonly' => $page->readonly,
494                         'caneditpage' => $caneditpages,
495                         'firstpage' => $page->id == $firstpage->id
496                     );
498                 // Refresh page cached content if needed.
499                 if ($page->timerendered + WIKI_REFRESH_CACHE_TIME < time()) {
500                     if ($content = wiki_refresh_cachedcontent($page)) {
501                         $page = $content['page'];
502                     }
503                 }
504                 list($cachedcontent, $contentformat) = external_format_text(
505                             $page->cachedcontent, FORMAT_HTML, $context->id, 'mod_wiki', 'attachments', $subwiki->id);
507                 if ($options['includecontent']) {
508                     // Return the page content.
509                     $retpage['cachedcontent'] = $cachedcontent;
510                     $retpage['contentformat'] = $contentformat;
511                 } else {
512                     // Return the size of the content.
513                     if (function_exists('mb_strlen') && ((int)ini_get('mbstring.func_overload') & 2)) {
514                         $retpage['contentsize'] = mb_strlen($cachedcontent, '8bit');
515                     } else {
516                         $retpage['contentsize'] = strlen($cachedcontent);
517                     }
518                 }
520                 $returnedpages[] = $retpage;
521             }
522         }
524         $result = array();
525         $result['pages'] = $returnedpages;
526         $result['warnings'] = $warnings;
527         return $result;
528     }
530     /**
531      * Describes the get_subwiki_pages return value.
532      *
533      * @return external_single_structure
534      * @since Moodle 3.1
535      */
536     public static function get_subwiki_pages_returns() {
538         return new external_single_structure(
539             array(
540                 'pages' => new external_multiple_structure(
541                     new external_single_structure(
542                         array(
543                             'id' => new external_value(PARAM_INT, 'Page ID.'),
544                             'subwikiid' => new external_value(PARAM_INT, 'Page\'s subwiki ID.'),
545                             'title' => new external_value(PARAM_RAW, 'Page title.'),
546                             'timecreated' => new external_value(PARAM_INT, 'Time of creation.'),
547                             'timemodified' => new external_value(PARAM_INT, 'Time of last modification.'),
548                             'timerendered' => new external_value(PARAM_INT, 'Time of last renderization.'),
549                             'userid' => new external_value(PARAM_INT, 'ID of the user that last modified the page.'),
550                             'pageviews' => new external_value(PARAM_INT, 'Number of times the page has been viewed.'),
551                             'readonly' => new external_value(PARAM_INT, '1 if readonly, 0 otherwise.'),
552                             'caneditpage' => new external_value(PARAM_BOOL, 'True if user can edit the page.'),
553                             'firstpage' => new external_value(PARAM_BOOL, 'True if it\'s the first page.'),
554                             'cachedcontent' => new external_value(PARAM_RAW, 'Page contents.', VALUE_OPTIONAL),
555                             'contentformat' => new external_format_value('cachedcontent', VALUE_OPTIONAL),
556                             'contentsize' => new external_value(PARAM_INT, 'Size of page contents in bytes (doesn\'t include'.
557                                                                             ' size of attached files).', VALUE_OPTIONAL),
558                         ), 'Pages'
559                     )
560                 ),
561                 'warnings' => new external_warnings(),
562             )
563         );
564     }
566     /**
567      * Describes the parameters for get_page_contents.
568      *
569      * @return external_function_parameters
570      * @since Moodle 3.1
571      */
572     public static function get_page_contents_parameters() {
573         return new external_function_parameters (
574             array(
575                 'pageid' => new external_value(PARAM_INT, 'Page ID.')
576             )
577         );
578     }
580     /**
581      * Get a page contents.
582      *
583      * @param int $pageid The page ID.
584      * @return array of warnings and page data.
585      * @since Moodle 3.1
586      */
587     public static function get_page_contents($pageid) {
589         $params = self::validate_parameters(self::get_page_contents_parameters(),
590                                             array(
591                                                 'pageid' => $pageid
592                                             )
593             );
594         $warnings = array();
596         // Get wiki page.
597         if (!$page = wiki_get_page($params['pageid'])) {
598             throw new moodle_exception('incorrectpageid', 'wiki');
599         }
601         // Get wiki instance.
602         if (!$wiki = wiki_get_wiki_from_pageid($params['pageid'])) {
603             throw new moodle_exception('incorrectwikiid', 'wiki');
604         }
606         // Permission validation.
607         $cm = get_coursemodule_from_instance('wiki', $wiki->id, $wiki->course);
608         $context = context_module::instance($cm->id);
609         self::validate_context($context);
611         // Check if user can view this wiki.
612         if (!$subwiki = wiki_get_subwiki($page->subwikiid)) {
613             throw new moodle_exception('incorrectsubwikiid', 'wiki');
614         }
615         if (!wiki_user_can_view($subwiki, $wiki)) {
616             throw new moodle_exception('cannotviewpage', 'wiki');
617         }
619         $returnedpage = array();
620         $returnedpage['id'] = $page->id;
621         $returnedpage['wikiid'] = $wiki->id;
622         $returnedpage['subwikiid'] = $page->subwikiid;
623         $returnedpage['groupid'] = $subwiki->groupid;
624         $returnedpage['userid'] = $subwiki->userid;
625         $returnedpage['title'] = $page->title;
627         // Refresh page cached content if needed.
628         if ($page->timerendered + WIKI_REFRESH_CACHE_TIME < time()) {
629             if ($content = wiki_refresh_cachedcontent($page)) {
630                 $page = $content['page'];
631             }
632         }
634         list($returnedpage['cachedcontent'], $returnedpage['contentformat']) = external_format_text(
635                             $page->cachedcontent, FORMAT_HTML, $context->id, 'mod_wiki', 'attachments', $subwiki->id);
636         $returnedpage['caneditpage'] = wiki_user_can_edit($subwiki);
638         $result = array();
639         $result['page'] = $returnedpage;
640         $result['warnings'] = $warnings;
641         return $result;
642     }
644     /**
645      * Describes the get_page_contents return value.
646      *
647      * @return external_single_structure
648      * @since Moodle 3.1
649      */
650     public static function get_page_contents_returns() {
651         return new external_single_structure(
652             array(
653                 'page' => new external_single_structure(
654                     array(
655                         'id' => new external_value(PARAM_INT, 'Page ID.'),
656                         'wikiid' => new external_value(PARAM_INT, 'Page\'s wiki ID.'),
657                         'subwikiid' => new external_value(PARAM_INT, 'Page\'s subwiki ID.'),
658                         'groupid' => new external_value(PARAM_INT, 'Page\'s group ID.'),
659                         'userid' => new external_value(PARAM_INT, 'Page\'s user ID.'),
660                         'title' => new external_value(PARAM_RAW, 'Page title.'),
661                         'cachedcontent' => new external_value(PARAM_RAW, 'Page contents.'),
662                         'contentformat' => new external_format_value('cachedcontent', VALUE_OPTIONAL),
663                         'caneditpage' => new external_value(PARAM_BOOL, 'True if user can edit the page.')
664                     ), 'Page'
665                 ),
666                 'warnings' => new external_warnings()
667             )
668         );
669     }
671     /**
672      * Describes the parameters for get_subwiki_files.
673      *
674      * @return external_function_parameters
675      * @since Moodle 3.1
676      */
677     public static function get_subwiki_files_parameters() {
678         return new external_function_parameters (
679             array(
680                 'wikiid' => new external_value(PARAM_INT, 'Wiki instance ID.'),
681                 'groupid' => new external_value(PARAM_INT, 'Subwiki\'s group ID, -1 means current group. It will be ignored'
682                                         . ' if the wiki doesn\'t use groups.', VALUE_DEFAULT, -1),
683                 'userid' => new external_value(PARAM_INT, 'Subwiki\'s user ID, 0 means current user. It will be ignored'
684                                         .' in collaborative wikis.', VALUE_DEFAULT, 0)
685             )
686         );
687     }
689     /**
690      * Returns the list of files from a specific subwiki.
691      *
692      * @param int $wikiid The wiki instance ID.
693      * @param int $groupid The group ID. If not defined, use current group.
694      * @param int $userid The user ID. If not defined, use current user.
695      * @return array Containing a list of warnings and a list of files.
696      * @since Moodle 3.1
697      * @throws moodle_exception
698      */
699     public static function get_subwiki_files($wikiid, $groupid = -1, $userid = 0) {
701         $returnedfiles = array();
702         $warnings = array();
704         $params = self::validate_parameters(self::get_subwiki_files_parameters(),
705                                             array(
706                                                 'wikiid' => $wikiid,
707                                                 'groupid' => $groupid,
708                                                 'userid' => $userid
709                                                 )
710             );
712         // Get wiki instance.
713         if (!$wiki = wiki_get_wiki($params['wikiid'])) {
714             throw new moodle_exception('incorrectwikiid', 'wiki');
715         }
716         list($course, $cm) = get_course_and_cm_from_instance($wiki, 'wiki');
717         $context = context_module::instance($cm->id);
718         self::validate_context($context);
720         // Determine groupid and userid to use.
721         list($groupid, $userid) = self::determine_group_and_user($cm, $wiki, $params['groupid'], $params['userid']);
723         // Get subwiki and validate it.
724         $subwiki = wiki_get_subwiki_by_group_and_user_with_validation($wiki, $groupid, $userid);
726         // Get subwiki based on group and user.
727         if ($subwiki === false) {
728             throw new moodle_exception('cannotviewfiles', 'wiki');
729         } else if ($subwiki->id != -1) {
730             // The subwiki exists, let's get the files.
731             $returnedfiles = external_util::get_area_files($context->id, 'mod_wiki', 'attachments', $subwiki->id);
732         }
734         $result = array();
735         $result['files'] = $returnedfiles;
736         $result['warnings'] = $warnings;
737         return $result;
738     }
740     /**
741      * Describes the get_subwiki_pages return value.
742      *
743      * @return external_single_structure
744      * @since Moodle 3.1
745      */
746     public static function get_subwiki_files_returns() {
748         return new external_single_structure(
749             array(
750                 'files' => new external_files('Files'),
751                 'warnings' => new external_warnings(),
752             )
753         );
754     }
756     /**
757      * Utility function for determining the groupid and userid to use.
758      *
759      * @param stdClass $cm The course module.
760      * @param stdClass $wiki The wiki.
761      * @param int $groupid Group ID. If not defined, use current group.
762      * @param int $userid User ID. If not defined, use current user.
763      * @return array Array containing the courseid and userid.
764      * @since  Moodle 3.1
765      */
766     protected static function determine_group_and_user($cm, $wiki, $groupid = -1, $userid = 0) {
767         global $USER;
769         $currentgroup = groups_get_activity_group($cm);
770         if ($currentgroup === false) {
771             // Activity doesn't use groups.
772             $groupid = 0;
773         } else if ($groupid == -1) {
774             // Use current group.
775             $groupid = !empty($currentgroup) ? $currentgroup : 0;
776         }
778         // Determine user.
779         if ($wiki->wikimode == 'collaborative') {
780             // Collaborative wikis don't use userid in subwikis.
781             $userid = 0;
782         } else if (empty($userid)) {
783             // Use current user.
784             $userid = $USER->id;
785         }
787         return array($groupid, $userid);
788     }
790     /**
791      * Describes the parameters for get_page_for_editing.
792      *
793      * @return external_function_parameters
794      * @since Moodle 3.1
795      */
796     public static function get_page_for_editing_parameters() {
797         return new external_function_parameters (
798             array(
799                 'pageid' => new external_value(PARAM_INT, 'Page ID to edit.'),
800                 'section' => new external_value(PARAM_RAW, 'Section page title.', VALUE_DEFAULT, null),
801                 'lockonly' => new external_value(PARAM_BOOL, 'Just renew lock and not return content.', VALUE_DEFAULT, false)
802             )
803         );
804     }
806     /**
807      * Locks and retrieves info of page-section to be edited.
808      *
809      * @param int $pageid The page ID.
810      * @param string $section Section page title.
811      * @param boolean $lockonly If true: Just renew lock and not return content.
812      * @return array of warnings and page data.
813      * @since Moodle 3.1
814      */
815     public static function get_page_for_editing($pageid, $section = null, $lockonly = false) {
816         global $USER;
818         $params = self::validate_parameters(self::get_page_for_editing_parameters(),
819                                             array(
820                                                 'pageid' => $pageid,
821                                                 'section' => $section,
822                                                 'lockonly' => $lockonly
823                                             )
824             );
826         $warnings = array();
828         // Get wiki page.
829         if (!$page = wiki_get_page($params['pageid'])) {
830             throw new moodle_exception('incorrectpageid', 'wiki');
831         }
833         // Get wiki instance.
834         if (!$wiki = wiki_get_wiki_from_pageid($params['pageid'])) {
835             throw new moodle_exception('incorrectwikiid', 'wiki');
836         }
838         // Get subwiki instance.
839         if (!$subwiki = wiki_get_subwiki($page->subwikiid)) {
840             throw new moodle_exception('incorrectsubwikiid', 'wiki');
841         }
843         // Permission validation.
844         $cm = get_coursemodule_from_instance('wiki', $wiki->id, $wiki->course);
845         $context = context_module::instance($cm->id);
846         self::validate_context($context);
848         if (!wiki_user_can_edit($subwiki)) {
849             throw new moodle_exception('cannoteditpage', 'wiki');
850         }
852         if (!wiki_set_lock($params['pageid'], $USER->id, $params['section'], true)) {
853             throw new moodle_exception('pageislocked', 'wiki');
854         }
856         $version = wiki_get_current_version($page->id);
857         if (empty($version)) {
858             throw new moodle_exception('versionerror', 'wiki');
859         }
861         $pagesection = array();
862         $pagesection['version'] = $version->version;
864         // Content requested to be returned.
865         if (!$lockonly) {
866             if (!is_null($params['section'])) {
867                 $content = wiki_parser_proxy::get_section($version->content, $version->contentformat, $params['section']);
868             } else {
869                 $content = $version->content;
870             }
872             $pagesection['content'] = $content;
873             $pagesection['contentformat'] = $version->contentformat;
874         }
876         $result = array();
877         $result['pagesection'] = $pagesection;
878         $result['warnings'] = $warnings;
879         return $result;
881     }
883     /**
884      * Describes the get_page_for_editing return value.
885      *
886      * @return external_single_structure
887      * @since Moodle 3.1
888      */
889     public static function get_page_for_editing_returns() {
890         return new external_single_structure(
891             array(
892                 'pagesection' => new external_single_structure(
893                     array(
894                         'content' => new external_value(PARAM_RAW, 'The contents of the page-section to be edited.',
895                             VALUE_OPTIONAL),
896                         'contentformat' => new external_value(PARAM_TEXT, 'Format of the original content of the page.',
897                             VALUE_OPTIONAL),
898                         'version' => new external_value(PARAM_INT, 'Latest version of the page.'),
899                         'warnings' => new external_warnings()
900                     )
901                 )
902             )
903         );
904     }
906     /**
907      * Describes the parameters for new_page.
908      *
909      * @return external_function_parameters
910      * @since Moodle 3.1
911      */
912     public static function new_page_parameters() {
913         return new external_function_parameters (
914             array(
915                 'title' => new external_value(PARAM_TEXT, 'New page title.'),
916                 'content' => new external_value(PARAM_RAW, 'Page contents.'),
917                 'contentformat' => new external_value(PARAM_TEXT, 'Page contents format. If an invalid format is provided, default
918                     wiki format is used.', VALUE_DEFAULT, null),
919                 'subwikiid' => new external_value(PARAM_INT, 'Page\'s subwiki ID.', VALUE_DEFAULT, null),
920                 'wikiid' => new external_value(PARAM_INT, 'Page\'s wiki ID. Used if subwiki does not exists.', VALUE_DEFAULT,
921                     null),
922                 'userid' => new external_value(PARAM_INT, 'Subwiki\'s user ID. Used if subwiki does not exists.', VALUE_DEFAULT,
923                     null),
924                 'groupid' => new external_value(PARAM_INT, 'Subwiki\'s group ID. Used if subwiki does not exists.', VALUE_DEFAULT,
925                     null)
926             )
927         );
928     }
930     /**
931      * Creates a new page.
932      *
933      * @param string $title New page title.
934      * @param string $content Page contents.
935      * @param int $contentformat Page contents format. If an invalid format is provided, default wiki format is used.
936      * @param int $subwikiid The Subwiki ID where to store the page.
937      * @param int $wikiid Page\'s wiki ID. Used if subwiki does not exists.
938      * @param int $userid Subwiki\'s user ID. Used if subwiki does not exists.
939      * @param int $groupid Subwiki\'s group ID. Used if subwiki does not exists.
940      * @return array of warnings and page data.
941      * @since Moodle 3.1
942      */
943     public static function new_page($title, $content, $contentformat = null, $subwikiid = null, $wikiid = null, $userid = null,
944         $groupid = null) {
945         global $USER;
947         $params = self::validate_parameters(self::new_page_parameters(),
948                                             array(
949                                                 'title' => $title,
950                                                 'content' => $content,
951                                                 'contentformat' => $contentformat,
952                                                 'subwikiid' => $subwikiid,
953                                                 'wikiid' => $wikiid,
954                                                 'userid' => $userid,
955                                                 'groupid' => $groupid
956                                             )
957             );
959         $warnings = array();
961         // Get wiki and subwiki instances.
962         if (!empty($params['subwikiid'])) {
963             if (!$subwiki = wiki_get_subwiki($params['subwikiid'])) {
964                 throw new moodle_exception('incorrectsubwikiid', 'wiki');
965             }
967             if (!$wiki = wiki_get_wiki($subwiki->wikiid)) {
968                 throw new moodle_exception('incorrectwikiid', 'wiki');
969             }
971             // Permission validation.
972             $cm = get_coursemodule_from_instance('wiki', $wiki->id, $wiki->course);
973             $context = context_module::instance($cm->id);
974             self::validate_context($context);
976         } else {
977             if (!$wiki = wiki_get_wiki($params['wikiid'])) {
978                 throw new moodle_exception('incorrectwikiid', 'wiki');
979             }
981             // Permission validation.
982             $cm = get_coursemodule_from_instance('wiki', $wiki->id, $wiki->course);
983             $context = context_module::instance($cm->id);
984             self::validate_context($context);
986             // Determine groupid and userid to use.
987             list($groupid, $userid) = self::determine_group_and_user($cm, $wiki, $params['groupid'], $params['userid']);
989             // Get subwiki and validate it.
990             $subwiki = wiki_get_subwiki_by_group_and_user_with_validation($wiki, $groupid, $userid);
992             if ($subwiki === false) {
993                 // User cannot view page.
994                 throw new moodle_exception('cannoteditpage', 'wiki');
995             } else if ($subwiki->id < 0) {
996                 // Subwiki needed to check edit permissions.
997                 if (!wiki_user_can_edit($subwiki)) {
998                     throw new moodle_exception('cannoteditpage', 'wiki');
999                 }
1001                 // Subwiki does not exists and it can be created.
1002                 $swid = wiki_add_subwiki($wiki->id, $groupid, $userid);
1003                 if (!$subwiki = wiki_get_subwiki($swid)) {
1004                     throw new moodle_exception('incorrectsubwikiid', 'wiki');
1005                 }
1006             }
1007         }
1009         // Subwiki needed to check edit permissions.
1010         if (!wiki_user_can_edit($subwiki)) {
1011             throw new moodle_exception('cannoteditpage', 'wiki');
1012         }
1014         if ($page = wiki_get_page_by_title($subwiki->id, $params['title'])) {
1015             throw new moodle_exception('pageexists', 'wiki');
1016         }
1018         // Ignore invalid formats and use default instead.
1019         if (!$params['contentformat'] || $wiki->forceformat) {
1020             $params['contentformat'] = $wiki->defaultformat;
1021         } else {
1022             $formats = wiki_get_formats();
1023             if (!in_array($params['contentformat'], $formats)) {
1024                 $params['contentformat'] = $wiki->defaultformat;
1025             }
1026         }
1028         $newpageid = wiki_create_page($subwiki->id, $params['title'], $params['contentformat'], $USER->id);
1030         if (!$page = wiki_get_page($newpageid)) {
1031             throw new moodle_exception('incorrectpageid', 'wiki');
1032         }
1034         // Save content.
1035         $save = wiki_save_page($page, $params['content'], $USER->id);
1037         if (!$save) {
1038             throw new moodle_exception('savingerror', 'wiki');
1039         }
1041         $result = array();
1042         $result['pageid'] = $page->id;
1043         $result['warnings'] = $warnings;
1044         return $result;
1045     }
1047     /**
1048      * Describes the new_page return value.
1049      *
1050      * @return external_single_structure
1051      * @since Moodle 3.1
1052      */
1053     public static function new_page_returns() {
1054         return new external_single_structure(
1055             array(
1056                 'pageid' => new external_value(PARAM_INT, 'New page id.'),
1057                 'warnings' => new external_warnings()
1058             )
1059         );
1060     }
1062     /**
1063      * Describes the parameters for edit_page.
1064      *
1065      * @return external_function_parameters
1066      * @since Moodle 3.1
1067      */
1068     public static function edit_page_parameters() {
1069         return new external_function_parameters (
1070             array(
1071                 'pageid' => new external_value(PARAM_INT, 'Page ID.'),
1072                 'content' => new external_value(PARAM_RAW, 'Page contents.'),
1073                 'section' => new external_value(PARAM_RAW, 'Section page title.', VALUE_DEFAULT, null)
1074             )
1075         );
1076     }
1078     /**
1079      * Edit a page contents.
1080      *
1081      * @param int $pageid The page ID.
1082      * @param string $content Page contents.
1083      * @param int $section Section to be edited.
1084      * @return array of warnings and page data.
1085      * @since Moodle 3.1
1086      */
1087     public static function edit_page($pageid, $content, $section = null) {
1088         global $USER;
1090         $params = self::validate_parameters(self::edit_page_parameters(),
1091                                             array(
1092                                                 'pageid' => $pageid,
1093                                                 'content' => $content,
1094                                                 'section' => $section
1095                                             )
1096             );
1097         $warnings = array();
1099         // Get wiki page.
1100         if (!$page = wiki_get_page($params['pageid'])) {
1101             throw new moodle_exception('incorrectpageid', 'wiki');
1102         }
1104         // Get wiki instance.
1105         if (!$wiki = wiki_get_wiki_from_pageid($params['pageid'])) {
1106             throw new moodle_exception('incorrectwikiid', 'wiki');
1107         }
1109         // Get subwiki instance.
1110         if (!$subwiki = wiki_get_subwiki($page->subwikiid)) {
1111             throw new moodle_exception('incorrectsubwikiid', 'wiki');
1112         }
1114         // Permission validation.
1115         $cm = get_coursemodule_from_instance('wiki', $wiki->id, $wiki->course);
1116         $context = context_module::instance($cm->id);
1117         self::validate_context($context);
1119         if (!wiki_user_can_edit($subwiki)) {
1120             throw new moodle_exception('cannoteditpage', 'wiki');
1121         }
1123         if (wiki_is_page_section_locked($page->id, $USER->id, $params['section'])) {
1124             throw new moodle_exception('pageislocked', 'wiki');
1125         }
1127         // Save content.
1128         if (!is_null($params['section'])) {
1129             $version = wiki_get_current_version($page->id);
1130             $content = wiki_parser_proxy::get_section($version->content, $version->contentformat, $params['section'], false);
1131             if (!$content) {
1132                 throw new moodle_exception('invalidsection', 'wiki');
1133             }
1135             $save = wiki_save_section($page, $params['section'], $params['content'], $USER->id);
1136         } else {
1137             $save = wiki_save_page($page, $params['content'], $USER->id);
1138         }
1140         wiki_delete_locks($page->id, $USER->id, $params['section']);
1142         if (!$save) {
1143             throw new moodle_exception('savingerror', 'wiki');
1144         }
1146         $result = array();
1147         $result['pageid'] = $page->id;
1148         $result['warnings'] = $warnings;
1149         return $result;
1150     }
1152     /**
1153      * Describes the edit_page return value.
1154      *
1155      * @return external_single_structure
1156      * @since Moodle 3.1
1157      */
1158     public static function edit_page_returns() {
1159         return new external_single_structure(
1160             array(
1161                 'pageid' => new external_value(PARAM_INT, 'Edited page id.'),
1162                 'warnings' => new external_warnings()
1163             )
1164         );
1165     }