message/index.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/>.
  16
  17 /**
  18  * A page displaying the user's contacts and messages
  19  *
  20  * @package    core_message
  21  * @copyright  2010 Andrew Davis
  22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23  */
  24
  25 require_once('../config.php');
  26 require_once('lib.php');
  27 require_once('send_form.php');
  28
  29 require_login(0, false);
  30
  31 if (isguestuser()) {
  32     redirect($CFG->wwwroot);
  33 }
  34
  35 if (empty($CFG->messaging)) {
  36     print_error('disabled', 'message');
  37 }
  38
  39 //'viewing' is the preferred URL parameter but we'll still accept usergroup in case its referenced externally
  40 $usergroup = optional_param('usergroup', MESSAGE_VIEW_UNREAD_MESSAGES, PARAM_ALPHANUMEXT);
  41 $viewing = optional_param('viewing', $usergroup, PARAM_ALPHANUMEXT);
  42
  43 $history   = optional_param('history', MESSAGE_HISTORY_SHORT, PARAM_INT);
  44 $search    = optional_param('search', '', PARAM_CLEAN); //TODO: use PARAM_RAW, but make sure we use s() and p() properly
  45
  46 //the same param as 1.9 and the param we have been logging. Use this parameter.
  47 $user1id   = optional_param('user1', $USER->id, PARAM_INT);
  48 //2.0 shipped using this param. Retaining it only for compatibility. It should be removed.
  49 $user1id   = optional_param('user', $user1id, PARAM_INT);
  50
  51 //the same param as 1.9 and the param we have been logging. Use this parameter.
  52 $user2id   = optional_param('user2', 0, PARAM_INT);
  53 //The class send_form supplies the receiving user id as 'id'
  54 $user2id   = optional_param('id', $user2id, PARAM_INT);
  55
  56 $addcontact     = optional_param('addcontact',     0, PARAM_INT); // adding a contact
  57 $removecontact  = optional_param('removecontact',  0, PARAM_INT); // removing a contact
  58 $blockcontact   = optional_param('blockcontact',   0, PARAM_INT); // blocking a contact
  59 $unblockcontact = optional_param('unblockcontact', 0, PARAM_INT); // unblocking a contact
  60
  61 //for search
  62 $advancedsearch = optional_param('advanced', 0, PARAM_INT);
  63
  64 //if they have numerous contacts or are viewing course participants we might need to page through them
  65 $page = optional_param('page', 0, PARAM_INT);
  66
  67 $url = new moodle_url('/message/index.php');
  68
  69 if ($user2id !== 0) {
  70     $url->param('user2', $user2id);
  71 }
  72
  73 if ($user2id !== 0) {
  74     //Switch view back to contacts if:
  75     //1) theyve searched and selected a user
  76     //2) they've viewed recent messages or notifications and clicked through to a user
  77     if ($viewing == MESSAGE_VIEW_SEARCH || $viewing == MESSAGE_VIEW_SEARCH || $viewing == MESSAGE_VIEW_RECENT_NOTIFICATIONS) {
  78         $viewing = MESSAGE_VIEW_CONTACTS;
  79     }
  80 }
  81 $url->param('viewing', $viewing);
  82
  83 $PAGE->set_url($url);
  84
  85 $PAGE->set_context(get_context_instance(CONTEXT_USER, $USER->id));
  86 $PAGE->navigation->extend_for_user($USER);
  87 $PAGE->set_pagelayout('course');
  88
  89 // Disable message notification popups while the user is viewing their messages
  90 $PAGE->set_popup_notification_allowed(false);
  91
  92 $context = get_context_instance(CONTEXT_SYSTEM);
  93
  94 $user1 = null;
  95 $currentuser = true;
  96 $showcontactactionlinks = true;
  97 if ($user1id != $USER->id) {
  98     $user1 = $DB->get_record('user', array('id' => $user1id));
  99     if (!$user1) {
 100         print_error('invaliduserid');
 101     }
 102     $currentuser = false;//if we're looking at someone else's messages we need to lock/remove some UI elements
 103     $showcontactactionlinks = false;
 104 } else {
 105     $user1 = $USER;
 106 }
 107 unset($user1id);
 108
 109 $user2 = null;
 110 if (!empty($user2id)) {
 111     $user2 = $DB->get_record("user", array("id" => $user2id));
 112     if (!$user2) {
 113         print_error('invaliduserid');
 114     }
 115 }
 116 unset($user2id);
 117
 118 // Is the user involved in the conversation?
 119 // Do they have the ability to read other user's conversations?
 120 // There will always be a $user1
 121 // but $user2 may be null. For example, if viewing $user1's recent conversations
 122 if ($user1->id != $USER->id
 123     && (empty($user2) || $user2->id != $USER->id)
 124     && !has_capability('moodle/site:readallmessages', $context)){
 125
 126     print_error('accessdenied','admin');
 127 }
 128
 129 /// Process any contact maintenance requests there may be
 130 if ($addcontact and confirm_sesskey()) {
 131     add_to_log(SITEID, 'message', 'add contact', 'index.php?user1='.$addcontact.'&amp;user2='.$USER->id, $addcontact);
 132     message_add_contact($addcontact);
 133     redirect($CFG->wwwroot . '/message/index.php?viewing=contacts&id='.$addcontact);
 134 }
 135 if ($removecontact and confirm_sesskey()) {
 136     add_to_log(SITEID, 'message', 'remove contact', 'index.php?user1='.$removecontact.'&amp;user2='.$USER->id, $removecontact);
 137     message_remove_contact($removecontact);
 138 }
 139 if ($blockcontact and confirm_sesskey()) {
 140     add_to_log(SITEID, 'message', 'block contact', 'index.php?user1='.$blockcontact.'&amp;user2='.$USER->id, $blockcontact);
 141     message_block_contact($blockcontact);
 142 }
 143 if ($unblockcontact and confirm_sesskey()) {
 144     add_to_log(SITEID, 'message', 'unblock contact', 'index.php?user1='.$unblockcontact.'&amp;user2='.$USER->id, $unblockcontact);
 145     message_unblock_contact($unblockcontact);
 146 }
 147
 148 //was a message sent? Do NOT allow someone looking at someone else's messages to send them.
 149 $messageerror = null;
 150 if ($currentuser && !empty($user2) && has_capability('moodle/site:sendmessage', $context)) {
 151     // Check that the user is not blocking us!!
 152     if ($contact = $DB->get_record('message_contacts', array('userid' => $user2->id, 'contactid' => $user1->id))) {
 153         if ($contact->blocked and !has_capability('moodle/site:readallmessages', $context)) {
 154             $messageerror = get_string('userisblockingyou', 'message');
 155         }
 156     }
 157     $userpreferences = get_user_preferences(NULL, NULL, $user2->id);
 158
 159     if (!empty($userpreferences['message_blocknoncontacts'])) {  // User is blocking non-contacts
 160         if (empty($contact)) {   // We are not a contact!
 161             $messageerror = get_string('userisblockingyounoncontact', 'message');
 162         }
 163     }
 164
 165     if (empty($messageerror)) {
 166         $mform = new send_form();
 167         $defaultmessage = new stdClass;
 168         $defaultmessage->id = $user2->id;
 169         $defaultmessage->message = '';
 170
 171         //Check if the current user has sent a message
 172         $data = $mform->get_data();
 173         if (!empty($data) && !empty($data->message)) {
 174             if (!confirm_sesskey()) {
 175                 print_error('invalidsesskey');
 176             }
 177             $messageid = message_post_message($user1, $user2, $data->message, FORMAT_MOODLE);
 178             if (!empty($messageid)) {
 179                 //including the id of the user sending the message in the logged URL so the URL works for admins
 180                 //note message ID may be misleading as the message may potentially get a different ID when moved from message to message_read
 181                 add_to_log(SITEID, 'message', 'write', 'index.php?user='.$user1->id.'&id='.$user2->id.'&history=1#m'.$messageid, $user1->id);
 182                 redirect($CFG->wwwroot . '/message/index.php?viewing='.$viewing.'&id='.$user2->id);
 183             }
 184         }
 185     }
 186 }
 187
 188 $strmessages = get_string('messages', 'message');
 189 if (!empty($user2)) {
 190     $user2fullname = fullname($user2);
 191
 192     $PAGE->set_title("$strmessages: $user2fullname");
 193     $PAGE->set_heading("$strmessages: $user2fullname");
 194 } else {
 195     $PAGE->set_title("{$SITE->shortname}: $strmessages");
 196     $PAGE->set_heading("{$SITE->shortname}: $strmessages");
 197 }
 198
 199 //now the page contents
 200 echo $OUTPUT->header();
 201
 202 echo $OUTPUT->box_start('message');
 203
 204 $countunread = 0; //count of unread messages from $user2
 205 $countunreadtotal = 0; //count of unread messages from all users
 206
 207 //we're dealing with unread messages early so the contact list will accurately reflect what is read/unread
 208 $viewingnewmessages = false;
 209 if (!empty($user2)) {
 210     //are there any unread messages from $user2
 211     $countunread = message_count_unread_messages($user1, $user2);
 212     if ($countunread>0) {
 213         //mark the messages we're going to display as read
 214         message_mark_messages_read($user1->id, $user2->id);
 215          if($viewing == MESSAGE_VIEW_UNREAD_MESSAGES) {
 216              $viewingnewmessages = true;
 217          }
 218     }
 219 }
 220 $countunreadtotal = message_count_unread_messages($user1);
 221
 222 if ($countunreadtotal == 0 && $viewing == MESSAGE_VIEW_UNREAD_MESSAGES && empty($user2)) {
 223     //default to showing the search
 224     $viewing = MESSAGE_VIEW_SEARCH;
 225 }
 226
 227 $blockedusers = message_get_blocked_users($user1, $user2);
 228 $countblocked = count($blockedusers);
 229
 230 list($onlinecontacts, $offlinecontacts, $strangers) = message_get_contacts($user1, $user2);
 231
 232 message_print_contact_selector($countunreadtotal, $viewing, $user1, $user2, $blockedusers, $onlinecontacts, $offlinecontacts, $strangers, $showcontactactionlinks, $page);
 233
 234 echo html_writer::start_tag('div', array('class' => 'messagearea mdl-align'));
 235     if (!empty($user2)) {
 236
 237         echo html_writer::start_tag('div', array('class' => 'mdl-left messagehistory'));
 238
 239             $visible = 'visible';
 240             $hidden = 'hiddenelement'; //cant just use hidden as mform adds that class to its fieldset for something else
 241
 242             $recentlinkclass = $recentlabelclass = $historylinkclass = $historylabelclass = $visible;
 243             if ($history == MESSAGE_HISTORY_ALL) {
 244                 $displaycount = 0;
 245
 246                 $recentlabelclass = $historylinkclass = $hidden;
 247             } else if($viewingnewmessages) {
 248                 //if user is viewing new messages only show them the new messages
 249                 $displaycount = $countunread;
 250
 251                 $recentlabelclass = $historylabelclass = $hidden;
 252             } else {
 253                 //default to only showing the last few messages
 254                 $displaycount = MESSAGE_SHORTVIEW_LIMIT;
 255
 256                 if ($countunread>MESSAGE_SHORTVIEW_LIMIT) {
 257                     $displaycount = $countunread;
 258                 }
 259
 260                 $recentlinkclass = $historylabelclass = $hidden;
 261             }
 262
 263             $messagehistorylink =  html_writer::start_tag('div', array('class' => 'mdl-align messagehistorytype'));
 264                 $messagehistorylink .= html_writer::link($PAGE->url->out(false).'&history='.MESSAGE_HISTORY_ALL,
 265                     get_string('messagehistoryfull','message'),
 266                     array('class' => $historylinkclass));
 267
 268                 $messagehistorylink .=  html_writer::start_tag('span', array('class' => $historylabelclass));
 269                     $messagehistorylink .= get_string('messagehistoryfull','message');
 270                 $messagehistorylink .= html_writer::end_tag('span');
 271
 272                 $messagehistorylink .= '&nbsp;|&nbsp;'.html_writer::link($PAGE->url->out(false).'&history='.MESSAGE_HISTORY_SHORT,
 273                     get_string('mostrecent','message'),
 274                     array('class' => $recentlinkclass));
 275
 276                 $messagehistorylink .=  html_writer::start_tag('span', array('class' => $recentlabelclass));
 277                     $messagehistorylink .= get_string('mostrecent','message');
 278                 $messagehistorylink .= html_writer::end_tag('span');
 279
 280                 if ($viewingnewmessages) {
 281                     $messagehistorylink .=  '&nbsp;|&nbsp;'.html_writer::start_tag('span');//, array('class' => $historyclass)
 282                         $messagehistorylink .= get_string('unreadnewmessages','message',$displaycount);
 283                     $messagehistorylink .= html_writer::end_tag('span');
 284                 }
 285
 286             $messagehistorylink .= html_writer::end_tag('div');
 287
 288             message_print_message_history($user1, $user2, $search, $displaycount, $messagehistorylink, $viewingnewmessages);
 289         echo html_writer::end_tag('div');
 290
 291         //send message form
 292         if ($currentuser && has_capability('moodle/site:sendmessage', $context)) {
 293             echo html_writer::start_tag('div', array('class' => 'mdl-align messagesend'));
 294                 if (!empty($messageerror)) {
 295                     echo $OUTPUT->heading($messageerror, 3);
 296                 } else {
 297                     $mform = new send_form();
 298                     $defaultmessage = new stdClass;
 299                     $defaultmessage->id = $user2->id;
 300                     $defaultmessage->message = '';
 301                     //$defaultmessage->messageformat = FORMAT_MOODLE;
 302                     $mform->set_data($defaultmessage);
 303                     $mform->display();
 304                 }
 305             echo html_writer::end_tag('div');
 306         }
 307     } else if ($viewing == MESSAGE_VIEW_SEARCH) {
 308         message_print_search($advancedsearch, $user1);
 309     } else if ($viewing == MESSAGE_VIEW_RECENT_CONVERSATIONS) {
 310         message_print_recent_conversations($user1);
 311     } else if ($viewing == MESSAGE_VIEW_RECENT_NOTIFICATIONS) {
 312         message_print_recent_notifications($user1);
 313     }
 314 echo html_writer::end_tag('div');
 315
 316 echo $OUTPUT->box_end();
 317
 318 echo $OUTPUT->footer();
 319
 320