weekly release 3.5dev
[moodle.git] / mod / forum / classes / message / inbound / reply_handler.php
CommitLineData
91223df6
AN
1<?php
2// This file is part of Moodle - http://moodle.org/
3//
4// Moodle is free software: you can redistribute it and/or modify
5// it under the terms of the GNU General Public License as published by
6// the Free Software Foundation, either version 3 of the License, or
7// (at your option) any later version.
8//
9// Moodle is distributed in the hope that it will be useful,
10// but WITHOUT ANY WARRANTY; without even the implied warranty of
11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12// GNU General Public License for more details.
13//
14// You should have received a copy of the GNU General Public License
15// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
16
17/**
18 * A Handler to process replies to forum posts.
19 *
20 * @package mod_forum
21 * @subpackage core_message
22 * @copyright 2014 Andrew Nicols
23 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24 */
25
26namespace mod_forum\message\inbound;
27
28defined('MOODLE_INTERNAL') || die();
29
30require_once($CFG->dirroot . '/mod/forum/lib.php');
31require_once($CFG->dirroot . '/repository/lib.php');
346ba4f4 32require_once($CFG->libdir . '/completionlib.php');
91223df6
AN
33
34/**
35 * A Handler to process replies to forum posts.
36 *
37 * @copyright 2014 Andrew Nicols
38 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
39 */
91223df6
AN
40class reply_handler extends \core\message\inbound\handler {
41
42 /**
43 * Return a description for the current handler.
44 *
45 * @return string
46 */
47 public function get_description() {
48 return get_string('reply_handler', 'mod_forum');
49 }
50
51 /**
52 * Return a short name for the current handler.
53 * This appears in the admin pages as a human-readable name.
54 *
55 * @return string
56 */
57 public function get_name() {
58 return get_string('reply_handler_name', 'mod_forum');
59 }
60
61 /**
62 * Process a message received and validated by the Inbound Message processor.
63 *
e90a0396
SH
64 * @throws \core\message\inbound\processing_failed_exception
65 * @param \stdClass $messagedata The Inbound Message record
66 * @param \stdClass $messagedata The message data packet
91223df6
AN
67 * @return bool Whether the message was successfully processed.
68 */
69 public function process_message(\stdClass $record, \stdClass $messagedata) {
e90a0396 70 global $DB, $USER;
91223df6
AN
71
72 // Load the post being replied to.
73 $post = $DB->get_record('forum_posts', array('id' => $record->datavalue));
74 if (!$post) {
75 mtrace("--> Unable to find a post matching with id {$record->datavalue}");
76 return false;
77 }
78
79 // Load the discussion that this post is in.
80 $discussion = $DB->get_record('forum_discussions', array('id' => $post->discussion));
81 if (!$post) {
82 mtrace("--> Unable to find the discussion for post {$record->datavalue}");
83 return false;
84 }
85
86 // Load the other required data.
87 $forum = $DB->get_record('forum', array('id' => $discussion->forum));
88 $course = $DB->get_record('course', array('id' => $forum->course));
91223df6
AN
89 $cm = get_fast_modinfo($course->id)->instances['forum'][$forum->id];
90 $modcontext = \context_module::instance($cm->id);
91 $usercontext = \context_user::instance($USER->id);
92
93 // Make sure user can post in this discussion.
94 $canpost = true;
95 if (!forum_user_can_post($forum, $discussion, $USER, $cm, $course, $modcontext)) {
96 $canpost = false;
97 }
98
99 if (isset($cm->groupmode) && empty($course->groupmodeforce)) {
100 $groupmode = $cm->groupmode;
101 } else {
102 $groupmode = $course->groupmode;
103 }
104 if ($groupmode == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $modcontext)) {
105 if ($discussion->groupid == -1) {
106 $canpost = false;
107 } else {
108 if (!groups_is_member($discussion->groupid)) {
109 $canpost = false;
110 }
111 }
112 }
113
114 if (!$canpost) {
115 $data = new \stdClass();
116 $data->forum = $forum;
e90a0396 117 throw new \core\message\inbound\processing_failed_exception('messageinboundnopostforum', 'mod_forum', $data);
91223df6
AN
118 }
119
120 // And check the availability.
5d78635e 121 if (!\core_availability\info_module::is_user_visible($cm)) {
91223df6
AN
122 $data = new \stdClass();
123 $data->forum = $forum;
e90a0396 124 throw new \core\message\inbound\processing_failed_exception('messageinboundforumhidden', 'mod_forum', $data);
91223df6
AN
125 }
126
127 // Before we add this we must check that the user will not exceed the blocking threshold.
128 // This should result in an appropriate reply.
129 $thresholdwarning = forum_check_throttling($forum, $cm);
130 if (!empty($thresholdwarning) && !$thresholdwarning->canpost) {
131 $data = new \stdClass();
132 $data->forum = $forum;
133 $data->message = get_string($thresholdwarning->errorcode, $thresholdwarning->module, $thresholdwarning->additional);
e90a0396 134 throw new \core\message\inbound\processing_failed_exception('messageinboundthresholdhit', 'mod_forum', $data);
91223df6
AN
135 }
136
338ee3d6
AN
137 $subject = clean_param($messagedata->envelope->subject, PARAM_TEXT);
138 $restring = get_string('re', 'forum');
139 if (strpos($subject, $discussion->name)) {
140 // The discussion name is mentioned in the e-mail subject. This is probably just the standard reply. Use the
141 // standard reply subject instead.
142 $newsubject = $restring . ' ' . $discussion->name;
143 mtrace("--> Note: Post subject matched discussion name. Optimising from {$subject} to {$newsubject}");
144 $subject = $newsubject;
145 } else if (strpos($subject, $post->subject)) {
146 // The replied-to post's subject is mentioned in the e-mail subject.
147 // Use the previous post's subject instead of the e-mail subject.
148 $newsubject = $post->subject;
149 if (!strpos($restring, $post->subject)) {
150 // The previous post did not contain a re string, add it.
72590a51 151 $newsubject = $restring . ' ' . $newsubject;
338ee3d6
AN
152 }
153 mtrace("--> Note: Post subject matched original post subject. Optimising from {$subject} to {$newsubject}");
154 $subject = $newsubject;
155 }
156
91223df6
AN
157 $addpost = new \stdClass();
158 $addpost->course = $course->id;
159 $addpost->forum = $forum->id;
160 $addpost->discussion = $discussion->id;
161 $addpost->modified = $messagedata->timestamp;
338ee3d6 162 $addpost->subject = $subject;
91223df6
AN
163 $addpost->parent = $post->id;
164 $addpost->itemid = file_get_unused_draft_itemid();
165
aef3c18b
AA
166 list ($message, $format) = self::remove_quoted_text($messagedata);
167 $addpost->message = $message;
168 $addpost->messageformat = $format;
91223df6
AN
169
170 // We don't trust text coming from e-mail.
171 $addpost->messagetrust = false;
172
173 // Add attachments to the post.
174 if (!empty($messagedata->attachments['attachment']) && count($messagedata->attachments['attachment'])) {
175 $attachmentcount = count($messagedata->attachments['attachment']);
581e75bf 176 if (!forum_can_create_attachment($forum, $modcontext)) {
91223df6
AN
177 // Attachments are not allowed.
178 mtrace("--> User does not have permission to attach files in this forum. Rejecting e-mail.");
179
180 $data = new \stdClass();
181 $data->forum = $forum;
182 $data->attachmentcount = $attachmentcount;
e90a0396 183 throw new \core\message\inbound\processing_failed_exception('messageinboundattachmentdisallowed', 'mod_forum', $data);
91223df6
AN
184 }
185
186 if ($forum->maxattachments < $attachmentcount) {
187 // Too many attachments.
188 mtrace("--> User attached {$attachmentcount} files when only {$forum->maxattachments} where allowed. "
189 . " Rejecting e-mail.");
190
191 $data = new \stdClass();
192 $data->forum = $forum;
193 $data->attachmentcount = $attachmentcount;
e90a0396 194 throw new \core\message\inbound\processing_failed_exception('messageinboundfilecountexceeded', 'mod_forum', $data);
91223df6
AN
195 }
196
197 $filesize = 0;
198 $addpost->attachments = file_get_unused_draft_itemid();
199 foreach ($messagedata->attachments['attachment'] as $attachment) {
200 mtrace("--> Processing {$attachment->filename} as an attachment.");
201 $this->process_attachment('*', $usercontext, $addpost->attachments, $attachment);
202 $filesize += $attachment->filesize;
203 }
204
205 if ($forum->maxbytes < $filesize) {
206 // Too many attachments.
207 mtrace("--> User attached {$filesize} bytes of files when only {$forum->maxbytes} where allowed. "
208 . "Rejecting e-mail.");
209 $data = new \stdClass();
210 $data->forum = $forum;
211 $data->maxbytes = display_size($forum->maxbytes);
212 $data->filesize = display_size($filesize);
e90a0396 213 throw new \core\message\inbound\processing_failed_exception('messageinboundfilesizeexceeded', 'mod_forum', $data);
91223df6
AN
214 }
215 }
216
217 // Process any files in the message itself.
218 if (!empty($messagedata->attachments['inline'])) {
219 foreach ($messagedata->attachments['inline'] as $attachment) {
220 mtrace("--> Processing {$attachment->filename} as an inline attachment.");
221 $this->process_attachment('*', $usercontext, $addpost->itemid, $attachment);
222
223 // Convert the contentid link in the message.
224 $draftfile = \moodle_url::make_draftfile_url($addpost->itemid, '/', $attachment->filename);
225 $addpost->message = preg_replace('/cid:' . $attachment->contentid . '/', $draftfile, $addpost->message);
226 }
227 }
228
229 // Insert the message content now.
230 $addpost->id = forum_add_new_post($addpost, true);
231
232 // Log the new post creation.
233 $params = array(
234 'context' => $modcontext,
235 'objectid' => $addpost->id,
236 'other' => array(
237 'discussionid' => $discussion->id,
238 'forumid' => $forum->id,
239 'forumtype' => $forum->type,
240 )
241 );
242 $event = \mod_forum\event\post_created::create($params);
243 $event->add_record_snapshot('forum_posts', $addpost);
244 $event->add_record_snapshot('forum_discussions', $discussion);
245 $event->trigger();
246
346ba4f4
CW
247 // Update completion state.
248 $completion = new \completion_info($course);
249 if ($completion->is_enabled($cm) && ($forum->completionreplies || $forum->completionposts)) {
250 $completion->update_state($cm, COMPLETION_COMPLETE);
251
252 mtrace("--> Updating completion status for user {$USER->id} in forum {$forum->id} for post {$addpost->id}.");
253 }
254
91223df6
AN
255 mtrace("--> Created a post {$addpost->id} in {$discussion->id}.");
256 return $addpost;
257 }
258
259 /**
260 * Process attachments included in a message.
261 *
e90a0396
SH
262 * @param string[] $acceptedtypes String The mimetypes of the acceptable attachment types.
263 * @param \context_user $context context_user The context of the user creating this attachment.
264 * @param int $itemid int The itemid to store this attachment under.
265 * @param \stdClass $attachment stdClass The Attachment data to store.
266 * @return \stored_file
91223df6
AN
267 */
268 protected function process_attachment($acceptedtypes, \context_user $context, $itemid, \stdClass $attachment) {
e90a0396 269 global $USER, $CFG;
91223df6
AN
270
271 // Create the file record.
272 $record = new \stdClass();
273 $record->filearea = 'draft';
274 $record->component = 'user';
275
276 $record->itemid = $itemid;
277 $record->license = $CFG->sitedefaultlicense;
278 $record->author = fullname($USER);
279 $record->contextid = $context->id;
280 $record->userid = $USER->id;
281
282 // All files sent by e-mail should have a flat structure.
283 $record->filepath = '/';
284
285 $record->filename = $attachment->filename;
286
287 mtrace("--> Attaching {$record->filename} to " .
288 "/{$record->contextid}/{$record->component}/{$record->filearea}/" .
289 "{$record->itemid}{$record->filepath}{$record->filename}");
290
291 $fs = get_file_storage();
292 return $fs->create_file_from_string($record, $attachment->content);
293 }
294
91223df6
AN
295 /**
296 * Return the content of any success notification to be sent.
297 * Both an HTML and Plain Text variant must be provided.
298 *
299 * @param \stdClass $messagedata The message data.
300 * @param \stdClass $handlerresult The record for the newly created post.
301 * @return \stdClass with keys `html` and `plain`.
302 */
303 public function get_success_message(\stdClass $messagedata, $handlerresult) {
304 $a = new \stdClass();
305 $a->subject = $handlerresult->subject;
306 $discussionurl = new \moodle_url('/mod/forum/discuss.php', array('d' => $handlerresult->discussion));
f0b7925f 307 $discussionurl->set_anchor('p' . $handlerresult->id);
91223df6
AN
308 $a->discussionurl = $discussionurl->out();
309
310 $message = new \stdClass();
311 $message->plain = get_string('postbymailsuccess', 'mod_forum', $a);
312 $message->html = get_string('postbymailsuccess_html', 'mod_forum', $a);
313 return $message;
314 }
91223df6 315}