40b421dcb694d595ea74426437cec48e45e9c09d
[moodle.git] / mod / forum / classes / post_form.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  * 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  */
26 defined('MOODLE_INTERNAL') || die();
27 require_once($CFG->libdir . '/formslib.php');
28 require_once($CFG->dirroot . '/repository/lib.php');
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  */
37 class mod_forum_post_form extends moodleform {
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' => '*',
53             'return_types' => FILE_INTERNAL | FILE_CONTROLLED_LINK
54         );
55     }
57     /**
58      * Returns the options array to use in forum text editor
59      *
60      * @param context_module $context
61      * @param int $postid post id, use null when adding new post
62      * @return array
63      */
64     public static function editor_options(context_module $context, $postid) {
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,
72             'return_types'=> FILE_INTERNAL | FILE_EXTERNAL,
73             'subdirs' => file_area_contains_subdirs($context, 'mod_forum', 'post', $postid)
74         );
75     }
77     /**
78      * Form definition
79      *
80      * @return void
81      */
82     function definition() {
83         global $CFG, $OUTPUT;
85         $mform =& $this->_form;
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'];
93         $subscribe = $this->_customdata['subscribe'];
94         $edit = $this->_customdata['edit'];
95         $thresholdwarning = $this->_customdata['thresholdwarning'];
96         $canreplyprivately = array_key_exists('canreplyprivately', $this->_customdata) ?
97             $this->_customdata['canreplyprivately'] : false;
98         $stripped = isset($this->_customdata['inpagereply']) ? $this->_customdata['inpagereply'] : false;
100         if (!$stripped) {
101             // Fill in the data depending on page params later using set_data.
102             $mform->addElement('header', 'general', '');
103         }
105         // If there is a warning message and we are not editing a post we need to handle the warning.
106         if (!empty($thresholdwarning) && !$edit) {
107             // Here we want to display a warning if they can still post but have reached the warning threshold.
108             if ($thresholdwarning->canpost) {
109                 $message = get_string($thresholdwarning->errorcode, $thresholdwarning->module, $thresholdwarning->additional);
110                 $mform->addElement('html', $OUTPUT->notification($message));
111             }
112         }
114         $mform->addElement('text', 'subject', get_string('subject', 'forum'), 'size="48"');
115         $mform->setType('subject', PARAM_TEXT);
116         $mform->addRule('subject', get_string('required'), 'required', null, 'client');
117         $mform->addRule('subject', get_string('maximumchars', '', 255), 'maxlength', 255, 'client');
119         $mform->addElement('editor', 'message', get_string('message', 'forum'), null, self::editor_options($modcontext, (empty($post->id) ? null : $post->id)));
120         $mform->setType('message', PARAM_RAW);
121         $mform->addRule('message', get_string('required'), 'required', null, 'client');
123         if (!$stripped) {
124             $manageactivities = has_capability('moodle/course:manageactivities', $coursecontext);
126             if (\mod_forum\subscriptions::is_forcesubscribed($forum)) {
127                 $mform->addElement('advcheckbox', 'discussionsubscribe', get_string('discussionsubscription', 'forum'));
128                 $mform->freeze('discussionsubscribe');
129                 $mform->setDefaults('discussionsubscribe', 0);
130                 $mform->addHelpButton('discussionsubscribe', 'forcesubscribed', 'forum');
132             } else if (\mod_forum\subscriptions::subscription_disabled($forum) && !$manageactivities) {
133                 $mform->addElement('advcheckbox', 'discussionsubscribe', get_string('discussionsubscription', 'forum'));
134                 $mform->freeze('discussionsubscribe');
135                 $mform->setDefaults('discussionsubscribe', 0);
136                 $mform->addHelpButton('discussionsubscribe', 'disallowsubscription', 'forum');
138             } else {
139                 $mform->addElement('advcheckbox', 'discussionsubscribe', get_string('discussionsubscription', 'forum'));
140                 $mform->addHelpButton('discussionsubscribe', 'discussionsubscription', 'forum');
141             }
143             if (forum_can_create_attachment($forum, $modcontext)) {
144                 $mform->addElement('filemanager', 'attachments', get_string('attachment', 'forum'), null,
145                     self::attachment_options($forum));
146                 $mform->addHelpButton('attachments', 'attachment', 'forum');
147             }
149             if (!$post->parent && has_capability('mod/forum:pindiscussions', $modcontext)) {
150                 $mform->addElement('checkbox', 'pinned', get_string('discussionpinned', 'forum'));
151                 $mform->addHelpButton('pinned', 'discussionpinned', 'forum');
152             }
154             if ((empty($post->id) && $canreplyprivately) || (!empty($post) && !empty($post->privatereplyto))) {
155                 // Only show the option to change private reply settings if this is a new post and the user can reply
156                 // privately, or if this is already private reply, in which case the state is shown but is not editable.
157                 $mform->addElement('checkbox', 'isprivatereply', get_string('privatereply', 'forum'));
158                 $mform->addHelpButton('isprivatereply', 'privatereply', 'forum');
159                 if (!empty($post->privatereplyto)) {
160                     $mform->setDefault('isprivatereply', 1);
161                     $mform->freeze('isprivatereply');
162                 }
163             }
165             if ($groupmode = groups_get_activity_groupmode($cm, $course)) {
166                 $groupdata = groups_get_activity_allowed_groups($cm);
167                 if (empty($post->id) && $manageactivities) {
168                     $mform->addElement('checkbox', 'mailnow', get_string('mailnow', 'forum'));
169                 }
171                 if ($groupmode = groups_get_activity_groupmode($cm, $course)) {
172                     $groupdata = groups_get_activity_allowed_groups($cm);
174                     $groupinfo = array();
175                     foreach ($groupdata as $groupid => $group) {
176                         // Check whether this user can post in this group.
177                         // We must make this check because all groups are returned for a visible grouped activity.
178                         if (forum_user_can_post_discussion($forum, $groupid, null, $cm, $modcontext)) {
179                             // Build the data for the groupinfo select.
180                             $groupinfo[$groupid] = $group->name;
181                         } else {
182                             unset($groupdata[$groupid]);
183                         }
184                     }
185                     $groupcount = count($groupinfo);
187                     // Check whether a user can post to all of their own groups.
189                     // Posts to all of my groups are copied to each group that the user is a member of. Certain conditions must be met.
190                     // 1) It only makes sense to allow this when a user is in more than one group.
191                     // Note: This check must come before we consider adding accessallgroups, because that is not a real group.
192                     $canposttoowngroups = empty($post->edit) && $groupcount > 1;
194                     // 2) Important: You can *only* post to multiple groups for a top level post. Never any reply.
195                     $canposttoowngroups = $canposttoowngroups && empty($post->parent);
197                     // 3) You also need the canposttoowngroups capability.
198                     $canposttoowngroups = $canposttoowngroups && has_capability('mod/forum:canposttomygroups', $modcontext);
199                     if ($canposttoowngroups) {
200                         // This user is in multiple groups, and can post to all of their own groups.
201                         // Note: This is not the same as accessallgroups. This option will copy a post to all groups that a
202                         // user is a member of.
203                         $mform->addElement('checkbox', 'posttomygroups', get_string('posttomygroups', 'forum'));
204                         $mform->addHelpButton('posttomygroups', 'posttomygroups', 'forum');
205                         $mform->disabledIf('groupinfo', 'posttomygroups', 'checked');
206                     }
208                     // Check whether this user can post to all groups.
209                     // Posts to the 'All participants' group go to all groups, not to each group in a list.
210                     // It makes sense to allow this, even if there currently aren't any groups because there may be in the future.
211                     if (forum_user_can_post_discussion($forum, -1, null, $cm, $modcontext)) {
212                         // Note: We must reverse in this manner because array_unshift renumbers the array.
213                         $groupinfo = array_reverse($groupinfo, true);
214                         $groupinfo[-1] = get_string('allparticipants');
215                         $groupinfo = array_reverse($groupinfo, true);
216                         $groupcount++;
217                     }
219                     // Determine whether the user can select a group from the dropdown. The dropdown is available for several reasons.
220                     // 1) This is a new post (not an edit), and there are at least two groups to choose from.
221                     $canselectgroupfornew = empty($post->edit) && $groupcount > 1;
223                     // 2) This is editing of an existing post and the user is allowed to movediscussions.
224                     // We allow this because the post may have been moved from another forum where groups are not available.
225                     // We show this even if no groups are available as groups *may* have been available but now are not.
226                     $canselectgroupformove =
227                         $groupcount && !empty($post->edit) && has_capability('mod/forum:movediscussions', $modcontext);
229                     // Important: You can *only* change the group for a top level post. Never any reply.
230                     $canselectgroup = empty($post->parent) && ($canselectgroupfornew || $canselectgroupformove);
232                     if ($canselectgroup) {
233                         $mform->addElement('select', 'groupinfo', get_string('group'), $groupinfo);
234                         $mform->setDefault('groupinfo', $post->groupid);
235                         $mform->setType('groupinfo', PARAM_INT);
236                     } else {
237                         if (empty($post->groupid)) {
238                             $groupname = get_string('allparticipants');
239                         } else {
240                             $groupname = format_string($groupdata[$post->groupid]->name);
241                         }
242                         $mform->addElement('static', 'groupinfo', get_string('group'), $groupname);
243                     }
244                 }
245             }
247             if (!empty($CFG->forum_enabletimedposts) && !$post->parent &&
248                 has_capability('mod/forum:viewhiddentimedposts', $coursecontext)) {
249                 $mform->addElement('header', 'displayperiod', get_string('displayperiod', 'forum'));
251                 $mform->addElement('date_time_selector', 'timestart', get_string('displaystart', 'forum'),
252                     array('optional' => true));
253                 $mform->addHelpButton('timestart', 'displaystart', 'forum');
255                 $mform->addElement('date_time_selector', 'timeend', get_string('displayend', 'forum'),
256                     array('optional' => true));
257                 $mform->addHelpButton('timeend', 'displayend', 'forum');
259             } else {
260                 $mform->addElement('hidden', 'timestart');
261                 $mform->setType('timestart', PARAM_INT);
262                 $mform->addElement('hidden', 'timeend');
263                 $mform->setType('timeend', PARAM_INT);
264                 $mform->setConstants(array('timestart' => 0, 'timeend' => 0));
265             }
267             if (core_tag_tag::is_enabled('mod_forum', 'forum_posts')) {
268                 $mform->addElement('header', 'tagshdr', get_string('tags', 'tag'));
270                 $mform->addElement('tags', 'tags', get_string('tags'),
271                     array('itemtype' => 'forum_posts', 'component' => 'mod_forum'));
272             }
273         }
275         //-------------------------------------------------------------------------------
276         // buttons
277         if (isset($post->edit)) { // hack alert
278             $submitstring = get_string('savechanges');
279         } else {
280             $submitstring = get_string('posttoforum', 'forum');
281         }
283         // Always register a no submit button so it can be picked up if redirecting to the original post form.
284         $mform->registerNoSubmitButton('advancedadddiscussion');
286         // This is an inpage add discussion which requires custom buttons.
287         if ($stripped) {
288             $buttonarray = array();
289             $buttonarray[] = &$mform->createElement('submit', 'submitbutton', $submitstring);
290             $buttonarray[] = &$mform->createElement('button', 'cancelbtn',
291                 get_string('cancel', 'core'),
292                 // Additional attribs to handle collapsible div.
293                 ['data-toggle' => 'collapse', 'data-target' => "#collapseAddForm"]);
294             $buttonarray[] = &$mform->createElement('submit', 'advancedadddiscussion',
295                 get_string('advanced'), ['customclassoverride' => 'btn-link']);
297             $mform->addGroup($buttonarray, 'buttonar', '', array(' '), false);
298             $mform->closeHeaderBefore('buttonar');
299         } else {
300             $this->add_action_buttons(true, $submitstring);
301         }
303         $mform->addElement('hidden', 'course');
304         $mform->setType('course', PARAM_INT);
306         $mform->addElement('hidden', 'forum');
307         $mform->setType('forum', PARAM_INT);
309         $mform->addElement('hidden', 'discussion');
310         $mform->setType('discussion', PARAM_INT);
312         $mform->addElement('hidden', 'parent');
313         $mform->setType('parent', PARAM_INT);
315         $mform->addElement('hidden', 'groupid');
316         $mform->setType('groupid', PARAM_INT);
318         $mform->addElement('hidden', 'edit');
319         $mform->setType('edit', PARAM_INT);
321         $mform->addElement('hidden', 'reply');
322         $mform->setType('reply', PARAM_INT);
323     }
325     /**
326      * Form validation
327      *
328      * @param array $data data from the form.
329      * @param array $files files uploaded.
330      * @return array of errors.
331      */
332     function validation($data, $files) {
333         $errors = parent::validation($data, $files);
334         if (($data['timeend']!=0) && ($data['timestart']!=0) && $data['timeend'] <= $data['timestart']) {
335             $errors['timeend'] = get_string('timestartenderror', 'forum');
336         }
337         if (empty($data['message']['text'])) {
338             $errors['message'] = get_string('erroremptymessage', 'forum');
339         }
340         if (empty($data['subject'])) {
341             $errors['subject'] = get_string('erroremptysubject', 'forum');
342         }
343         return $errors;
344     }