Moodle release 3.0beta
[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');
32
33/**
34 * A Handler to process replies to forum posts.
35 *
36 * @copyright 2014 Andrew Nicols
37 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
38 */
91223df6
AN
39class reply_handler extends \core\message\inbound\handler {
40
41 /**
42 * Return a description for the current handler.
43 *
44 * @return string
45 */
46 public function get_description() {
47 return get_string('reply_handler', 'mod_forum');
48 }
49
50 /**
51 * Return a short name for the current handler.
52 * This appears in the admin pages as a human-readable name.
53 *
54 * @return string
55 */
56 public function get_name() {
57 return get_string('reply_handler_name', 'mod_forum');
58 }
59
60 /**
61 * Process a message received and validated by the Inbound Message processor.
62 *
e90a0396
SH
63 * @throws \core\message\inbound\processing_failed_exception
64 * @param \stdClass $messagedata The Inbound Message record
65 * @param \stdClass $messagedata The message data packet
91223df6
AN
66 * @return bool Whether the message was successfully processed.
67 */
68 public function process_message(\stdClass $record, \stdClass $messagedata) {
e90a0396 69 global $DB, $USER;
91223df6
AN
70
71 // Load the post being replied to.
72 $post = $DB->get_record('forum_posts', array('id' => $record->datavalue));
73 if (!$post) {
74 mtrace("--> Unable to find a post matching with id {$record->datavalue}");
75 return false;
76 }
77
78 // Load the discussion that this post is in.
79 $discussion = $DB->get_record('forum_discussions', array('id' => $post->discussion));
80 if (!$post) {
81 mtrace("--> Unable to find the discussion for post {$record->datavalue}");
82 return false;
83 }
84
85 // Load the other required data.
86 $forum = $DB->get_record('forum', array('id' => $discussion->forum));
87 $course = $DB->get_record('course', array('id' => $forum->course));
91223df6
AN
88 $cm = get_fast_modinfo($course->id)->instances['forum'][$forum->id];
89 $modcontext = \context_module::instance($cm->id);
90 $usercontext = \context_user::instance($USER->id);
91
92 // Make sure user can post in this discussion.
93 $canpost = true;
94 if (!forum_user_can_post($forum, $discussion, $USER, $cm, $course, $modcontext)) {
95 $canpost = false;
96 }
97
98 if (isset($cm->groupmode) && empty($course->groupmodeforce)) {
99 $groupmode = $cm->groupmode;
100 } else {
101 $groupmode = $course->groupmode;
102 }
103 if ($groupmode == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $modcontext)) {
104 if ($discussion->groupid == -1) {
105 $canpost = false;
106 } else {
107 if (!groups_is_member($discussion->groupid)) {
108 $canpost = false;
109 }
110 }
111 }
112
113 if (!$canpost) {
114 $data = new \stdClass();
115 $data->forum = $forum;
e90a0396 116 throw new \core\message\inbound\processing_failed_exception('messageinboundnopostforum', 'mod_forum', $data);
91223df6
AN
117 }
118
119 // And check the availability.
5d78635e 120 if (!\core_availability\info_module::is_user_visible($cm)) {
91223df6
AN
121 $data = new \stdClass();
122 $data->forum = $forum;
e90a0396 123 throw new \core\message\inbound\processing_failed_exception('messageinboundforumhidden', 'mod_forum', $data);
91223df6
AN
124 }
125
126 // Before we add this we must check that the user will not exceed the blocking threshold.
127 // This should result in an appropriate reply.
128 $thresholdwarning = forum_check_throttling($forum, $cm);
129 if (!empty($thresholdwarning) && !$thresholdwarning->canpost) {
130 $data = new \stdClass();
131 $data->forum = $forum;
132 $data->message = get_string($thresholdwarning->errorcode, $thresholdwarning->module, $thresholdwarning->additional);
e90a0396 133 throw new \core\message\inbound\processing_failed_exception('messageinboundthresholdhit', 'mod_forum', $data);
91223df6
AN
134 }
135
338ee3d6
AN
136 $subject = clean_param($messagedata->envelope->subject, PARAM_TEXT);
137 $restring = get_string('re', 'forum');
138 if (strpos($subject, $discussion->name)) {
139 // The discussion name is mentioned in the e-mail subject. This is probably just the standard reply. Use the
140 // standard reply subject instead.
141 $newsubject = $restring . ' ' . $discussion->name;
142 mtrace("--> Note: Post subject matched discussion name. Optimising from {$subject} to {$newsubject}");
143 $subject = $newsubject;
144 } else if (strpos($subject, $post->subject)) {
145 // The replied-to post's subject is mentioned in the e-mail subject.
146 // Use the previous post's subject instead of the e-mail subject.
147 $newsubject = $post->subject;
148 if (!strpos($restring, $post->subject)) {
149 // The previous post did not contain a re string, add it.
72590a51 150 $newsubject = $restring . ' ' . $newsubject;
338ee3d6
AN
151 }
152 mtrace("--> Note: Post subject matched original post subject. Optimising from {$subject} to {$newsubject}");
153 $subject = $newsubject;
154 }
155
91223df6
AN
156 $addpost = new \stdClass();
157 $addpost->course = $course->id;
158 $addpost->forum = $forum->id;
159 $addpost->discussion = $discussion->id;
160 $addpost->modified = $messagedata->timestamp;
338ee3d6 161 $addpost->subject = $subject;
91223df6
AN
162 $addpost->parent = $post->id;
163 $addpost->itemid = file_get_unused_draft_itemid();
164
aef3c18b
AA
165 list ($message, $format) = self::remove_quoted_text($messagedata);
166 $addpost->message = $message;
167 $addpost->messageformat = $format;
91223df6
AN
168
169 // We don't trust text coming from e-mail.
170 $addpost->messagetrust = false;
171
172 // Add attachments to the post.
173 if (!empty($messagedata->attachments['attachment']) && count($messagedata->attachments['attachment'])) {
174 $attachmentcount = count($messagedata->attachments['attachment']);
175 if (empty($forum->maxattachments) || $forum->maxbytes == 1 ||
176 !has_capability('mod/forum:createattachment', $modcontext)) {
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
247 mtrace("--> Created a post {$addpost->id} in {$discussion->id}.");
248 return $addpost;
249 }
250
251 /**
252 * Process attachments included in a message.
253 *
e90a0396
SH
254 * @param string[] $acceptedtypes String The mimetypes of the acceptable attachment types.
255 * @param \context_user $context context_user The context of the user creating this attachment.
256 * @param int $itemid int The itemid to store this attachment under.
257 * @param \stdClass $attachment stdClass The Attachment data to store.
258 * @return \stored_file
91223df6
AN
259 */
260 protected function process_attachment($acceptedtypes, \context_user $context, $itemid, \stdClass $attachment) {
e90a0396 261 global $USER, $CFG;
91223df6
AN
262
263 // Create the file record.
264 $record = new \stdClass();
265 $record->filearea = 'draft';
266 $record->component = 'user';
267
268 $record->itemid = $itemid;
269 $record->license = $CFG->sitedefaultlicense;
270 $record->author = fullname($USER);
271 $record->contextid = $context->id;
272 $record->userid = $USER->id;
273
274 // All files sent by e-mail should have a flat structure.
275 $record->filepath = '/';
276
277 $record->filename = $attachment->filename;
278
279 mtrace("--> Attaching {$record->filename} to " .
280 "/{$record->contextid}/{$record->component}/{$record->filearea}/" .
281 "{$record->itemid}{$record->filepath}{$record->filename}");
282
283 $fs = get_file_storage();
284 return $fs->create_file_from_string($record, $attachment->content);
285 }
286
91223df6
AN
287 /**
288 * Return the content of any success notification to be sent.
289 * Both an HTML and Plain Text variant must be provided.
290 *
291 * @param \stdClass $messagedata The message data.
292 * @param \stdClass $handlerresult The record for the newly created post.
293 * @return \stdClass with keys `html` and `plain`.
294 */
295 public function get_success_message(\stdClass $messagedata, $handlerresult) {
296 $a = new \stdClass();
297 $a->subject = $handlerresult->subject;
298 $discussionurl = new \moodle_url('/mod/forum/discuss.php', array('d' => $handlerresult->discussion));
299 $a->discussionurl = $discussionurl->out();
300
301 $message = new \stdClass();
302 $message->plain = get_string('postbymailsuccess', 'mod_forum', $a);
303 $message->html = get_string('postbymailsuccess_html', 'mod_forum', $a);
304 return $message;
305 }
91223df6 306}