Merge branch 'MDL-30544_disable_notifications' of git://github.com/andyjdavis/moodle
[moodle.git] / message / edit.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  * Edit user message preferences
20  *
21  * @author Luis Rodrigues and Martin Dougiamas
22  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  * @package message
24  */
26 require_once(dirname(__FILE__) . '/../config.php');
27 require_once($CFG->dirroot . '/message/lib.php');
29 $userid = optional_param('id', $USER->id, PARAM_INT);    // user id
30 $course = optional_param('course', SITEID, PARAM_INT);   // course id (defaults to Site)
31 $disableall = optional_param('disableall', 0, PARAM_BOOL); //disable all of this user's notifications
33 $url = new moodle_url('/message/edit.php');
34 if ($userid !== $USER->id) {
35     $url->param('id', $userid);
36 }
37 if ($course != SITEID) {
38     $url->param('course', $course);
39 }
40 $PAGE->set_url($url);
42 if (!$course = $DB->get_record('course', array('id' => $course))) {
43     print_error('invalidcourseid');
44 }
46 if ($course->id != SITEID) {
47     require_login($course);
49 } else {
50     if (!isloggedin()) {
51         if (empty($SESSION->wantsurl)) {
52             $SESSION->wantsurl = $CFG->httpswwwroot.'/message/edit.php';
53         }
54         redirect(get_login_url());
55     }
56 }
58 if (isguestuser()) {
59     print_error('guestnoeditmessage', 'message');
60 }
62 if (!$user = $DB->get_record('user', array('id' => $userid))) {
63     print_error('invaliduserid');
64 }
66 $systemcontext   = get_context_instance(CONTEXT_SYSTEM);
67 $personalcontext = get_context_instance(CONTEXT_USER, $user->id);
68 $coursecontext   = get_context_instance(CONTEXT_COURSE, $course->id);
70 $PAGE->set_context($personalcontext);
71 $PAGE->set_pagelayout('course');
72 $PAGE->requires->js_init_call('M.core_message.init_editsettings');
74 // check access control
75 if ($user->id == $USER->id) {
76     //editing own message profile
77     require_capability('moodle/user:editownmessageprofile', $systemcontext);
78     if ($course->id != SITEID && $node = $PAGE->navigation->find($course->id, navigation_node::TYPE_COURSE)) {
79         $node->make_active();
80         $PAGE->navbar->includesettingsbase = true;
81     }
82 } else {
83     // teachers, parents, etc.
84     require_capability('moodle/user:editmessageprofile', $personalcontext);
85     // no editing of guest user account
86     if (isguestuser($user->id)) {
87         print_error('guestnoeditmessageother', 'message');
88     }
89     // no editing of admins by non admins!
90     if (is_siteadmin($user) and !is_siteadmin($USER)) {
91         print_error('useradmineditadmin');
92     }
93     $PAGE->navigation->extend_for_user($user);
94 }
96 // Fetch message providers
97 $providers = message_get_providers_for_user($user->id);
99 /// Save new preferences if data was submitted
101 if (($form = data_submitted()) && confirm_sesskey()) {
102     $preferences = array();
104     //only update the user's "emailstop" if its actually changed
105     if ( $user->emailstop != $disableall ) {
106         $user->emailstop = $disableall;
107         $DB->set_field('user', 'emailstop', $user->emailstop, array("id"=>$user->id));
108     }
110     // Turning on emailstop disables the preference checkboxes in the browser.
111     // Disabled checkboxes may not be submitted with the form making them look (incorrectly) like they've been unchecked.
112     // Only alter the messaging preferences if emailstop is turned off
113     if (!$user->emailstop) {
114         foreach ($providers as $provider) {
115             $componentproviderbase = $provider->component.'_'.$provider->name;
116             foreach (array('loggedin', 'loggedoff') as $state) {
117                 $linepref = '';
118                 $componentproviderstate = $componentproviderbase.'_'.$state;
119                 if (array_key_exists($componentproviderstate, $form)) {
120                     foreach (array_keys($form->{$componentproviderstate}) as $process) {
121                         if ($linepref == ''){
122                             $linepref = $process;
123                         } else {
124                             $linepref .= ','.$process;
125                         }
126                     }
127                 }
128                 if (empty($linepref)) {
129                     $linepref = 'none';
130                 }
131                 $preferences['message_provider_'.$provider->component.'_'.$provider->name.'_'.$state] = $linepref;
132             }
133         }
134     }
136 /// Set all the processor options as well
137     $processors = get_message_processors(true);
138     foreach ($processors as $processor) {
139         $processor->object->process_form($form, $preferences);
140     }
142     //process general messaging preferences
143     $preferences['message_blocknoncontacts'] = !empty($form->blocknoncontacts)?1:0;
144     //$preferences['message_beepnewmessage']    = !empty($form->beepnewmessage)?1:0;
146     // Save all the new preferences to the database
147     if (!set_user_preferences($preferences, $user->id)) {
148         print_error('cannotupdateusermsgpref');
149     }
151     redirect("$CFG->wwwroot/message/edit.php?id=$user->id&course=$course->id");
154 /// Load preferences
155 $preferences = new stdClass();
156 $preferences->userdefaultemail = $user->email;//may be displayed by the email processor
158 /// Get providers preferences
159 foreach ($providers as $provider) {
160     foreach (array('loggedin', 'loggedoff') as $state) {
161         $linepref = get_user_preferences('message_provider_'.$provider->component.'_'.$provider->name.'_'.$state, '', $user->id);
162         if ($linepref == ''){
163             continue;
164         }
165         $lineprefarray = explode(',', $linepref);
166         $preferences->{$provider->component.'_'.$provider->name.'_'.$state} = array();
167         foreach ($lineprefarray as $pref) {
168             $preferences->{$provider->component.'_'.$provider->name.'_'.$state}[$pref] = 1;
169         }
170     }
173 // Load all processors
174 $processors = get_message_processors();
175 /// For every processors put its options on the form (need to get function from processor's lib.php)
176 foreach ($processors as $processor) {
177     $processor->object->load_data($preferences, $user->id);
180 //load general messaging preferences
181 $preferences->blocknoncontacts  =  get_user_preferences( 'message_blocknoncontacts', '', $user->id);
182 //$preferences->beepnewmessage    =  get_user_preferences( 'message_beepnewmessage', '', $user->id);
184 /// Display page header
185 $streditmymessage = get_string('editmymessage', 'message');
186 $strparticipants  = get_string('participants');
187 $userfullname     = fullname($user, true);
189 $PAGE->set_title("$course->shortname: $streditmymessage");
190 if ($course->id != SITEID) {
191     $PAGE->set_heading("$course->fullname: $streditmymessage");
192 } else {
193     $PAGE->set_heading($course->fullname);
196 // Grab the renderer
197 $renderer = $PAGE->get_renderer('core', 'message');
198 // Fetch default (site) preferences
199 $defaultpreferences = get_message_output_default_preferences();
201 $messagingoptions = $renderer->manage_messagingoptions($processors, $providers, $preferences, $defaultpreferences, $user->emailstop);
203 echo $OUTPUT->header();
204 echo $messagingoptions;
205 echo $OUTPUT->footer();