Fix #281 Copy Moodle 3.3 messaging tool into attendance to allow multi-user messaging.

7 years ago · 06904c98d0
3 changed files with 241 additions and 3 deletions
--- a/message.html
+++ b/message.html
@ -0,0 +1,59 @@
+<form id="theform" method="post" action="messageselect.php">
+    <input type="hidden" name="id" value="<?php p($id) ?>" />
+    <input type="hidden" name="sesskey" value="<?php echo sesskey() ?>" />
+    <input type="hidden" name="returnto" value="<?php p($returnto) ?>" />
+    <input type="hidden" name="deluser" value="" />
+    <?php echo $OUTPUT->box_start(); ?>
+    <table border="0" cellpadding="5">
+        <tr valign="top">
+            <td align="right"><b>
+                <?php print_string("messagebody"); ?>:
+            </b></td>
+            <td align="left">
+                <?php print_textarea(true, 15, 65, 1, 1, "messagebody", $messagebody); ?>
+            </td>
+        </tr>
+
+        <tr valign="top">
+            <td align="right"><label for="menuformat"><b><?php print_string("formattexttype"); ?>:</b></label></td>
+            <td>
+                <?php
+        print_string('formathtml');
+        echo '<input type="hidden" name="format" value="'.FORMAT_HTML.'" />';
+                ?>
+            </td>
+        </tr>
+
+        <tr><td align="center" colspan="2">
+            <input type="submit" name="send" value="<?php print_string('sendmessage', 'message'); ?>" />
+            <input type="submit" name="preview" value="<?php print_string('preview'); ?>" />
+        </td></tr>
+    </table>
+    <?php echo $OUTPUT->box_end(); ?>
+    <table align="center"><tr><th colspan="4" scope="row"><?php print_string('currentlyselectedusers'); ?></th></tr>
+        <?php
+    if (count($SESSION->emailto[$id])) {
+        foreach ($SESSION->emailto[$id] as $user) {
+        echo '<tr><td>'.fullname($user,true).'</td>';
+            // Check to see if we should be showing the email address.
+            if ($user->maildisplay == 0) { // 0 = don't display my email to anyone.
+            echo '<td>' . get_string('emaildisplayhidden') . '</td><td>';
+                } else {
+                echo '<td>'.$user->email.'</td><td>';
+                }
+                if (empty($user->email)) {
+                $error = get_string('emailempty');
+                }
+                if (!empty($error)) {
+                echo $OUTPUT->pix_icon('t/emailno', $error);
+                unset($error);
+                }
+                echo '</td><td><input type="submit" onClick="this.form.deluser.value='.$user->id.';" value="' . get_string('remove') . '" /></td></tr>';
+        }
+        }
+        else {
+        echo '<tr><td colspan="3" align="center">'.get_string('nousersyet').'</td></tr>';
+        }
+        ?>
+    </table>
+</form>
--- a/messageselect.php
+++ b/messageselect.php
@ -0,0 +1,181 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Copied from Moodle 3.3 messageselect.php - allows sending messages to multiple users.
+ *
+ * @copyright 1999 Martin Dougiamas  http://dougiamas.com
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package core_user
+ */
+require_once('../../config.php');
+require_once($CFG->dirroot.'/message/lib.php');
+$id = required_param('id', PARAM_INT);
+$messagebody = optional_param('messagebody', '', PARAM_CLEANHTML);
+$send = optional_param('send', '', PARAM_BOOL);
+$preview = optional_param('preview', '', PARAM_BOOL);
+$edit = optional_param('edit', '', PARAM_BOOL);
+$returnto = optional_param('returnto', '', PARAM_LOCALURL);
+$format = optional_param('format', FORMAT_MOODLE, PARAM_INT);
+$deluser = optional_param('deluser', 0, PARAM_INT);
+$url = new moodle_url('/user/messageselect.php', array('id' => $id));
+if ($messagebody !== '') {
+    $url->param('messagebody', $messagebody);
+}
+if ($send !== '') {
+    $url->param('send', $send);
+}
+if ($preview !== '') {
+    $url->param('preview', $preview);
+}
+if ($edit !== '') {
+    $url->param('edit', $edit);
+}
+if ($returnto !== '') {
+    $url->param('returnto', $returnto);
+}
+if ($format !== FORMAT_MOODLE) {
+    $url->param('format', $format);
+}
+if ($deluser !== 0) {
+    $url->param('deluser', $deluser);
+}
+$PAGE->set_url($url);
+if (!$course = $DB->get_record('course', array('id' => $id))) {
+    print_error('invalidcourseid');
+}
+require_login($course);
+$coursecontext = context_course::instance($id);   // Course context.
+$systemcontext = context_system::instance();   // SYSTEM context.
+require_capability('moodle/course:bulkmessaging', $coursecontext);
+if (empty($SESSION->emailto)) {
+    $SESSION->emailto = array();
+}
+if (!array_key_exists($id, $SESSION->emailto)) {
+    $SESSION->emailto[$id] = array();
+}
+if ($deluser) {
+    if (array_key_exists($id, $SESSION->emailto) && array_key_exists($deluser, $SESSION->emailto[$id])) {
+        unset($SESSION->emailto[$id][$deluser]);
+    }
+}
+if (empty($SESSION->emailselect[$id]) || $messagebody) {
+    $SESSION->emailselect[$id] = array('messagebody' => $messagebody);
+}
+$messagebody = $SESSION->emailselect[$id]['messagebody'];
+$count = 0;
+if ($data = data_submitted()) {
+    require_sesskey();
+    $namefields = get_all_user_name_fields(true);
+    foreach ($data as $k => $v) {
+        if (preg_match('/^(user|teacher)(\d+)$/', $k, $m)) {
+            if (!array_key_exists($m[2], $SESSION->emailto[$id])) {
+                if ($user = $DB->get_record_select('user', "id = ?", array($m[2]), 'id, '.
+                    $namefields . ', idnumber, email, mailformat, lastaccess, lang, '.
+                    'maildisplay, auth, suspended, deleted, emailstop, username')) {
+                    $SESSION->emailto[$id][$m[2]] = $user;
+                    $count++;
+                }
+            }
+        }
+    }
+}
+if ($course->id == SITEID) {
+    $strtitle = get_string('sitemessage');
+    $PAGE->set_pagelayout('admin');
+} else {
+    $strtitle = get_string('coursemessage');
+    $PAGE->set_pagelayout('incourse');
+}
+$link = null;
+if (has_capability('moodle/course:viewparticipants', $coursecontext) ||
+    has_capability('moodle/site:viewparticipants', $systemcontext)) {
+    $link = new moodle_url("/user/index.php", array('id' => $course->id));
+}
+$PAGE->navbar->add(get_string('participants'), $link);
+$PAGE->navbar->add($strtitle);
+$PAGE->set_title($strtitle);
+$PAGE->set_heading($strtitle);
+echo $OUTPUT->header();
+
+if ($count) {
+    if ($count == 1) {
+        $heading = get_string('addedrecip', 'moodle', $count);
+    } else {
+        $heading = get_string('addedrecips', 'moodle', $count);
+    }
+    echo $OUTPUT->heading($heading);
+}
+if (!empty($messagebody) && !$edit && !$deluser && ($preview || $send)) {
+    require_sesskey();
+    if (count($SESSION->emailto[$id])) {
+        if (!empty($preview)) {
+            echo '<form method="post" action="messageselect.php" style="margin: 0 20px;">
+<input type="hidden" name="returnto" value="'.s($returnto).'" />
+<input type="hidden" name="id" value="'.$id.'" />
+<input type="hidden" name="format" value="'.$format.'" />
+<input type="hidden" name="sesskey" value="' . sesskey() . '" />
+';
+            echo "<h3>".get_string('previewhtml')."</h3>";
+            echo "<div class=\"messagepreview\">\n".format_text($messagebody, $format)."\n</div>\n";
+            echo '<p align="center"><input type="submit" name="send" value="'.get_string('sendmessage', 'message').'" />'."\n";
+            echo '<input type="submit" name="edit" value="'.get_string('update').'" /></p>';
+            echo "\n</form>";
+        } else if (!empty($send)) {
+            $fails = array();
+            foreach ($SESSION->emailto[$id] as $user) {
+                if (!message_post_message($USER, $user, $messagebody, $format)) {
+                    $user->fullname = fullname($user);
+                    $fails[] = get_string('messagedselecteduserfailed', 'moodle', $user);
+                };
+            }
+            if (empty($fails)) {
+                echo $OUTPUT->heading(get_string('messagedselectedusers'));
+                unset($SESSION->emailto[$id]);
+                unset($SESSION->emailselect[$id]);
+            } else {
+                echo $OUTPUT->heading(get_string('messagedselectedcountusersfailed', 'moodle', count($fails)));
+                echo '<ul>';
+                foreach ($fails as $f) {
+                    echo '<li>', $f, '</li>';
+                }
+                echo '</ul>';
+            }
+            echo '<p align="center"><a href="index.php?id='.$id.'">'.get_string('backtoparticipants').'</a></p>';
+        }
+        echo $OUTPUT->footer();
+        exit;
+    } else {
+        echo $OUTPUT->notification(get_string('nousersyet'));
+    }
+}
+echo '<p align="center"><a href="'.$returnto.'">'.get_string("keepsearching").'</a>'.
+    ((count($SESSION->emailto[$id])) ? ', '.get_string('usemessageform') : '').'</p>';
+if ((!empty($send) || !empty($preview) || !empty($edit)) && (empty($messagebody))) {
+    echo $OUTPUT->notification(get_string('allfieldsrequired'));
+}
+if (count($SESSION->emailto[$id])) {
+    require_sesskey();
+    require("message.html");
+}
+$PAGE->requires->yui_module('moodle-core-formchangechecker',
+    'M.core_formchangechecker.init',
+    array(array(
+        'formid' => 'theform'
+    ))
+);
+$PAGE->requires->string_for_js('changesmadereallygoaway', 'moodle');
+echo $OUTPUT->footer();
--- a/renderer.php
+++ b/renderer.php
@ -1177,8 +1177,6 @@ class mod_attendance_renderer extends plugin_renderer_base {
        if ($bulkmessagecapability) { // Require that the user can bulk message users.
            // Display check boxes that will allow the user to send a message to the students that have been checked.
            $output = html_writer::empty_tag('input', array('name' => 'sesskey', 'type' => 'hidden', 'value' => sesskey()));
-            $output .= html_writer::empty_tag('input', array('name' => 'formaction', 'type' => 'hidden',
-                                                             'value' => 'messageselect.php'));
            $output .= html_writer::empty_tag('input', array('name' => 'id', 'type' => 'hidden', 'value' => $COURSE->id));
            $output .= html_writer::empty_tag('input', array('name' => 'returnto', 'type' => 'hidden', 'value' => s(me())));
            $output .= html_writer::table($table).html_writer::tag('div', get_string('users').': '.count($reportdata->users));;
@ -1187,7 +1185,7 @@ class mod_attendance_renderer extends plugin_renderer_base {
                                                                   'value' => get_string('messageselectadd'),
                                                                   'class' => 'btn btn-secondary')),
                    array('class' => 'buttons'));
-            $url = new moodle_url('/user/action_redir.php');
+            $url = new moodle_url('/mod/attendance/messageselect.php');
            return html_writer::tag('form', $output, array('action' => $url->out(), 'method' => 'post'));
        } else {
            return html_writer::table($table).html_writer::tag('div', get_string('users').': '.count($reportdata->users));