Merge branch 'MDL-42951-master' of git://github.com/FMCorz/moodle
[moodle.git] / message / renderer.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 renderer objects for messaging
19  *
20  * @package    core_message
21  * @copyright  2011 Lancaster University Network Services Limited
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 defined('MOODLE_INTERNAL') || die();
27 /**
28  * message Renderer
29  *
30  * Class for rendering various message objects
31  *
32  * @package    core_message
33  * @subpackage message
34  * @copyright  2011 Lancaster University Network Services Limited
35  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36  */
37 class core_message_renderer extends plugin_renderer_base {
39     /**
40      * Display the interface to manage message outputs
41      *
42      * @param  array  $processors array of objects containing message processors
43      * @return string The text to render
44      */
45     public function manage_messageoutputs($processors) {
46         global $CFG;
47         // Display the current workflows
48         $table = new html_table();
49         $table->attributes['class'] = 'admintable generaltable';
50         $table->data        = array();
51         $table->head        = array(
52             get_string('name'),
53             get_string('enable'),
54             get_string('settings'),
55         );
56         $table->colclasses = array(
57             'displayname', 'availability', 'settings',
58         );
60         foreach ($processors as $processor) {
61             $row = new html_table_row();
62             $row->attributes['class'] = 'messageoutputs';
64             // Name
65             $name = new html_table_cell(get_string('pluginname', 'message_'.$processor->name));
67             // Enable
68             $enable = new html_table_cell();
69             $enable->attributes['class'] = 'mdl-align';
70             if (!$processor->available) {
71                 $enable->text = html_writer::nonempty_tag('span', get_string('outputnotavailable', 'message'), array('class' => 'error'));
72             } else if (!$processor->configured) {
73                 $enable->text = html_writer::nonempty_tag('span', get_string('outputnotconfigured', 'message'), array('class' => 'error'));
74             } else if ($processor->enabled) {
75                 $url = new moodle_url('/admin/message.php', array('disable' => $processor->id, 'sesskey' => sesskey()));
76                 $enable->text = html_writer::link($url, html_writer::empty_tag('img',
77                     array('src'   => $this->output->pix_url('t/hide'),
78                           'class' => 'iconsmall',
79                           'title' => get_string('outputenabled', 'message'),
80                           'alt'   => get_string('outputenabled', 'message'),
81                     )
82                 ));
83             } else {
84                 $row->attributes['class'] = 'dimmed_text';
85                 $url = new moodle_url('/admin/message.php', array('enable' => $processor->id, 'sesskey' => sesskey()));
86                 $enable->text = html_writer::link($url, html_writer::empty_tag('img',
87                     array('src'   => $this->output->pix_url('t/show'),
88                           'class' => 'iconsmall',
89                           'title' => get_string('outputdisabled', 'message'),
90                           'alt'   => get_string('outputdisabled', 'message'),
91                     )
92                 ));
93             }
94             // Settings
95             $settings = new html_table_cell();
96             if ($processor->available && $processor->hassettings) {
97                 $settingsurl = new moodle_url('settings.php', array('section' => 'messagesetting'.$processor->name));
98                 $settings->text = html_writer::link($settingsurl, get_string('settings', 'message'));
99             }
101             $row->cells = array($name, $enable, $settings);
102             $table->data[] = $row;
103         }
104         return html_writer::table($table);
105     }
107     /**
108      * Display the interface to manage default message outputs
109      *
110      * @param  array $processors  array of objects containing message processors
111      * @param  array $providers   array of objects containing message providers
112      * @param  array $preferences array of objects containing current preferences
113      * @return string The text to render
114      */
115     public function manage_defaultmessageoutputs($processors, $providers, $preferences) {
116         global $CFG;
118         // Prepare list of options for dropdown menu
119         $options = array();
120         foreach (array('disallowed', 'permitted', 'forced') as $setting) {
121             $options[$setting] = get_string($setting, 'message');
122         }
124         $output = html_writer::start_tag('form', array('id'=>'defaultmessageoutputs', 'method'=>'post'));
125         $output .= html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'sesskey', 'value'=>sesskey()));
127         // Display users outputs table
128         $table = new html_table();
129         $table->attributes['class'] = 'generaltable';
130         $table->data        = array();
131         $table->head        = array('');
133         // Populate the header row
134         foreach ($processors as $processor) {
135             $table->head[]  = get_string('pluginname', 'message_'.$processor->name);
136         }
137         // Add enable/disable to head
138         $table->head[] = get_string('enabled', 'core_message');
140         // Generate the matrix of settings for each provider and processor
141         foreach ($providers as $provider) {
142             $row = new html_table_row();
143             $row->attributes['class'] = 'defaultmessageoutputs';
144             $row->cells = array();
146             // Provider Name
147             $providername = get_string('messageprovider:'.$provider->name, $provider->component);
148             $row->cells[] = new html_table_cell($providername);
149             $providersettingprefix = $provider->component.'_'.$provider->name.'_';
150             $disableprovidersetting = $providersettingprefix.'disable';
151             $providerdisabled = !empty($preferences->$disableprovidersetting);
152             // Settings for each processor
153             foreach ($processors as $processor) {
154                 $cellcontent = '';
155                 foreach (array('permitted', 'loggedin', 'loggedoff') as $setting) {
156                     // pepare element and preference names
157                     $elementname = $providersettingprefix.$setting.'['.$processor->name.']';
158                     $preferencebase = $providersettingprefix.$setting;
159                     // prepare language bits
160                     $processorname = get_string('pluginname', 'message_'.$processor->name);
161                     $statename = get_string($setting, 'message');
162                     $labelparams = array(
163                         'provider'  => $providername,
164                         'processor' => $processorname,
165                         'state'     => $statename
166                     );
167                     if ($setting == 'permitted') {
168                         $label = get_string('sendingvia', 'message', $labelparams);
169                         // determine the current setting or use default
170                         $select = MESSAGE_DEFAULT_PERMITTED;
171                         $preference = $processor->name.'_provider_'.$preferencebase;
172                         if ($providerdisabled) {
173                             $select = MESSAGE_DISALLOWED;
174                         } else if (array_key_exists($preference, $preferences)) {
175                             $select = $preferences->{$preference};
176                         }
177                         // dropdown menu
178                         $cellcontent = html_writer::label($label, $elementname, true, array('class' => 'accesshide'));
179                         $cellcontent .= html_writer::select($options, $elementname, $select, false, array('id' => $elementname));
180                         $cellcontent .= html_writer::tag('div', get_string('defaults', 'message'));
181                     } else {
182                         $label = get_string('sendingviawhen', 'message', $labelparams);
183                         // determine the current setting based on the 'permitted' setting above
184                         $checked = false;
185                         if ($select == 'forced') {
186                             $checked = true;
187                         } else if ($select == 'permitted') {
188                             $preference = 'message_provider_'.$preferencebase;
189                             if (array_key_exists($preference, $preferences)) {
190                                 $checked = (int)in_array($processor->name, explode(',', $preferences->{$preference}));
191                             }
192                         }
193                         // generate content
194                         $cellcontent .= html_writer::start_tag('div');
195                         $cellcontent .= html_writer::label($label, $elementname, true, array('class' => 'accesshide'));
196                         $cellcontent .= html_writer::checkbox($elementname, 1, $checked, '', array('id' => $elementname));
197                         $cellcontent .= $statename;
198                         $cellcontent .= html_writer::end_tag('div');
199                     }
200                 }
201                 $row->cells[] = new html_table_cell($cellcontent);
202             }
203             $disableprovider = html_writer::checkbox($disableprovidersetting, 1, !$providerdisabled, '',
204                     array('id' => $disableprovidersetting, 'class' => 'messagedisable'));
205             $disableprovider = html_writer::tag('div', $disableprovider);
206             $row->cells[] = new html_table_cell($disableprovider);
207             $table->data[] = $row;
208         }
210         $output .= html_writer::table($table);
211         $output .= html_writer::start_tag('div', array('class' => 'form-buttons'));
212         $output .= html_writer::empty_tag('input', array('type' => 'submit', 'value' => get_string('savechanges','admin'), 'class' => 'form-submit'));
213         $output .= html_writer::end_tag('div');
214         $output .= html_writer::end_tag('form');
215         return $output;
216     }
218     /**
219      * Display the interface for messaging options
220      *
221      * @param array $processors Array of objects containing message processors
222      * @param array $providers Array of objects containing message providers
223      * @param array $preferences Array of objects containing current preferences
224      * @param array $defaultpreferences Array of objects containing site default preferences
225      * @param bool $notificationsdisabled Indicate if the user's "emailstop" flag is set (shouldn't receive any non-forced notifications)
226      * @return string The text to render
227      */
228     public function manage_messagingoptions($processors, $providers, $preferences, $defaultpreferences, $notificationsdisabled = false) {
229         // Filter out enabled, available system_configured and user_configured processors only.
230         $readyprocessors = array_filter($processors, create_function('$a', 'return $a->enabled && $a->configured && $a->object->is_user_configured();'));
232         // Start the form.  We're not using mform here because of our special formatting needs ...
233         $output = html_writer::start_tag('form', array('method'=>'post', 'class' => 'mform'));
234         $output .= html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'sesskey', 'value'=>sesskey()));
236         /// Settings table...
237         $output .= html_writer::start_tag('fieldset', array('id' => 'providers', 'class' => 'clearfix'));
238         $output .= html_writer::nonempty_tag('legend', get_string('providers_config', 'message'), array('class' => 'ftoggler'));
240         foreach($providers as $provider) {
241             if($provider->component != 'moodle') {
242                 $components[] = $provider->component;
243             }
244         }
245         // Lets arrange by components so that core settings (moodle) appear as the first table.
246         $components = array_unique($components);
247         asort($components);
248         array_unshift($components, 'moodle'); // pop it in front! phew!
249         asort($providers);
251         $numprocs = count($processors);
252         // Display the messaging options table(s)
253         foreach ($components as $component) {
254             $provideradded = false;
255             $table = new html_table();
256             $table->attributes['class'] = 'generaltable';
257             $table->data = array();
258             if ($component != 'moodle') {
259                 $componentname = get_string('pluginname', $component);
260             } else {
261                 $componentname = get_string('coresystem');
262             }
263             $table->head = array($componentname);
264             foreach ($readyprocessors as $processor) {
265                 $table->head[]  = get_string('pluginname', 'message_'.$processor->name);
266             }
267             // Populate the table with rows
268             foreach ($providers as $provider) {
269                 $preferencebase = $provider->component.'_'.$provider->name;
270                 // If provider component is not same or provider disabled then don't show.
271                 if (($provider->component != $component) ||
272                         (!empty($defaultpreferences->{$preferencebase.'_disable'}))) {
273                     continue;
274                 }
275                 $provideradded = true;
276                 $headerrow = new html_table_row();
277                 $providername = get_string('messageprovider:'.$provider->name, $provider->component);
278                 $providercell = new html_table_cell($providername);
279                 $providercell->header = true;
280                 $providercell->colspan = $numprocs;
281                 $providercell->attributes['class'] = 'c0';
282                 $headerrow->cells = array($providercell);
283                 $table->data[] = $headerrow;
285                 foreach (array('loggedin', 'loggedoff') as $state) {
286                     $optionrow = new html_table_row();
287                     $optionname = new html_table_cell(get_string($state.'description', 'message'));
288                     $optionname->attributes['class'] = 'c0';
289                     $optionrow->cells = array($optionname);
290                     foreach ($readyprocessors as $processor) {
291                         // determine the default setting
292                         $permitted = MESSAGE_DEFAULT_PERMITTED;
293                         $defaultpreference = $processor->name.'_provider_'.$preferencebase.'_permitted';
294                         if (isset($defaultpreferences->{$defaultpreference})) {
295                             $permitted = $defaultpreferences->{$defaultpreference};
296                         }
297                         // If settings are disallowed or forced, just display the
298                         // corresponding message, if not use user settings.
299                         if (in_array($permitted, array('disallowed', 'forced'))) {
300                             if ($state == 'loggedoff') {
301                                 // skip if we are rendering the second line
302                                 continue;
303                             }
304                             $cellcontent = html_writer::nonempty_tag('div', get_string($permitted, 'message'), array('class' => 'dimmed_text'));
305                             $optioncell = new html_table_cell($cellcontent);
306                             $optioncell->rowspan = 2;
307                             $optioncell->attributes['class'] = 'disallowed';
308                         } else {
309                             // determine user preferences and use them.
310                             $disabled = array();
311                             $checked = false;
312                             if ($notificationsdisabled) {
313                                 $disabled['disabled'] = 1;
314                             }
315                             // See if user has touched this preference
316                             if (isset($preferences->{$preferencebase.'_'.$state})) {
317                                 // User have some preferneces for this state in the database, use them
318                                 $checked = isset($preferences->{$preferencebase.'_'.$state}[$processor->name]);
319                             } else {
320                                 // User has not set this preference yet, using site default preferences set by admin
321                                 $defaultpreference = 'message_provider_'.$preferencebase.'_'.$state;
322                                 if (isset($defaultpreferences->{$defaultpreference})) {
323                                     $checked = (int)in_array($processor->name, explode(',', $defaultpreferences->{$defaultpreference}));
324                                 }
325                             }
326                             $elementname = $preferencebase.'_'.$state.'['.$processor->name.']';
327                             // prepare language bits
328                             $processorname = get_string('pluginname', 'message_'.$processor->name);
329                             $statename = get_string($state, 'message');
330                             $labelparams = array(
331                                 'provider'  => $providername,
332                                 'processor' => $processorname,
333                                 'state'     => $statename
334                             );
335                             $label = get_string('sendingviawhen', 'message', $labelparams);
336                             $cellcontent = html_writer::label($label, $elementname, true, array('class' => 'accesshide'));
337                             $cellcontent .= html_writer::checkbox($elementname, 1, $checked, '', array_merge(array('id' => $elementname, 'class' => 'notificationpreference'), $disabled));
338                             $optioncell = new html_table_cell($cellcontent);
339                             $optioncell->attributes['class'] = 'mdl-align';
340                         }
341                         $optionrow->cells[] = $optioncell;
342                     }
343                     $table->data[] = $optionrow;
344                 }
345             }
346             // Add settings only if provider added for component.
347             if ($provideradded) {
348                 $output .= html_writer::start_tag('div', array('class' => 'messagesettingcomponent'));
349                 $output .= html_writer::table($table);
350                 $output .= html_writer::end_tag('div');
351             }
352         }
354         $output .= html_writer::end_tag('fieldset');
356         foreach ($processors as $processor) {
357             if (($processorconfigform = $processor->object->config_form($preferences)) && $processor->enabled) {
358                 $output .= html_writer::start_tag('fieldset', array('id' => 'messageprocessor_'.$processor->name, 'class' => 'clearfix'));
359                 $output .= html_writer::nonempty_tag('legend', get_string('pluginname', 'message_'.$processor->name), array('class' => 'ftoggler'));
360                 $output .= html_writer::start_tag('div');
361                 $output .= $processorconfigform;
362                 $output .= html_writer::end_tag('div');
363                 $output .= html_writer::end_tag('fieldset');
364             }
365         }
367         $output .= html_writer::start_tag('fieldset', array('id' => 'messageprocessor_general', 'class' => 'clearfix'));
368         $output .= html_writer::nonempty_tag('legend', get_string('generalsettings','admin'), array('class' => 'ftoggler'));
370         $output .= html_writer::start_tag('div');
371         $output .= html_writer::checkbox('beepnewmessage', 1, $preferences->beepnewmessage, get_string('beepnewmessage', 'message'));
372         $output .= html_writer::end_tag('div');
374         $output .= html_writer::start_tag('div');
375         $output .= html_writer::checkbox('blocknoncontacts', 1, $preferences->blocknoncontacts, get_string('blocknoncontacts', 'message'));
376         $output .= html_writer::end_tag('div');
378         $disableallcheckbox = html_writer::checkbox('disableall', 1, $notificationsdisabled, get_string('disableall', 'message'), array('class'=>'disableallcheckbox'));
379         $disableallcheckbox .= $this->output->help_icon('disableall', 'message');
380         $output .= html_writer::nonempty_tag('div', $disableallcheckbox, array('class'=>'disableall'));
382         $output .= html_writer::end_tag('fieldset');
383         $output .= html_writer::start_tag('div', array('class' => 'mdl-align'));
384         $output .= html_writer::empty_tag('input', array('type' => 'submit', 'value' => get_string('updatemyprofile'), 'class' => 'form-submit'));
385         $output .= html_writer::end_tag('div');
387         $output .= html_writer::end_tag('form');
388         return $output;
389     }