ba39260253dca7b99de871644eaf3412eab02353
[moodle.git] / mod / forum / externallib.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  * External forum API
20  *
21  * @package    mod_forum
22  * @copyright  2012 Mark Nelson <markn@moodle.com>
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 defined('MOODLE_INTERNAL') || die;
28 require_once("$CFG->libdir/externallib.php");
30 class mod_forum_external extends external_api {
32     /**
33      * Describes the parameters for get_forum.
34      *
35      * @return external_function_parameters
36      * @since Moodle 2.5
37      */
38     public static function get_forums_by_courses_parameters() {
39         return new external_function_parameters (
40             array(
41                 'courseids' => new external_multiple_structure(new external_value(PARAM_INT, 'course ID',
42                         VALUE_REQUIRED, '', NULL_NOT_ALLOWED), 'Array of Course IDs', VALUE_DEFAULT, array()),
43             )
44         );
45     }
47     /**
48      * Returns a list of forums in a provided list of courses,
49      * if no list is provided all forums that the user can view
50      * will be returned.
51      *
52      * @param array $courseids the course ids
53      * @return array the forum details
54      * @since Moodle 2.5
55      */
56     public static function get_forums_by_courses($courseids = array()) {
57         global $CFG;
59         require_once($CFG->dirroot . "/mod/forum/lib.php");
61         $params = self::validate_parameters(self::get_forums_by_courses_parameters(), array('courseids' => $courseids));
63         $courses = array();
64         if (empty($params['courseids'])) {
65             $courses = enrol_get_my_courses();
66             $params['courseids'] = array_keys($courses);
67         }
69         // Array to store the forums to return.
70         $arrforums = array();
71         $warnings = array();
73         // Ensure there are courseids to loop through.
74         if (!empty($params['courseids'])) {
76             list($courses, $warnings) = external_util::validate_courses($params['courseids'], $courses);
78             // Get the forums in this course. This function checks users visibility permissions.
79             $forums = get_all_instances_in_courses("forum", $courses);
80             foreach ($forums as $forum) {
82                 $course = $courses[$forum->course];
83                 $cm = get_coursemodule_from_instance('forum', $forum->id, $course->id);
84                 $context = context_module::instance($cm->id);
86                 // Skip forums we are not allowed to see discussions.
87                 if (!has_capability('mod/forum:viewdiscussion', $context)) {
88                     continue;
89                 }
91                 $forum->name = external_format_string($forum->name, $context->id);
92                 // Format the intro before being returning using the format setting.
93                 list($forum->intro, $forum->introformat) = external_format_text($forum->intro, $forum->introformat,
94                                                                                 $context->id, 'mod_forum', 'intro', null);
95                 $forum->introfiles = external_util::get_area_files($context->id, 'mod_forum', 'intro', false, false);
96                 // Discussions count. This function does static request cache.
97                 $forum->numdiscussions = forum_count_discussions($forum, $cm, $course);
98                 $forum->cmid = $forum->coursemodule;
99                 $forum->cancreatediscussions = forum_user_can_post_discussion($forum, null, -1, $cm, $context);
100                 $forum->istracked = forum_tp_is_tracked($forum);
101                 if ($forum->istracked) {
102                     $forum->unreadpostscount = forum_tp_count_forum_unread_posts($cm, $course);
103                 }
105                 // Add the forum to the array to return.
106                 $arrforums[$forum->id] = $forum;
107             }
108         }
110         return $arrforums;
111     }
113     /**
114      * Describes the get_forum return value.
115      *
116      * @return external_single_structure
117      * @since Moodle 2.5
118      */
119     public static function get_forums_by_courses_returns() {
120         return new external_multiple_structure(
121             new external_single_structure(
122                 array(
123                     'id' => new external_value(PARAM_INT, 'Forum id'),
124                     'course' => new external_value(PARAM_INT, 'Course id'),
125                     'type' => new external_value(PARAM_TEXT, 'The forum type'),
126                     'name' => new external_value(PARAM_RAW, 'Forum name'),
127                     'intro' => new external_value(PARAM_RAW, 'The forum intro'),
128                     'introformat' => new external_format_value('intro'),
129                     'introfiles' => new external_files('Files in the introduction text', VALUE_OPTIONAL),
130                     'assessed' => new external_value(PARAM_INT, 'Aggregate type'),
131                     'assesstimestart' => new external_value(PARAM_INT, 'Assess start time'),
132                     'assesstimefinish' => new external_value(PARAM_INT, 'Assess finish time'),
133                     'scale' => new external_value(PARAM_INT, 'Scale'),
134                     'maxbytes' => new external_value(PARAM_INT, 'Maximum attachment size'),
135                     'maxattachments' => new external_value(PARAM_INT, 'Maximum number of attachments'),
136                     'forcesubscribe' => new external_value(PARAM_INT, 'Force users to subscribe'),
137                     'trackingtype' => new external_value(PARAM_INT, 'Subscription mode'),
138                     'rsstype' => new external_value(PARAM_INT, 'RSS feed for this activity'),
139                     'rssarticles' => new external_value(PARAM_INT, 'Number of RSS recent articles'),
140                     'timemodified' => new external_value(PARAM_INT, 'Time modified'),
141                     'warnafter' => new external_value(PARAM_INT, 'Post threshold for warning'),
142                     'blockafter' => new external_value(PARAM_INT, 'Post threshold for blocking'),
143                     'blockperiod' => new external_value(PARAM_INT, 'Time period for blocking'),
144                     'completiondiscussions' => new external_value(PARAM_INT, 'Student must create discussions'),
145                     'completionreplies' => new external_value(PARAM_INT, 'Student must post replies'),
146                     'completionposts' => new external_value(PARAM_INT, 'Student must post discussions or replies'),
147                     'cmid' => new external_value(PARAM_INT, 'Course module id'),
148                     'numdiscussions' => new external_value(PARAM_INT, 'Number of discussions in the forum', VALUE_OPTIONAL),
149                     'cancreatediscussions' => new external_value(PARAM_BOOL, 'If the user can create discussions', VALUE_OPTIONAL),
150                     'lockdiscussionafter' => new external_value(PARAM_INT, 'After what period a discussion is locked', VALUE_OPTIONAL),
151                     'istracked' => new external_value(PARAM_BOOL, 'If the user is tracking the forum', VALUE_OPTIONAL),
152                     'unreadpostscount' => new external_value(PARAM_INT, 'The number of unread posts for tracked forums',
153                         VALUE_OPTIONAL),
154                 ), 'forum'
155             )
156         );
157     }
159     /**
160      * Get the forum posts in the specified discussion.
161      *
162      * @param   int $discussionid
163      * @param   string $sortby
164      * @param   string $sortdirection
165      * @return  array
166      */
167     public static function get_discussion_posts(int $discussionid, ?string $sortby, ?string $sortdirection) {
168         global $USER;
169         // Validate the parameter.
170         $params = self::validate_parameters(self::get_discussion_posts_parameters(), [
171                 'discussionid' => $discussionid,
172                 'sortby' => $sortby,
173                 'sortdirection' => $sortdirection,
174             ]);
175         $warnings = [];
177         $vaultfactory = mod_forum\local\container::get_vault_factory();
179         $discussionvault = $vaultfactory->get_discussion_vault();
180         $discussion = $discussionvault->get_from_id($params['discussionid']);
182         $forumvault = $vaultfactory->get_forum_vault();
183         $forum = $forumvault->get_from_id($discussion->get_forum_id());
185         $sortby = $params['sortby'];
186         $sortdirection = $params['sortdirection'];
187         $sortallowedvalues = ['id', 'created', 'modified'];
188         $directionallowedvalues = ['ASC', 'DESC'];
190         if (!in_array(strtolower($sortby), $sortallowedvalues)) {
191             throw new invalid_parameter_exception('Invalid value for sortby parameter (value: ' . $sortby . '),' .
192                 'allowed values are: ' . implode(', ', $sortallowedvalues));
193         }
195         $sortdirection = strtoupper($sortdirection);
196         if (!in_array($sortdirection, $directionallowedvalues)) {
197             throw new invalid_parameter_exception('Invalid value for sortdirection parameter (value: ' . $sortdirection . '),' .
198                 'allowed values are: ' . implode(',', $directionallowedvalues));
199         }
201         $managerfactory = mod_forum\local\container::get_manager_factory();
202         $capabilitymanager = $managerfactory->get_capability_manager($forum);
204         $postvault = $vaultfactory->get_post_vault();
205         $posts = $postvault->get_from_discussion_id(
206                 $USER,
207                 $discussion->get_id(),
208                 $capabilitymanager->can_view_any_private_reply($USER),
209                 "{$sortby} {$sortdirection}"
210             );
212         $builderfactory = mod_forum\local\container::get_builder_factory();
213         $postbuilder = $builderfactory->get_exported_posts_builder();
215         $legacydatamapper = mod_forum\local\container::get_legacy_data_mapper_factory();
217         return [
218             'posts' => $postbuilder->build($USER, [$forum], [$discussion], $posts),
219             'ratinginfo' => \core_rating\external\util::get_rating_info(
220                 $legacydatamapper->get_forum_data_mapper()->to_legacy_object($forum),
221                 $forum->get_context(),
222                 'mod_forum',
223                 'post',
224                 $legacydatamapper->get_post_data_mapper()->to_legacy_objects($posts)
225             ),
226             'warnings' => $warnings,
227         ];
228     }
230     /**
231      * Describe the post parameters.
232      *
233      * @return external_function_parameters
234      */
235     public static function get_discussion_posts_parameters() {
236         return new external_function_parameters ([
237             'discussionid' => new external_value(PARAM_INT, 'The ID of the discussion from which to fetch posts.', VALUE_REQUIRED),
238             'sortby' => new external_value(PARAM_ALPHA, 'Sort by this element: id, created or modified', VALUE_DEFAULT, 'created'),
239             'sortdirection' => new external_value(PARAM_ALPHA, 'Sort direction: ASC or DESC', VALUE_DEFAULT, 'DESC')
240         ]);
241     }
243     /**
244      * Describe the post return format.
245      *
246      * @return external_single_structure
247      */
248     public static function get_discussion_posts_returns() {
249         return new external_single_structure([
250             'posts' => new external_multiple_structure(\mod_forum\local\exporters\post::get_read_structure()),
251             'ratinginfo' => \core_rating\external\util::external_ratings_structure(),
252             'warnings' => new external_warnings()
253         ]);
254     }
256     /**
257      * Describes the parameters for get_forum_discussion_posts.
258      *
259      * @return external_function_parameters
260      * @since Moodle 2.7
261      */
262     public static function get_forum_discussion_posts_parameters() {
263         return new external_function_parameters (
264             array(
265                 'discussionid' => new external_value(PARAM_INT, 'discussion ID', VALUE_REQUIRED),
266                 'sortby' => new external_value(PARAM_ALPHA,
267                     'sort by this element: id, created or modified', VALUE_DEFAULT, 'created'),
268                 'sortdirection' => new external_value(PARAM_ALPHA, 'sort direction: ASC or DESC', VALUE_DEFAULT, 'DESC')
269             )
270         );
271     }
273     /**
274      * Returns a list of forum posts for a discussion
275      *
276      * @param int $discussionid the post ids
277      * @param string $sortby sort by this element (id, created or modified)
278      * @param string $sortdirection sort direction: ASC or DESC
279      *
280      * @return array the forum post details
281      * @since Moodle 2.7
282      * @todo MDL-65252 This will be removed in Moodle 4.1
283      */
284     public static function get_forum_discussion_posts($discussionid, $sortby = "created", $sortdirection = "DESC") {
285         global $CFG, $DB, $USER, $PAGE;
287         $posts = array();
288         $warnings = array();
290         // Validate the parameter.
291         $params = self::validate_parameters(self::get_forum_discussion_posts_parameters(),
292             array(
293                 'discussionid' => $discussionid,
294                 'sortby' => $sortby,
295                 'sortdirection' => $sortdirection));
297         // Compact/extract functions are not recommended.
298         $discussionid   = $params['discussionid'];
299         $sortby         = $params['sortby'];
300         $sortdirection  = $params['sortdirection'];
302         $sortallowedvalues = array('id', 'created', 'modified');
303         if (!in_array($sortby, $sortallowedvalues)) {
304             throw new invalid_parameter_exception('Invalid value for sortby parameter (value: ' . $sortby . '),' .
305                 'allowed values are: ' . implode(',', $sortallowedvalues));
306         }
308         $sortdirection = strtoupper($sortdirection);
309         $directionallowedvalues = array('ASC', 'DESC');
310         if (!in_array($sortdirection, $directionallowedvalues)) {
311             throw new invalid_parameter_exception('Invalid value for sortdirection parameter (value: ' . $sortdirection . '),' .
312                 'allowed values are: ' . implode(',', $directionallowedvalues));
313         }
315         $discussion = $DB->get_record('forum_discussions', array('id' => $discussionid), '*', MUST_EXIST);
316         $forum = $DB->get_record('forum', array('id' => $discussion->forum), '*', MUST_EXIST);
317         $course = $DB->get_record('course', array('id' => $forum->course), '*', MUST_EXIST);
318         $cm = get_coursemodule_from_instance('forum', $forum->id, $course->id, false, MUST_EXIST);
320         // Validate the module context. It checks everything that affects the module visibility (including groupings, etc..).
321         $modcontext = context_module::instance($cm->id);
322         self::validate_context($modcontext);
324         // This require must be here, see mod/forum/discuss.php.
325         require_once($CFG->dirroot . "/mod/forum/lib.php");
327         // Check they have the view forum capability.
328         require_capability('mod/forum:viewdiscussion', $modcontext, null, true, 'noviewdiscussionspermission', 'forum');
330         if (! $post = forum_get_post_full($discussion->firstpost)) {
331             throw new moodle_exception('notexists', 'forum');
332         }
334         // This function check groups, qanda, timed discussions, etc.
335         if (!forum_user_can_see_post($forum, $discussion, $post, null, $cm)) {
336             throw new moodle_exception('noviewdiscussionspermission', 'forum');
337         }
339         $canviewfullname = has_capability('moodle/site:viewfullnames', $modcontext);
341         // We will add this field in the response.
342         $canreply = forum_user_can_post($forum, $discussion, $USER, $cm, $course, $modcontext);
344         $forumtracked = forum_tp_is_tracked($forum);
346         $sort = 'p.' . $sortby . ' ' . $sortdirection;
347         $allposts = forum_get_all_discussion_posts($discussion->id, $sort, $forumtracked);
349         foreach ($allposts as $post) {
350             if (!forum_user_can_see_post($forum, $discussion, $post, null, $cm, false)) {
351                 $warning = array();
352                 $warning['item'] = 'post';
353                 $warning['itemid'] = $post->id;
354                 $warning['warningcode'] = '1';
355                 $warning['message'] = 'You can\'t see this post';
356                 $warnings[] = $warning;
357                 continue;
358             }
360             // Function forum_get_all_discussion_posts adds postread field.
361             // Note that the value returned can be a boolean or an integer. The WS expects a boolean.
362             if (empty($post->postread)) {
363                 $post->postread = false;
364             } else {
365                 $post->postread = true;
366             }
368             $post->isprivatereply = !empty($post->privatereplyto);
370             $post->canreply = $canreply;
371             if (!empty($post->children)) {
372                 $post->children = array_keys($post->children);
373             } else {
374                 $post->children = array();
375             }
377             if (!forum_user_can_see_post($forum, $discussion, $post, null, $cm)) {
378                 // The post is available, but has been marked as deleted.
379                 // It will still be available but filled with a placeholder.
380                 $post->userid = null;
381                 $post->userfullname = null;
382                 $post->userpictureurl = null;
384                 $post->subject = get_string('privacy:request:delete:post:subject', 'mod_forum');
385                 $post->message = get_string('privacy:request:delete:post:message', 'mod_forum');
387                 $post->deleted = true;
388                 $posts[] = $post;
390                 continue;
391             }
392             $post->deleted = false;
394             if (forum_is_author_hidden($post, $forum)) {
395                 $post->userid = null;
396                 $post->userfullname = null;
397                 $post->userpictureurl = null;
398             } else {
399                 $user = new stdclass();
400                 $user->id = $post->userid;
401                 $user = username_load_fields_from_object($user, $post, null, array('picture', 'imagealt', 'email'));
402                 $post->userfullname = fullname($user, $canviewfullname);
404                 $userpicture = new user_picture($user);
405                 $userpicture->size = 1; // Size f1.
406                 $post->userpictureurl = $userpicture->get_url($PAGE)->out(false);
407             }
409             $post->subject = external_format_string($post->subject, $modcontext->id);
410             // Rewrite embedded images URLs.
411             list($post->message, $post->messageformat) =
412                 external_format_text($post->message, $post->messageformat, $modcontext->id, 'mod_forum', 'post', $post->id);
414             // List attachments.
415             if (!empty($post->attachment)) {
416                 $post->attachments = external_util::get_area_files($modcontext->id, 'mod_forum', 'attachment', $post->id);
417             }
418             $messageinlinefiles = external_util::get_area_files($modcontext->id, 'mod_forum', 'post', $post->id);
419             if (!empty($messageinlinefiles)) {
420                 $post->messageinlinefiles = $messageinlinefiles;
421             }
423             $posts[] = $post;
424         }
426         $result = array();
427         $result['posts'] = $posts;
428         $result['ratinginfo'] = \core_rating\external\util::get_rating_info($forum, $modcontext, 'mod_forum', 'post', $posts);
429         $result['warnings'] = $warnings;
430         return $result;
431     }
433     /**
434      * Describes the get_forum_discussion_posts return value.
435      *
436      * @return external_single_structure
437      * @since Moodle 2.7
438      */
439     public static function get_forum_discussion_posts_returns() {
440         return new external_single_structure(
441             array(
442                 'posts' => new external_multiple_structure(
443                         new external_single_structure(
444                             array(
445                                 'id' => new external_value(PARAM_INT, 'Post id'),
446                                 'discussion' => new external_value(PARAM_INT, 'Discussion id'),
447                                 'parent' => new external_value(PARAM_INT, 'Parent id'),
448                                 'userid' => new external_value(PARAM_INT, 'User id'),
449                                 'created' => new external_value(PARAM_INT, 'Creation time'),
450                                 'modified' => new external_value(PARAM_INT, 'Time modified'),
451                                 'mailed' => new external_value(PARAM_INT, 'Mailed?'),
452                                 'subject' => new external_value(PARAM_TEXT, 'The post subject'),
453                                 'message' => new external_value(PARAM_RAW, 'The post message'),
454                                 'messageformat' => new external_format_value('message'),
455                                 'messagetrust' => new external_value(PARAM_INT, 'Can we trust?'),
456                                 'messageinlinefiles' => new external_files('post message inline files', VALUE_OPTIONAL),
457                                 'attachment' => new external_value(PARAM_RAW, 'Has attachments?'),
458                                 'attachments' => new external_files('attachments', VALUE_OPTIONAL),
459                                 'totalscore' => new external_value(PARAM_INT, 'The post message total score'),
460                                 'mailnow' => new external_value(PARAM_INT, 'Mail now?'),
461                                 'children' => new external_multiple_structure(new external_value(PARAM_INT, 'children post id')),
462                                 'canreply' => new external_value(PARAM_BOOL, 'The user can reply to posts?'),
463                                 'postread' => new external_value(PARAM_BOOL, 'The post was read'),
464                                 'userfullname' => new external_value(PARAM_TEXT, 'Post author full name'),
465                                 'userpictureurl' => new external_value(PARAM_URL, 'Post author picture.', VALUE_OPTIONAL),
466                                 'deleted' => new external_value(PARAM_BOOL, 'This post has been removed.'),
467                                 'isprivatereply' => new external_value(PARAM_BOOL, 'The post is a private reply'),
468                             ), 'post'
469                         )
470                     ),
471                 'ratinginfo' => \core_rating\external\util::external_ratings_structure(),
472                 'warnings' => new external_warnings()
473             )
474         );
475     }
477     /**
478      * Mark the get_forum_discussion_posts web service as deprecated.
479      *
480      * @return  bool
481      */
482     public static function get_forum_discussion_posts_is_deprecated() {
483         return true;
484     }
486     /**
487      * Describes the parameters for get_forum_discussions_paginated.
488      *
489      * @return external_function_parameters
490      * @since Moodle 2.8
491      */
492     public static function get_forum_discussions_paginated_parameters() {
493         return new external_function_parameters (
494             array(
495                 'forumid' => new external_value(PARAM_INT, 'forum instance id', VALUE_REQUIRED),
496                 'sortby' => new external_value(PARAM_ALPHA,
497                     'sort by this element: id, timemodified, timestart or timeend', VALUE_DEFAULT, 'timemodified'),
498                 'sortdirection' => new external_value(PARAM_ALPHA, 'sort direction: ASC or DESC', VALUE_DEFAULT, 'DESC'),
499                 'page' => new external_value(PARAM_INT, 'current page', VALUE_DEFAULT, -1),
500                 'perpage' => new external_value(PARAM_INT, 'items per page', VALUE_DEFAULT, 0),
501             )
502         );
503     }
505     /**
506      * Returns a list of forum discussions optionally sorted and paginated.
507      *
508      * @param int $forumid the forum instance id
509      * @param string $sortby sort by this element (id, timemodified, timestart or timeend)
510      * @param string $sortdirection sort direction: ASC or DESC
511      * @param int $page page number
512      * @param int $perpage items per page
513      *
514      * @return array the forum discussion details including warnings
515      * @since Moodle 2.8
516      */
517     public static function get_forum_discussions_paginated($forumid, $sortby = 'timemodified', $sortdirection = 'DESC',
518                                                     $page = -1, $perpage = 0) {
519         global $CFG, $DB, $USER, $PAGE;
521         require_once($CFG->dirroot . "/mod/forum/lib.php");
523         $warnings = array();
524         $discussions = array();
526         $params = self::validate_parameters(self::get_forum_discussions_paginated_parameters(),
527             array(
528                 'forumid' => $forumid,
529                 'sortby' => $sortby,
530                 'sortdirection' => $sortdirection,
531                 'page' => $page,
532                 'perpage' => $perpage
533             )
534         );
536         // Compact/extract functions are not recommended.
537         $forumid        = $params['forumid'];
538         $sortby         = $params['sortby'];
539         $sortdirection  = $params['sortdirection'];
540         $page           = $params['page'];
541         $perpage        = $params['perpage'];
543         $sortallowedvalues = array('id', 'timemodified', 'timestart', 'timeend');
544         if (!in_array($sortby, $sortallowedvalues)) {
545             throw new invalid_parameter_exception('Invalid value for sortby parameter (value: ' . $sortby . '),' .
546                 'allowed values are: ' . implode(',', $sortallowedvalues));
547         }
549         $sortdirection = strtoupper($sortdirection);
550         $directionallowedvalues = array('ASC', 'DESC');
551         if (!in_array($sortdirection, $directionallowedvalues)) {
552             throw new invalid_parameter_exception('Invalid value for sortdirection parameter (value: ' . $sortdirection . '),' .
553                 'allowed values are: ' . implode(',', $directionallowedvalues));
554         }
556         $forum = $DB->get_record('forum', array('id' => $forumid), '*', MUST_EXIST);
557         $course = $DB->get_record('course', array('id' => $forum->course), '*', MUST_EXIST);
558         $cm = get_coursemodule_from_instance('forum', $forum->id, $course->id, false, MUST_EXIST);
560         // Validate the module context. It checks everything that affects the module visibility (including groupings, etc..).
561         $modcontext = context_module::instance($cm->id);
562         self::validate_context($modcontext);
564         // Check they have the view forum capability.
565         require_capability('mod/forum:viewdiscussion', $modcontext, null, true, 'noviewdiscussionspermission', 'forum');
567         $sort = 'd.pinned DESC, d.' . $sortby . ' ' . $sortdirection;
568         $alldiscussions = forum_get_discussions($cm, $sort, true, -1, -1, true, $page, $perpage, FORUM_POSTS_ALL_USER_GROUPS);
570         if ($alldiscussions) {
571             $canviewfullname = has_capability('moodle/site:viewfullnames', $modcontext);
573             // Get the unreads array, this takes a forum id and returns data for all discussions.
574             $unreads = array();
575             if ($cantrack = forum_tp_can_track_forums($forum)) {
576                 if ($forumtracked = forum_tp_is_tracked($forum)) {
577                     $unreads = forum_get_discussions_unread($cm);
578                 }
579             }
580             // The forum function returns the replies for all the discussions in a given forum.
581             $canseeprivatereplies = has_capability('mod/forum:readprivatereplies', $modcontext);
582             $replies = forum_count_discussion_replies($forumid, $sort, -1, $page, $perpage, $canseeprivatereplies);
584             foreach ($alldiscussions as $discussion) {
586                 // This function checks for qanda forums.
587                 // Note that the forum_get_discussions returns as id the post id, not the discussion id so we need to do this.
588                 $discussionrec = clone $discussion;
589                 $discussionrec->id = $discussion->discussion;
590                 if (!forum_user_can_see_discussion($forum, $discussionrec, $modcontext)) {
591                     $warning = array();
592                     // Function forum_get_discussions returns forum_posts ids not forum_discussions ones.
593                     $warning['item'] = 'post';
594                     $warning['itemid'] = $discussion->id;
595                     $warning['warningcode'] = '1';
596                     $warning['message'] = 'You can\'t see this discussion';
597                     $warnings[] = $warning;
598                     continue;
599                 }
601                 $discussion->numunread = 0;
602                 if ($cantrack && $forumtracked) {
603                     if (isset($unreads[$discussion->discussion])) {
604                         $discussion->numunread = (int) $unreads[$discussion->discussion];
605                     }
606                 }
608                 $discussion->numreplies = 0;
609                 if (!empty($replies[$discussion->discussion])) {
610                     $discussion->numreplies = (int) $replies[$discussion->discussion]->replies;
611                 }
613                 $discussion->name = external_format_string($discussion->name, $modcontext->id);
614                 $discussion->subject = external_format_string($discussion->subject, $modcontext->id);
615                 // Rewrite embedded images URLs.
616                 list($discussion->message, $discussion->messageformat) =
617                     external_format_text($discussion->message, $discussion->messageformat,
618                                             $modcontext->id, 'mod_forum', 'post', $discussion->id);
620                 // List attachments.
621                 if (!empty($discussion->attachment)) {
622                     $discussion->attachments = external_util::get_area_files($modcontext->id, 'mod_forum', 'attachment',
623                                                                                 $discussion->id);
624                 }
625                 $messageinlinefiles = external_util::get_area_files($modcontext->id, 'mod_forum', 'post', $discussion->id);
626                 if (!empty($messageinlinefiles)) {
627                     $discussion->messageinlinefiles = $messageinlinefiles;
628                 }
630                 $discussion->locked = forum_discussion_is_locked($forum, $discussion);
631                 $discussion->canreply = forum_user_can_post($forum, $discussion, $USER, $cm, $course, $modcontext);
633                 if (forum_is_author_hidden($discussion, $forum)) {
634                     $discussion->userid = null;
635                     $discussion->userfullname = null;
636                     $discussion->userpictureurl = null;
638                     $discussion->usermodified = null;
639                     $discussion->usermodifiedfullname = null;
640                     $discussion->usermodifiedpictureurl = null;
641                 } else {
642                     $picturefields = explode(',', user_picture::fields());
644                     // Load user objects from the results of the query.
645                     $user = new stdclass();
646                     $user->id = $discussion->userid;
647                     $user = username_load_fields_from_object($user, $discussion, null, $picturefields);
648                     // Preserve the id, it can be modified by username_load_fields_from_object.
649                     $user->id = $discussion->userid;
650                     $discussion->userfullname = fullname($user, $canviewfullname);
652                     $userpicture = new user_picture($user);
653                     $userpicture->size = 1; // Size f1.
654                     $discussion->userpictureurl = $userpicture->get_url($PAGE)->out(false);
656                     $usermodified = new stdclass();
657                     $usermodified->id = $discussion->usermodified;
658                     $usermodified = username_load_fields_from_object($usermodified, $discussion, 'um', $picturefields);
659                     // Preserve the id (it can be overwritten due to the prefixed $picturefields).
660                     $usermodified->id = $discussion->usermodified;
661                     $discussion->usermodifiedfullname = fullname($usermodified, $canviewfullname);
663                     $userpicture = new user_picture($usermodified);
664                     $userpicture->size = 1; // Size f1.
665                     $discussion->usermodifiedpictureurl = $userpicture->get_url($PAGE)->out(false);
666                 }
668                 $discussions[] = $discussion;
669             }
670         }
672         $result = array();
673         $result['discussions'] = $discussions;
674         $result['warnings'] = $warnings;
675         return $result;
677     }
679     /**
680      * Describes the get_forum_discussions_paginated return value.
681      *
682      * @return external_single_structure
683      * @since Moodle 2.8
684      */
685     public static function get_forum_discussions_paginated_returns() {
686         return new external_single_structure(
687             array(
688                 'discussions' => new external_multiple_structure(
689                         new external_single_structure(
690                             array(
691                                 'id' => new external_value(PARAM_INT, 'Post id'),
692                                 'name' => new external_value(PARAM_TEXT, 'Discussion name'),
693                                 'groupid' => new external_value(PARAM_INT, 'Group id'),
694                                 'timemodified' => new external_value(PARAM_INT, 'Time modified'),
695                                 'usermodified' => new external_value(PARAM_INT, 'The id of the user who last modified'),
696                                 'timestart' => new external_value(PARAM_INT, 'Time discussion can start'),
697                                 'timeend' => new external_value(PARAM_INT, 'Time discussion ends'),
698                                 'discussion' => new external_value(PARAM_INT, 'Discussion id'),
699                                 'parent' => new external_value(PARAM_INT, 'Parent id'),
700                                 'userid' => new external_value(PARAM_INT, 'User who started the discussion id'),
701                                 'created' => new external_value(PARAM_INT, 'Creation time'),
702                                 'modified' => new external_value(PARAM_INT, 'Time modified'),
703                                 'mailed' => new external_value(PARAM_INT, 'Mailed?'),
704                                 'subject' => new external_value(PARAM_TEXT, 'The post subject'),
705                                 'message' => new external_value(PARAM_RAW, 'The post message'),
706                                 'messageformat' => new external_format_value('message'),
707                                 'messagetrust' => new external_value(PARAM_INT, 'Can we trust?'),
708                                 'messageinlinefiles' => new external_files('post message inline files', VALUE_OPTIONAL),
709                                 'attachment' => new external_value(PARAM_RAW, 'Has attachments?'),
710                                 'attachments' => new external_files('attachments', VALUE_OPTIONAL),
711                                 'totalscore' => new external_value(PARAM_INT, 'The post message total score'),
712                                 'mailnow' => new external_value(PARAM_INT, 'Mail now?'),
713                                 'userfullname' => new external_value(PARAM_TEXT, 'Post author full name'),
714                                 'usermodifiedfullname' => new external_value(PARAM_TEXT, 'Post modifier full name'),
715                                 'userpictureurl' => new external_value(PARAM_URL, 'Post author picture.'),
716                                 'usermodifiedpictureurl' => new external_value(PARAM_URL, 'Post modifier picture.'),
717                                 'numreplies' => new external_value(PARAM_TEXT, 'The number of replies in the discussion'),
718                                 'numunread' => new external_value(PARAM_INT, 'The number of unread discussions.'),
719                                 'pinned' => new external_value(PARAM_BOOL, 'Is the discussion pinned'),
720                                 'locked' => new external_value(PARAM_BOOL, 'Is the discussion locked'),
721                                 'canreply' => new external_value(PARAM_BOOL, 'Can the user reply to the discussion'),
722                             ), 'post'
723                         )
724                     ),
725                 'warnings' => new external_warnings()
726             )
727         );
728     }
730     /**
731      * Returns description of method parameters
732      *
733      * @return external_function_parameters
734      * @since Moodle 2.9
735      */
736     public static function view_forum_parameters() {
737         return new external_function_parameters(
738             array(
739                 'forumid' => new external_value(PARAM_INT, 'forum instance id')
740             )
741         );
742     }
744     /**
745      * Trigger the course module viewed event and update the module completion status.
746      *
747      * @param int $forumid the forum instance id
748      * @return array of warnings and status result
749      * @since Moodle 2.9
750      * @throws moodle_exception
751      */
752     public static function view_forum($forumid) {
753         global $DB, $CFG;
754         require_once($CFG->dirroot . "/mod/forum/lib.php");
756         $params = self::validate_parameters(self::view_forum_parameters(),
757                                             array(
758                                                 'forumid' => $forumid
759                                             ));
760         $warnings = array();
762         // Request and permission validation.
763         $forum = $DB->get_record('forum', array('id' => $params['forumid']), '*', MUST_EXIST);
764         list($course, $cm) = get_course_and_cm_from_instance($forum, 'forum');
766         $context = context_module::instance($cm->id);
767         self::validate_context($context);
769         require_capability('mod/forum:viewdiscussion', $context, null, true, 'noviewdiscussionspermission', 'forum');
771         // Call the forum/lib API.
772         forum_view($forum, $course, $cm, $context);
774         $result = array();
775         $result['status'] = true;
776         $result['warnings'] = $warnings;
777         return $result;
778     }
780     /**
781      * Returns description of method result value
782      *
783      * @return external_description
784      * @since Moodle 2.9
785      */
786     public static function view_forum_returns() {
787         return new external_single_structure(
788             array(
789                 'status' => new external_value(PARAM_BOOL, 'status: true if success'),
790                 'warnings' => new external_warnings()
791             )
792         );
793     }
795     /**
796      * Returns description of method parameters
797      *
798      * @return external_function_parameters
799      * @since Moodle 2.9
800      */
801     public static function view_forum_discussion_parameters() {
802         return new external_function_parameters(
803             array(
804                 'discussionid' => new external_value(PARAM_INT, 'discussion id')
805             )
806         );
807     }
809     /**
810      * Trigger the discussion viewed event.
811      *
812      * @param int $discussionid the discussion id
813      * @return array of warnings and status result
814      * @since Moodle 2.9
815      * @throws moodle_exception
816      */
817     public static function view_forum_discussion($discussionid) {
818         global $DB, $CFG, $USER;
819         require_once($CFG->dirroot . "/mod/forum/lib.php");
821         $params = self::validate_parameters(self::view_forum_discussion_parameters(),
822                                             array(
823                                                 'discussionid' => $discussionid
824                                             ));
825         $warnings = array();
827         $discussion = $DB->get_record('forum_discussions', array('id' => $params['discussionid']), '*', MUST_EXIST);
828         $forum = $DB->get_record('forum', array('id' => $discussion->forum), '*', MUST_EXIST);
829         list($course, $cm) = get_course_and_cm_from_instance($forum, 'forum');
831         // Validate the module context. It checks everything that affects the module visibility (including groupings, etc..).
832         $modcontext = context_module::instance($cm->id);
833         self::validate_context($modcontext);
835         require_capability('mod/forum:viewdiscussion', $modcontext, null, true, 'noviewdiscussionspermission', 'forum');
837         // Call the forum/lib API.
838         forum_discussion_view($modcontext, $forum, $discussion);
840         // Mark as read if required.
841         if (!$CFG->forum_usermarksread && forum_tp_is_tracked($forum)) {
842             forum_tp_mark_discussion_read($USER, $discussion->id);
843         }
845         $result = array();
846         $result['status'] = true;
847         $result['warnings'] = $warnings;
848         return $result;
849     }
851     /**
852      * Returns description of method result value
853      *
854      * @return external_description
855      * @since Moodle 2.9
856      */
857     public static function view_forum_discussion_returns() {
858         return new external_single_structure(
859             array(
860                 'status' => new external_value(PARAM_BOOL, 'status: true if success'),
861                 'warnings' => new external_warnings()
862             )
863         );
864     }
866     /**
867      * Returns description of method parameters
868      *
869      * @return external_function_parameters
870      * @since Moodle 3.0
871      */
872     public static function add_discussion_post_parameters() {
873         return new external_function_parameters(
874             array(
875                 'postid' => new external_value(PARAM_INT, 'the post id we are going to reply to
876                                                 (can be the initial discussion post'),
877                 'subject' => new external_value(PARAM_TEXT, 'new post subject'),
878                 'message' => new external_value(PARAM_RAW, 'new post message (only html format allowed)'),
879                 'options' => new external_multiple_structure (
880                     new external_single_structure(
881                         array(
882                             'name' => new external_value(PARAM_ALPHANUM,
883                                         'The allowed keys (value format) are:
884                                         discussionsubscribe (bool); subscribe to the discussion?, default to true
885                                         private (bool); make this reply private to the author of the parent post, default to false.
886                                         inlineattachmentsid              (int); the draft file area id for inline attachments
887                                         attachmentsid       (int); the draft file area id for attachments
888                             '),
889                             'value' => new external_value(PARAM_RAW, 'the value of the option,
890                                                             this param is validated in the external function.'
891                         )
892                     )
893                 ), 'Options', VALUE_DEFAULT, array())
894             )
895         );
896     }
898     /**
899      * Create new posts into an existing discussion.
900      *
901      * @param int $postid the post id we are going to reply to
902      * @param string $subject new post subject
903      * @param string $message new post message (only html format allowed)
904      * @param array $options optional settings
905      * @return array of warnings and the new post id
906      * @since Moodle 3.0
907      * @throws moodle_exception
908      */
909     public static function add_discussion_post($postid, $subject, $message, $options = array()) {
910         global $DB, $CFG, $USER;
911         require_once($CFG->dirroot . "/mod/forum/lib.php");
913         $params = self::validate_parameters(self::add_discussion_post_parameters(),
914             array(
915                 'postid' => $postid,
916                 'subject' => $subject,
917                 'message' => $message,
918                 'options' => $options
919             )
920         );
922         $warnings = array();
924         if (!$parent = forum_get_post_full($params['postid'])) {
925             throw new moodle_exception('invalidparentpostid', 'forum');
926         }
928         if (!$discussion = $DB->get_record("forum_discussions", array("id" => $parent->discussion))) {
929             throw new moodle_exception('notpartofdiscussion', 'forum');
930         }
932         // Request and permission validation.
933         $forum = $DB->get_record('forum', array('id' => $discussion->forum), '*', MUST_EXIST);
934         list($course, $cm) = get_course_and_cm_from_instance($forum, 'forum');
936         $context = context_module::instance($cm->id);
937         self::validate_context($context);
939         // Validate options.
940         $options = array(
941             'discussionsubscribe' => true,
942             'private'             => false,
943             'inlineattachmentsid' => 0,
944             'attachmentsid' => null
945         );
946         foreach ($params['options'] as $option) {
947             $name = trim($option['name']);
948             switch ($name) {
949                 case 'discussionsubscribe':
950                     $value = clean_param($option['value'], PARAM_BOOL);
951                     break;
952                 case 'private':
953                     $value = clean_param($option['value'], PARAM_BOOL);
954                     break;
955                 case 'inlineattachmentsid':
956                     $value = clean_param($option['value'], PARAM_INT);
957                     break;
958                 case 'attachmentsid':
959                     $value = clean_param($option['value'], PARAM_INT);
960                     // Ensure that the user has permissions to create attachments.
961                     if (!has_capability('mod/forum:createattachment', $context)) {
962                         $value = 0;
963                     }
964                     break;
965                 default:
966                     throw new moodle_exception('errorinvalidparam', 'webservice', '', $name);
967             }
968             $options[$name] = $value;
969         }
971         if (!forum_user_can_post($forum, $discussion, $USER, $cm, $course, $context)) {
972             throw new moodle_exception('nopostforum', 'forum');
973         }
975         $thresholdwarning = forum_check_throttling($forum, $cm);
976         forum_check_blocking_threshold($thresholdwarning);
978         // Create the post.
979         $post = new stdClass();
980         $post->discussion = $discussion->id;
981         $post->parent = $parent->id;
982         $post->subject = $params['subject'];
983         $post->message = $params['message'];
984         $post->messageformat = FORMAT_HTML;   // Force formatting for now.
985         $post->messagetrust = trusttext_trusted($context);
986         $post->itemid = $options['inlineattachmentsid'];
987         $post->attachments = $options['attachmentsid'];
988         $post->isprivatereply = $options['private'];
989         $post->deleted = 0;
990         $fakemform = $post->attachments;
991         if ($postid = forum_add_new_post($post, $fakemform)) {
993             $post->id = $postid;
995             // Trigger events and completion.
996             $params = array(
997                 'context' => $context,
998                 'objectid' => $post->id,
999                 'other' => array(
1000                     'discussionid' => $discussion->id,
1001                     'forumid' => $forum->id,
1002                     'forumtype' => $forum->type,
1003                 )
1004             );
1005             $event = \mod_forum\event\post_created::create($params);
1006             $event->add_record_snapshot('forum_posts', $post);
1007             $event->add_record_snapshot('forum_discussions', $discussion);
1008             $event->trigger();
1010             // Update completion state.
1011             $completion = new completion_info($course);
1012             if ($completion->is_enabled($cm) &&
1013                     ($forum->completionreplies || $forum->completionposts)) {
1014                 $completion->update_state($cm, COMPLETION_COMPLETE);
1015             }
1017             $settings = new stdClass();
1018             $settings->discussionsubscribe = $options['discussionsubscribe'];
1019             forum_post_subscription($settings, $forum, $discussion);
1020         } else {
1021             throw new moodle_exception('couldnotadd', 'forum');
1022         }
1024         $result = array();
1025         $result['postid'] = $postid;
1026         $result['warnings'] = $warnings;
1027         return $result;
1028     }
1030     /**
1031      * Returns description of method result value
1032      *
1033      * @return external_description
1034      * @since Moodle 3.0
1035      */
1036     public static function add_discussion_post_returns() {
1037         return new external_single_structure(
1038             array(
1039                 'postid' => new external_value(PARAM_INT, 'new post id'),
1040                 'warnings' => new external_warnings()
1041             )
1042         );
1043     }
1045     /**
1046      * Returns description of method parameters
1047      *
1048      * @return external_function_parameters
1049      * @since Moodle 3.0
1050      */
1051     public static function add_discussion_parameters() {
1052         return new external_function_parameters(
1053             array(
1054                 'forumid' => new external_value(PARAM_INT, 'Forum instance ID'),
1055                 'subject' => new external_value(PARAM_TEXT, 'New Discussion subject'),
1056                 'message' => new external_value(PARAM_RAW, 'New Discussion message (only html format allowed)'),
1057                 'groupid' => new external_value(PARAM_INT, 'The group, default to 0', VALUE_DEFAULT, 0),
1058                 'options' => new external_multiple_structure (
1059                     new external_single_structure(
1060                         array(
1061                             'name' => new external_value(PARAM_ALPHANUM,
1062                                         'The allowed keys (value format) are:
1063                                         discussionsubscribe (bool); subscribe to the discussion?, default to true
1064                                         discussionpinned    (bool); is the discussion pinned, default to false
1065                                         inlineattachmentsid              (int); the draft file area id for inline attachments
1066                                         attachmentsid       (int); the draft file area id for attachments
1067                             '),
1068                             'value' => new external_value(PARAM_RAW, 'The value of the option,
1069                                                             This param is validated in the external function.'
1070                         )
1071                     )
1072                 ), 'Options', VALUE_DEFAULT, array())
1073             )
1074         );
1075     }
1077     /**
1078      * Add a new discussion into an existing forum.
1079      *
1080      * @param int $forumid the forum instance id
1081      * @param string $subject new discussion subject
1082      * @param string $message new discussion message (only html format allowed)
1083      * @param int $groupid the user course group
1084      * @param array $options optional settings
1085      * @return array of warnings and the new discussion id
1086      * @since Moodle 3.0
1087      * @throws moodle_exception
1088      */
1089     public static function add_discussion($forumid, $subject, $message, $groupid = 0, $options = array()) {
1090         global $DB, $CFG;
1091         require_once($CFG->dirroot . "/mod/forum/lib.php");
1093         $params = self::validate_parameters(self::add_discussion_parameters(),
1094                                             array(
1095                                                 'forumid' => $forumid,
1096                                                 'subject' => $subject,
1097                                                 'message' => $message,
1098                                                 'groupid' => $groupid,
1099                                                 'options' => $options
1100                                             ));
1102         $warnings = array();
1104         // Request and permission validation.
1105         $forum = $DB->get_record('forum', array('id' => $params['forumid']), '*', MUST_EXIST);
1106         list($course, $cm) = get_course_and_cm_from_instance($forum, 'forum');
1108         $context = context_module::instance($cm->id);
1109         self::validate_context($context);
1111         // Validate options.
1112         $options = array(
1113             'discussionsubscribe' => true,
1114             'discussionpinned' => false,
1115             'inlineattachmentsid' => 0,
1116             'attachmentsid' => null
1117         );
1118         foreach ($params['options'] as $option) {
1119             $name = trim($option['name']);
1120             switch ($name) {
1121                 case 'discussionsubscribe':
1122                     $value = clean_param($option['value'], PARAM_BOOL);
1123                     break;
1124                 case 'discussionpinned':
1125                     $value = clean_param($option['value'], PARAM_BOOL);
1126                     break;
1127                 case 'inlineattachmentsid':
1128                     $value = clean_param($option['value'], PARAM_INT);
1129                     break;
1130                 case 'attachmentsid':
1131                     $value = clean_param($option['value'], PARAM_INT);
1132                     // Ensure that the user has permissions to create attachments.
1133                     if (!has_capability('mod/forum:createattachment', $context)) {
1134                         $value = 0;
1135                     }
1136                     break;
1137                 default:
1138                     throw new moodle_exception('errorinvalidparam', 'webservice', '', $name);
1139             }
1140             $options[$name] = $value;
1141         }
1143         // Normalize group.
1144         if (!groups_get_activity_groupmode($cm)) {
1145             // Groups not supported, force to -1.
1146             $groupid = -1;
1147         } else {
1148             // Check if we receive the default or and empty value for groupid,
1149             // in this case, get the group for the user in the activity.
1150             if (empty($params['groupid'])) {
1151                 $groupid = groups_get_activity_group($cm);
1152             } else {
1153                 // Here we rely in the group passed, forum_user_can_post_discussion will validate the group.
1154                 $groupid = $params['groupid'];
1155             }
1156         }
1158         if (!forum_user_can_post_discussion($forum, $groupid, -1, $cm, $context)) {
1159             throw new moodle_exception('cannotcreatediscussion', 'forum');
1160         }
1162         $thresholdwarning = forum_check_throttling($forum, $cm);
1163         forum_check_blocking_threshold($thresholdwarning);
1165         // Create the discussion.
1166         $discussion = new stdClass();
1167         $discussion->course = $course->id;
1168         $discussion->forum = $forum->id;
1169         $discussion->message = $params['message'];
1170         $discussion->messageformat = FORMAT_HTML;   // Force formatting for now.
1171         $discussion->messagetrust = trusttext_trusted($context);
1172         $discussion->itemid = $options['inlineattachmentsid'];
1173         $discussion->groupid = $groupid;
1174         $discussion->mailnow = 0;
1175         $discussion->subject = $params['subject'];
1176         $discussion->name = $discussion->subject;
1177         $discussion->timestart = 0;
1178         $discussion->timeend = 0;
1179         $discussion->attachments = $options['attachmentsid'];
1181         if (has_capability('mod/forum:pindiscussions', $context) && $options['discussionpinned']) {
1182             $discussion->pinned = FORUM_DISCUSSION_PINNED;
1183         } else {
1184             $discussion->pinned = FORUM_DISCUSSION_UNPINNED;
1185         }
1186         $fakemform = $options['attachmentsid'];
1187         if ($discussionid = forum_add_discussion($discussion, $fakemform)) {
1189             $discussion->id = $discussionid;
1191             // Trigger events and completion.
1193             $params = array(
1194                 'context' => $context,
1195                 'objectid' => $discussion->id,
1196                 'other' => array(
1197                     'forumid' => $forum->id,
1198                 )
1199             );
1200             $event = \mod_forum\event\discussion_created::create($params);
1201             $event->add_record_snapshot('forum_discussions', $discussion);
1202             $event->trigger();
1204             $completion = new completion_info($course);
1205             if ($completion->is_enabled($cm) &&
1206                     ($forum->completiondiscussions || $forum->completionposts)) {
1207                 $completion->update_state($cm, COMPLETION_COMPLETE);
1208             }
1210             $settings = new stdClass();
1211             $settings->discussionsubscribe = $options['discussionsubscribe'];
1212             forum_post_subscription($settings, $forum, $discussion);
1213         } else {
1214             throw new moodle_exception('couldnotadd', 'forum');
1215         }
1217         $result = array();
1218         $result['discussionid'] = $discussionid;
1219         $result['warnings'] = $warnings;
1220         return $result;
1221     }
1223     /**
1224      * Returns description of method result value
1225      *
1226      * @return external_description
1227      * @since Moodle 3.0
1228      */
1229     public static function add_discussion_returns() {
1230         return new external_single_structure(
1231             array(
1232                 'discussionid' => new external_value(PARAM_INT, 'New Discussion ID'),
1233                 'warnings' => new external_warnings()
1234             )
1235         );
1236     }
1238     /**
1239      * Returns description of method parameters
1240      *
1241      * @return external_function_parameters
1242      * @since Moodle 3.1
1243      */
1244     public static function can_add_discussion_parameters() {
1245         return new external_function_parameters(
1246             array(
1247                 'forumid' => new external_value(PARAM_INT, 'Forum instance ID'),
1248                 'groupid' => new external_value(PARAM_INT, 'The group to check, default to active group.
1249                                                 Use -1 to check if the user can post in all the groups.', VALUE_DEFAULT, null)
1250             )
1251         );
1252     }
1254     /**
1255      * Check if the current user can add discussions in the given forum (and optionally for the given group).
1256      *
1257      * @param int $forumid the forum instance id
1258      * @param int $groupid the group to check, default to active group. Use -1 to check if the user can post in all the groups.
1259      * @return array of warnings and the status (true if the user can add discussions)
1260      * @since Moodle 3.1
1261      * @throws moodle_exception
1262      */
1263     public static function can_add_discussion($forumid, $groupid = null) {
1264         global $DB, $CFG;
1265         require_once($CFG->dirroot . "/mod/forum/lib.php");
1267         $params = self::validate_parameters(self::can_add_discussion_parameters(),
1268                                             array(
1269                                                 'forumid' => $forumid,
1270                                                 'groupid' => $groupid,
1271                                             ));
1272         $warnings = array();
1274         // Request and permission validation.
1275         $forum = $DB->get_record('forum', array('id' => $params['forumid']), '*', MUST_EXIST);
1276         list($course, $cm) = get_course_and_cm_from_instance($forum, 'forum');
1278         $context = context_module::instance($cm->id);
1279         self::validate_context($context);
1281         $status = forum_user_can_post_discussion($forum, $params['groupid'], -1, $cm, $context);
1283         $result = array();
1284         $result['status'] = $status;
1285         $result['canpindiscussions'] = has_capability('mod/forum:pindiscussions', $context);
1286         $result['cancreateattachment'] = forum_can_create_attachment($forum, $context);
1287         $result['warnings'] = $warnings;
1288         return $result;
1289     }
1291     /**
1292      * Returns description of method result value
1293      *
1294      * @return external_description
1295      * @since Moodle 3.1
1296      */
1297     public static function can_add_discussion_returns() {
1298         return new external_single_structure(
1299             array(
1300                 'status' => new external_value(PARAM_BOOL, 'True if the user can add discussions, false otherwise.'),
1301                 'canpindiscussions' => new external_value(PARAM_BOOL, 'True if the user can pin discussions, false otherwise.',
1302                     VALUE_OPTIONAL),
1303                 'cancreateattachment' => new external_value(PARAM_BOOL, 'True if the user can add attachments, false otherwise.',
1304                     VALUE_OPTIONAL),
1305                 'warnings' => new external_warnings()
1306             )
1307         );
1308     }
1310     /**
1311      * Describes the parameters for get_forum_access_information.
1312      *
1313      * @return external_external_function_parameters
1314      * @since Moodle 3.7
1315      */
1316     public static function get_forum_access_information_parameters() {
1317         return new external_function_parameters (
1318             array(
1319                 'forumid' => new external_value(PARAM_INT, 'Forum instance id.')
1320             )
1321         );
1322     }
1324     /**
1325      * Return access information for a given forum.
1326      *
1327      * @param int $forumid forum instance id
1328      * @return array of warnings and the access information
1329      * @since Moodle 3.7
1330      * @throws  moodle_exception
1331      */
1332     public static function get_forum_access_information($forumid) {
1333         global $DB;
1335         $params = self::validate_parameters(self::get_forum_access_information_parameters(), array('forumid' => $forumid));
1337         // Request and permission validation.
1338         $forum = $DB->get_record('forum', array('id' => $params['forumid']), '*', MUST_EXIST);
1339         $cm = get_coursemodule_from_instance('forum', $forum->id);
1341         $context = context_module::instance($cm->id);
1342         self::validate_context($context);
1344         $result = array();
1345         // Return all the available capabilities.
1346         $capabilities = load_capability_def('mod_forum');
1347         foreach ($capabilities as $capname => $capdata) {
1348             // Get fields like cansubmit so it is consistent with the access_information function implemented in other modules.
1349             $field = 'can' . str_replace('mod/forum:', '', $capname);
1350             $result[$field] = has_capability($capname, $context);
1351         }
1353         $result['warnings'] = array();
1354         return $result;
1355     }
1357     /**
1358      * Describes the get_forum_access_information return value.
1359      *
1360      * @return external_single_structure
1361      * @since Moodle 3.7
1362      */
1363     public static function get_forum_access_information_returns() {
1365         $structure = array(
1366             'warnings' => new external_warnings()
1367         );
1369         $capabilities = load_capability_def('mod_forum');
1370         foreach ($capabilities as $capname => $capdata) {
1371             // Get fields like cansubmit so it is consistent with the access_information function implemented in other modules.
1372             $field = 'can' . str_replace('mod/forum:', '', $capname);
1373             $structure[$field] = new external_value(PARAM_BOOL, 'Whether the user has the capability ' . $capname . ' allowed.',
1374                 VALUE_OPTIONAL);
1375         }
1377         return new external_single_structure($structure);
1378     }
1380     /**
1381      * Set the subscription state.
1382      *
1383      * @param   int     $forumid
1384      * @param   int     $discussionid
1385      * @param   bool    $targetstate
1386      * @return  \stdClass
1387      */
1388     public static function set_subscription_state($forumid, $discussionid, $targetstate) {
1389         global $PAGE, $USER;
1391         $params = self::validate_parameters(self::set_subscription_state_parameters(), [
1392             'forumid' => $forumid,
1393             'discussionid' => $discussionid,
1394             'targetstate' => $targetstate
1395         ]);
1397         $vaultfactory = mod_forum\local\container::get_vault_factory();
1398         $forumvault = $vaultfactory->get_forum_vault();
1399         $forum = $forumvault->get_from_id($params['forumid']);
1400         $coursemodule = $forum->get_course_module_record();
1401         $context = $forum->get_context();
1403         self::validate_context($context);
1405         $discussionvault = $vaultfactory->get_discussion_vault();
1406         $discussion = $discussionvault->get_from_id($params['discussionid']);
1407         $legacydatamapperfactory = mod_forum\local\container::get_legacy_data_mapper_factory();
1409         $forumrecord = $legacydatamapperfactory->get_forum_data_mapper()->to_legacy_object($forum);
1410         $discussionrecord = $legacydatamapperfactory->get_discussion_data_mapper()->to_legacy_object($discussion);
1412         if (!\mod_forum\subscriptions::is_subscribable($forumrecord)) {
1413             // Nothing to do. We won't actually output any content here though.
1414             throw new \moodle_exception('cannotsubscribe', 'mod_forum');
1415         }
1417         $issubscribed = \mod_forum\subscriptions::is_subscribed(
1418             $USER->id,
1419             $forumrecord,
1420             $discussion->get_id(),
1421             $coursemodule
1422         );
1424         // If the current state doesn't equal the desired state then update the current
1425         // state to the desired state.
1426         if ($issubscribed != (bool) $params['targetstate']) {
1427             if ($params['targetstate']) {
1428                 \mod_forum\subscriptions::subscribe_user_to_discussion($USER->id, $discussionrecord, $context);
1429             } else {
1430                 \mod_forum\subscriptions::unsubscribe_user_from_discussion($USER->id, $discussionrecord, $context);
1431             }
1432         }
1434         $exporterfactory = mod_forum\local\container::get_exporter_factory();
1435         $exporter = $exporterfactory->get_discussion_exporter($USER, $forum, $discussion);
1436         return $exporter->export($PAGE->get_renderer('mod_forum'));
1437     }
1439     /**
1440      * Returns description of method parameters.
1441      *
1442      * @return external_function_parameters
1443      */
1444     public static function set_subscription_state_parameters() {
1445         return new external_function_parameters(
1446             [
1447                 'forumid' => new external_value(PARAM_INT, 'Forum that the discussion is in'),
1448                 'discussionid' => new external_value(PARAM_INT, 'The discussion to subscribe or unsubscribe'),
1449                 'targetstate' => new external_value(PARAM_BOOL, 'The target state')
1450             ]
1451         );
1452     }
1454     /**
1455      * Returns description of method result value.
1456      *
1457      * @return external_description
1458      */
1459     public static function set_subscription_state_returns() {
1460         return \mod_forum\local\exporters\discussion::get_read_structure();
1461     }