MDL-41956 messages: Accept attachments in send_message() in email message provider
[moodle.git] / message / output / email / message_output_email.php
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/>.
17 /**
18  * Contains the definiton of the email message processors (sends messages to users via email)
19  *
20  * @package   message_email
21  * @copyright 2008 Luis Rodrigues and Martin Dougiamas
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 require_once($CFG->dirroot.'/message/output/lib.php');
27 /**
28  * The email message processor
29  *
30  * @package   message_email
31  * @copyright 2008 Luis Rodrigues and Martin Dougiamas
32  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
33  */
34 class message_output_email extends message_output {
35     /**
36      * Processes the message (sends by email).
37      * @param object $eventdata the event data submitted by the message sender plus $eventdata->savedmessageid
38      */
39     function send_message($eventdata) {
40         global $CFG;
42         if (!empty($CFG->noemailever)) {
43             // hidden setting for development sites, set in config.php if needed
44             debugging('$CFG->noemailever active, no email message sent.', DEBUG_MINIMAL);
45             return true;
46         }
48         // skip any messaging suspended and deleted users
49         if ($eventdata->userto->auth === 'nologin' or $eventdata->userto->suspended or $eventdata->userto->deleted) {
50             return true;
51         }
53         //the user the email is going to
54         $recipient = null;
56         //check if the recipient has a different email address specified in their messaging preferences Vs their user profile
57         $emailmessagingpreference = get_user_preferences('message_processor_email_email', null, $eventdata->userto);
58         $emailmessagingpreference = clean_param($emailmessagingpreference, PARAM_EMAIL);
60         // If the recipient has set an email address in their preferences use that instead of the one in their profile
61         // but only if overriding the notification email address is allowed
62         if (!empty($emailmessagingpreference) && !empty($CFG->messagingallowemailoverride)) {
63             //clone to avoid altering the actual user object
64             $recipient = clone($eventdata->userto);
65             $recipient->email = $emailmessagingpreference;
66         } else {
67             $recipient = $eventdata->userto;
68         }
70         // Check if we have attachments to send.
71         $attachment = '';
72         $attachname = '';
73         if (!empty($CFG->allowattachments) && !empty($eventdata->attachment)) {
74             if (empty($eventdata->attachname)) {
75                 // Attachment needs a file name.
76                 debugging('Attachments should have a file name. No attachments have been sent.', DEBUG_DEVELOPER);
77             } else if (!($eventdata->attachment instanceof stored_file)) {
78                 // Attachment should be of a type stored_file.
79                 debugging('Attachments should be of type stored_file. No attachments have been sent.', DEBUG_DEVELOPER);
80             } else {
81                 // Copy attachment file to a temporary directory and get the file path.
82                 $attachment = $eventdata->attachment->copy_content_to_temp();
83                 // Function email_to_user() adds $CFG->dataroot to file path, so removing it here.
84                 $attachment = str_replace($CFG->dataroot, '', $attachment);
85                 // Get attachment file name.
86                 $attachname = clean_filename($eventdata->attachname);
87             }
88         }
90         $result = email_to_user($recipient, $eventdata->userfrom, $eventdata->subject, $eventdata->fullmessage,
91                                 $eventdata->fullmessagehtml, $attachment, $attachname);
93         // Remove an attachment file if any.
94         @unlink($attachment);
96         return $result;
97     }
99     /**
100      * Creates necessary fields in the messaging config form.
101      *
102      * @param array $preferences An array of user preferences
103      */
104     function config_form($preferences){
105         global $USER, $OUTPUT, $CFG;
107         if (empty($CFG->messagingallowemailoverride)) {
108             return null;
109         }
111         $inputattributes = array('size'=>'30', 'name'=>'email_email', 'value'=>$preferences->email_email);
112         $string = get_string('email','message_email') . ': ' . html_writer::empty_tag('input', $inputattributes);
114         if (empty($preferences->email_email) && !empty($preferences->userdefaultemail)) {
115             $string .= get_string('ifemailleftempty', 'message_email', $preferences->userdefaultemail);
116         }
118         if (!empty($preferences->email_email) && !validate_email($preferences->email_email)) {
119             $string .= $OUTPUT->container(get_string('invalidemail'), 'error');
120         }
122         return $string;
123     }
125     /**
126      * Parses the submitted form data and saves it into preferences array.
127      *
128      * @param stdClass $form preferences form class
129      * @param array $preferences preferences array
130      */
131     function process_form($form, &$preferences){
132         if (isset($form->email_email)) {
133             $preferences['message_processor_email_email'] = $form->email_email;
134         }
135     }
137     /**
138      * Returns the default message output settings for this output
139      *
140      * @return int The default settings
141      */
142     public function get_default_messaging_settings() {
143         return MESSAGE_PERMITTED + MESSAGE_DEFAULT_LOGGEDIN + MESSAGE_DEFAULT_LOGGEDOFF;
144     }
146     /**
147      * Loads the config data from database to put on the form during initial form display
148      *
149      * @param array $preferences preferences array
150      * @param int $userid the user id
151      */
152     function load_data(&$preferences, $userid){
153         $preferences->email_email = get_user_preferences( 'message_processor_email_email', '', $userid);
154     }
156     /**
157      * Returns true as message can be sent to internal support user.
158      *
159      * @return bool
160      */
161     public function can_send_to_any_users() {
162         return true;
163     }