MDL-65069 mod_forum: Stripped out inpage form and advanced redirect
[moodle.git] / mod / forum / classes / post_form.php
CommitLineData
2ecd2847
FM
1<?php
2
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/>.
17
18/**
19 * File containing the form definition to post in the forum.
20 *
21 * @package mod_forum
22 * @copyright Jamie Pratt <me@jamiep.org>
23 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24 */
25
26defined('MOODLE_INTERNAL') || die();
27require_once($CFG->libdir . '/formslib.php');
7fb35af6 28require_once($CFG->dirroot . '/repository/lib.php');
2ecd2847
FM
29
30/**
31 * Class to post in a forum.
32 *
33 * @package mod_forum
34 * @copyright Jamie Pratt <me@jamiep.org>
35 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36 */
37class mod_forum_post_form extends moodleform {
38
39 /**
40 * Returns the options array to use in filemanager for forum attachments
41 *
42 * @param stdClass $forum
43 * @return array
44 */
45 public static function attachment_options($forum) {
46 global $COURSE, $PAGE, $CFG;
47 $maxbytes = get_user_max_upload_file_size($PAGE->context, $CFG->maxbytes, $COURSE->maxbytes, $forum->maxbytes);
48 return array(
49 'subdirs' => 0,
50 'maxbytes' => $maxbytes,
51 'maxfiles' => $forum->maxattachments,
52 'accepted_types' => '*',
151b0f94 53 'return_types' => FILE_INTERNAL | FILE_CONTROLLED_LINK
2ecd2847
FM
54 );
55 }
56
57 /**
58 * Returns the options array to use in forum text editor
59 *
5e95223e
PS
60 * @param context_module $context
61 * @param int $postid post id, use null when adding new post
2ecd2847
FM
62 * @return array
63 */
5e95223e 64 public static function editor_options(context_module $context, $postid) {
2ecd2847
FM
65 global $COURSE, $PAGE, $CFG;
66 // TODO: add max files and max size support
67 $maxbytes = get_user_max_upload_file_size($PAGE->context, $CFG->maxbytes, $COURSE->maxbytes);
68 return array(
69 'maxfiles' => EDITOR_UNLIMITED_FILES,
70 'maxbytes' => $maxbytes,
71 'trusttext'=> true,
5e95223e
PS
72 'return_types'=> FILE_INTERNAL | FILE_EXTERNAL,
73 'subdirs' => file_area_contains_subdirs($context, 'mod_forum', 'post', $postid)
2ecd2847
FM
74 );
75 }
76
77 /**
78 * Form definition
79 *
80 * @return void
81 */
82 function definition() {
83 global $CFG, $OUTPUT;
84
85 $mform =& $this->_form;
86
87 $course = $this->_customdata['course'];
88 $cm = $this->_customdata['cm'];
89 $coursecontext = $this->_customdata['coursecontext'];
90 $modcontext = $this->_customdata['modcontext'];
91 $forum = $this->_customdata['forum'];
92 $post = $this->_customdata['post'];
ebfb73db 93 $subscribe = $this->_customdata['subscribe'];
2ecd2847
FM
94 $edit = $this->_customdata['edit'];
95 $thresholdwarning = $this->_customdata['thresholdwarning'];
bc4c7337 96 $canreplyprivately = $this->_customdata['canreplyprivately'];
97babbf7 97 $stripped = isset($this->_customdata['inpagereply']) ? $this->_customdata['inpagereply'] : false;
2ecd2847 98
97babbf7
P
99 if (!$stripped) {
100 $mform->addElement('header', 'general', '');//fill in the data depending on page params later using set_data
101 }
2ecd2847
FM
102
103 // If there is a warning message and we are not editing a post we need to handle the warning.
104 if (!empty($thresholdwarning) && !$edit) {
105 // Here we want to display a warning if they can still post but have reached the warning threshold.
106 if ($thresholdwarning->canpost) {
107 $message = get_string($thresholdwarning->errorcode, $thresholdwarning->module, $thresholdwarning->additional);
108 $mform->addElement('html', $OUTPUT->notification($message));
109 }
110 }
111
112 $mform->addElement('text', 'subject', get_string('subject', 'forum'), 'size="48"');
113 $mform->setType('subject', PARAM_TEXT);
114 $mform->addRule('subject', get_string('required'), 'required', null, 'client');
115 $mform->addRule('subject', get_string('maximumchars', '', 255), 'maxlength', 255, 'client');
116
5e95223e 117 $mform->addElement('editor', 'message', get_string('message', 'forum'), null, self::editor_options($modcontext, (empty($post->id) ? null : $post->id)));
2ecd2847
FM
118 $mform->setType('message', PARAM_RAW);
119 $mform->addRule('message', get_string('required'), 'required', null, 'client');
120
97babbf7
P
121 if (!$stripped) {
122 $manageactivities = has_capability('moodle/course:manageactivities', $coursecontext);
2ecd2847 123
97babbf7
P
124 if (\mod_forum\subscriptions::is_forcesubscribed($forum)) {
125 $mform->addElement('advcheckbox', 'discussionsubscribe', get_string('discussionsubscription', 'forum'));
126 $mform->freeze('discussionsubscribe');
127 $mform->setDefaults('discussionsubscribe', 0);
128 $mform->addHelpButton('discussionsubscribe', 'forcesubscribed', 'forum');
5f219cf1 129
97babbf7
P
130 } else if (\mod_forum\subscriptions::subscription_disabled($forum) && !$manageactivities) {
131 $mform->addElement('advcheckbox', 'discussionsubscribe', get_string('discussionsubscription', 'forum'));
132 $mform->freeze('discussionsubscribe');
133 $mform->setDefaults('discussionsubscribe', 0);
134 $mform->addHelpButton('discussionsubscribe', 'disallowsubscription', 'forum');
2ecd2847 135
97babbf7
P
136 } else {
137 $mform->addElement('advcheckbox', 'discussionsubscribe', get_string('discussionsubscription', 'forum'));
138 $mform->addHelpButton('discussionsubscribe', 'discussionsubscription', 'forum');
bc4c7337 139 }
bc4c7337 140
97babbf7
P
141 if (forum_can_create_attachment($forum, $modcontext)) {
142 $mform->addElement('filemanager', 'attachments', get_string('attachment', 'forum'), null,
143 self::attachment_options($forum));
144 $mform->addHelpButton('attachments', 'attachment', 'forum');
344e1263 145 }
f2946a54 146
97babbf7
P
147 if (!$post->parent && has_capability('mod/forum:pindiscussions', $modcontext)) {
148 $mform->addElement('checkbox', 'pinned', get_string('discussionpinned', 'forum'));
149 $mform->addHelpButton('pinned', 'discussionpinned', 'forum');
f2946a54
AN
150 }
151
97babbf7
P
152 if ((empty($post->id) && $canreplyprivately) || (!empty($post) && !empty($post->privatereplyto))) {
153 // Only show the option to change private reply settings if this is a new post and the user can reply
154 // privately, or if this is already private reply, in which case the state is shown but is not editable.
155 $mform->addElement('checkbox', 'isprivatereply', get_string('privatereply', 'forum'));
156 $mform->addHelpButton('isprivatereply', 'privatereply', 'forum');
157 if (!empty($post->privatereplyto)) {
158 $mform->setDefault('isprivatereply', 1);
159 $mform->freeze('isprivatereply');
160 }
161 }
344e1263 162
97babbf7
P
163 if ($groupmode = groups_get_activity_groupmode($cm, $course)) {
164 $groupdata = groups_get_activity_allowed_groups($cm);
165 if (empty($post->id) && $manageactivities) {
166 $mform->addElement('checkbox', 'mailnow', get_string('mailnow', 'forum'));
167 }
344e1263 168
97babbf7
P
169 if ($groupmode = groups_get_activity_groupmode($cm, $course)) {
170 $groupdata = groups_get_activity_allowed_groups($cm);
171
172 $groupinfo = array();
173 foreach ($groupdata as $groupid => $group) {
174 // Check whether this user can post in this group.
175 // We must make this check because all groups are returned for a visible grouped activity.
176 if (forum_user_can_post_discussion($forum, $groupid, null, $cm, $modcontext)) {
177 // Build the data for the groupinfo select.
178 $groupinfo[$groupid] = $group->name;
179 } else {
180 unset($groupdata[$groupid]);
181 }
182 }
183 $groupcount = count($groupinfo);
184
185 // Check whether a user can post to all of their own groups.
186
187 // Posts to all of my groups are copied to each group that the user is a member of. Certain conditions must be met.
188 // 1) It only makes sense to allow this when a user is in more than one group.
189 // Note: This check must come before we consider adding accessallgroups, because that is not a real group.
190 $canposttoowngroups = empty($post->edit) && $groupcount > 1;
191
192 // 2) Important: You can *only* post to multiple groups for a top level post. Never any reply.
193 $canposttoowngroups = $canposttoowngroups && empty($post->parent);
194
195 // 3) You also need the canposttoowngroups capability.
196 $canposttoowngroups = $canposttoowngroups && has_capability('mod/forum:canposttomygroups', $modcontext);
197 if ($canposttoowngroups) {
198 // This user is in multiple groups, and can post to all of their own groups.
199 // Note: This is not the same as accessallgroups. This option will copy a post to all groups that a
200 // user is a member of.
201 $mform->addElement('checkbox', 'posttomygroups', get_string('posttomygroups', 'forum'));
202 $mform->addHelpButton('posttomygroups', 'posttomygroups', 'forum');
203 $mform->disabledIf('groupinfo', 'posttomygroups', 'checked');
204 }
205
206 // Check whether this user can post to all groups.
207 // Posts to the 'All participants' group go to all groups, not to each group in a list.
208 // It makes sense to allow this, even if there currently aren't any groups because there may be in the future.
209 if (forum_user_can_post_discussion($forum, -1, null, $cm, $modcontext)) {
210 // Note: We must reverse in this manner because array_unshift renumbers the array.
211 $groupinfo = array_reverse($groupinfo, true);
212 $groupinfo[-1] = get_string('allparticipants');
213 $groupinfo = array_reverse($groupinfo, true);
214 $groupcount++;
215 }
216
217 // Determine whether the user can select a group from the dropdown. The dropdown is available for several reasons.
218 // 1) This is a new post (not an edit), and there are at least two groups to choose from.
219 $canselectgroupfornew = empty($post->edit) && $groupcount > 1;
220
221 // 2) This is editing of an existing post and the user is allowed to movediscussions.
222 // We allow this because the post may have been moved from another forum where groups are not available.
223 // We show this even if no groups are available as groups *may* have been available but now are not.
224 $canselectgroupformove =
225 $groupcount && !empty($post->edit) && has_capability('mod/forum:movediscussions', $modcontext);
226
227 // Important: You can *only* change the group for a top level post. Never any reply.
228 $canselectgroup = empty($post->parent) && ($canselectgroupfornew || $canselectgroupformove);
229
230 if ($canselectgroup) {
231 $mform->addElement('select', 'groupinfo', get_string('group'), $groupinfo);
232 $mform->setDefault('groupinfo', $post->groupid);
233 $mform->setType('groupinfo', PARAM_INT);
234 } else {
235 if (empty($post->groupid)) {
236 $groupname = get_string('allparticipants');
237 } else {
238 $groupname = format_string($groupdata[$post->groupid]->name);
239 }
240 $mform->addElement('static', 'groupinfo', get_string('group'), $groupname);
241 }
2ecd2847 242 }
2ecd2847 243 }
608edec5 244
97babbf7
P
245 if (!empty($CFG->forum_enabletimedposts) && !$post->parent &&
246 has_capability('mod/forum:viewhiddentimedposts', $coursecontext)) {
247 $mform->addElement('header', 'displayperiod', get_string('displayperiod', 'forum'));
608edec5 248
97babbf7
P
249 $mform->addElement('date_time_selector', 'timestart', get_string('displaystart', 'forum'),
250 array('optional' => true));
251 $mform->addHelpButton('timestart', 'displaystart', 'forum');
608edec5 252
97babbf7
P
253 $mform->addElement('date_time_selector', 'timeend', get_string('displayend', 'forum'),
254 array('optional' => true));
255 $mform->addHelpButton('timeend', 'displayend', 'forum');
608edec5 256
97babbf7
P
257 } else {
258 $mform->addElement('hidden', 'timestart');
259 $mform->setType('timestart', PARAM_INT);
260 $mform->addElement('hidden', 'timeend');
261 $mform->setType('timeend', PARAM_INT);
262 $mform->setConstants(array('timestart' => 0, 'timeend' => 0));
263 }
608edec5 264
97babbf7
P
265 if (core_tag_tag::is_enabled('mod_forum', 'forum_posts')) {
266 $mform->addElement('header', 'tagshdr', get_string('tags', 'tag'));
d2ba493c 267
97babbf7
P
268 $mform->addElement('tags', 'tags', get_string('tags'),
269 array('itemtype' => 'forum_posts', 'component' => 'mod_forum'));
270 }
d2ba493c
AH
271 }
272
2ecd2847
FM
273 //-------------------------------------------------------------------------------
274 // buttons
275 if (isset($post->edit)) { // hack alert
276 $submit_string = get_string('savechanges');
277 } else {
278 $submit_string = get_string('posttoforum', 'forum');
279 }
2587313a 280
97babbf7
P
281 // Always register a no submit button so it can be picked up if redirecting to the original post form.
282 $mform->registerNoSubmitButton('advancedadddiscussion');
283
284 // This is an inpage add discussion which requires custom buttons.
285 if ($stripped) {
286 $buttonarray = array();
287 $buttonarray[] = &$mform->createElement('submit', 'submitbutton', $submit_string);
288 $buttonarray[] = &$mform->createElement('submit', 'advancedadddiscussion',
289 get_string('advanced'));
290 $buttonarray[] = &$mform->createElement('button', 'cancelbtn',
291 get_string('cancel', 'core'),
292 ['class' => 'btn-secondary', 'data-toggle' => 'collapse', 'data-target' => "#collapseAddForm"]);
293 $mform->addGroup($buttonarray, 'buttonar', '', array(' '), false);
294 $mform->closeHeaderBefore('buttonar');
295 } else {
296 $this->add_action_buttons(true, $submit_string);
297 }
2ecd2847
FM
298
299 $mform->addElement('hidden', 'course');
300 $mform->setType('course', PARAM_INT);
301
302 $mform->addElement('hidden', 'forum');
303 $mform->setType('forum', PARAM_INT);
304
305 $mform->addElement('hidden', 'discussion');
306 $mform->setType('discussion', PARAM_INT);
307
308 $mform->addElement('hidden', 'parent');
309 $mform->setType('parent', PARAM_INT);
310
2ecd2847
FM
311 $mform->addElement('hidden', 'groupid');
312 $mform->setType('groupid', PARAM_INT);
313
314 $mform->addElement('hidden', 'edit');
315 $mform->setType('edit', PARAM_INT);
316
317 $mform->addElement('hidden', 'reply');
318 $mform->setType('reply', PARAM_INT);
319 }
320
321 /**
322 * Form validation
323 *
324 * @param array $data data from the form.
325 * @param array $files files uploaded.
326 * @return array of errors.
327 */
328 function validation($data, $files) {
329 $errors = parent::validation($data, $files);
330 if (($data['timeend']!=0) && ($data['timestart']!=0) && $data['timeend'] <= $data['timestart']) {
331 $errors['timeend'] = get_string('timestartenderror', 'forum');
332 }
333 if (empty($data['message']['text'])) {
334 $errors['message'] = get_string('erroremptymessage', 'forum');
335 }
336 if (empty($data['subject'])) {
337 $errors['subject'] = get_string('erroremptysubject', 'forum');
338 }
339 return $errors;
340 }
341}