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(context_user::instance($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 = context_system::instance();
  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 if (!message_current_user_is_involved($user1, $user2) && !has_capability('moodle/site:readallmessages', $context)) {
 121     print_error('accessdenied','admin');
 122 }
 123
 124 /// Process any contact maintenance requests there may be
 125 if ($addcontact and confirm_sesskey()) {
 126     add_to_log(SITEID, 'message', 'add contact', 'index.php?user1='.$addcontact.'&amp;user2='.$USER->id, $addcontact);
 127     message_add_contact($addcontact);
 128     redirect($CFG->wwwroot . '/message/index.php?viewing=contacts&id='.$addcontact);
 129 }
 130 if ($removecontact and confirm_sesskey()) {
 131     add_to_log(SITEID, 'message', 'remove contact', 'index.php?user1='.$removecontact.'&amp;user2='.$USER->id, $removecontact);
 132     message_remove_contact($removecontact);
 133 }
 134 if ($blockcontact and confirm_sesskey()) {
 135     add_to_log(SITEID, 'message', 'block contact', 'index.php?user1='.$blockcontact.'&amp;user2='.$USER->id, $blockcontact);
 136     message_block_contact($blockcontact);
 137 }
 138 if ($unblockcontact and confirm_sesskey()) {
 139     add_to_log(SITEID, 'message', 'unblock contact', 'index.php?user1='.$unblockcontact.'&amp;user2='.$USER->id, $unblockcontact);
 140     message_unblock_contact($unblockcontact);
 141 }
 142
 143 //was a message sent? Do NOT allow someone looking at someone else's messages to send them.
 144 $messageerror = null;
 145 if ($currentuser && !empty($user2) && has_capability('moodle/site:sendmessage', $context)) {
 146     // Check that the user is not blocking us!!
 147     if ($contact = $DB->get_record('message_contacts', array('userid' => $user2->id, 'contactid' => $user1->id))) {
 148         if ($contact->blocked and !has_capability('moodle/site:readallmessages', $context)) {
 149             $messageerror = get_string('userisblockingyou', 'message');
 150         }
 151     }
 152     $userpreferences = get_user_preferences(NULL, NULL, $user2->id);
 153
 154     if (!empty($userpreferences['message_blocknoncontacts'])) {  // User is blocking non-contacts
 155         if (empty($contact)) {   // We are not a contact!
 156             $messageerror = get_string('userisblockingyounoncontact', 'message', fullname($user2));
 157         }
 158     }
 159
 160     if (empty($messageerror)) {
 161         $mform = new send_form();
 162         $defaultmessage = new stdClass;
 163         $defaultmessage->id = $user2->id;
 164         $defaultmessage->message = '';
 165
 166         //Check if the current user has sent a message
 167         $data = $mform->get_data();
 168         if (!empty($data) && !empty($data->message)) {
 169             if (!confirm_sesskey()) {
 170                 print_error('invalidsesskey');
 171             }
 172             $messageid = message_post_message($user1, $user2, $data->message, FORMAT_MOODLE);
 173             if (!empty($messageid)) {
 174                 //including the id of the user sending the message in the logged URL so the URL works for admins
 175                 //note message ID may be misleading as the message may potentially get a different ID when moved from message to message_read
 176                 add_to_log(SITEID, 'message', 'write', 'index.php?user='.$user1->id.'&id='.$user2->id.'&history=1#m'.$messageid, $user1->id);
 177                 redirect($CFG->wwwroot . '/message/index.php?viewing='.$viewing.'&id='.$user2->id);
 178             }
 179         }
 180     }
 181 }
 182
 183 $strmessages = get_string('messages', 'message');
 184 if (!empty($user2)) {
 185     $user2fullname = fullname($user2);
 186
 187     $PAGE->set_title("$strmessages: $user2fullname");
 188     $PAGE->set_heading("$strmessages: $user2fullname");
 189 } else {
 190     $PAGE->set_title("{$SITE->shortname}: $strmessages");
 191     $PAGE->set_heading("{$SITE->shortname}: $strmessages");
 192 }
 193
 194 //now the page contents
 195 echo $OUTPUT->header();
 196
 197 echo $OUTPUT->box_start('message');
 198
 199 $countunread = 0; //count of unread messages from $user2
 200 $countunreadtotal = 0; //count of unread messages from all users
 201
 202 //we're dealing with unread messages early so the contact list will accurately reflect what is read/unread
 203 $viewingnewmessages = false;
 204 if (!empty($user2)) {
 205     //are there any unread messages from $user2
 206     $countunread = message_count_unread_messages($user1, $user2);
 207     if ($countunread>0) {
 208         //mark the messages we're going to display as read
 209         message_mark_messages_read($user1->id, $user2->id);
 210          if($viewing == MESSAGE_VIEW_UNREAD_MESSAGES) {
 211              $viewingnewmessages = true;
 212          }
 213     }
 214 }
 215 $countunreadtotal = message_count_unread_messages($user1);
 216
 217 if ($countunreadtotal == 0 && $viewing == MESSAGE_VIEW_UNREAD_MESSAGES && empty($user2)) {
 218     //default to showing the search
 219     $viewing = MESSAGE_VIEW_SEARCH;
 220 }
 221
 222 $blockedusers = message_get_blocked_users($user1, $user2);
 223 $countblocked = count($blockedusers);
 224
 225 list($onlinecontacts, $offlinecontacts, $strangers) = message_get_contacts($user1, $user2);
 226
 227 message_print_contact_selector($countunreadtotal, $viewing, $user1, $user2, $blockedusers, $onlinecontacts, $offlinecontacts, $strangers, $showcontactactionlinks, $page);
 228
 229 echo html_writer::start_tag('div', array('class' => 'messagearea mdl-align'));
 230     if (!empty($user2)) {
 231
 232         echo html_writer::start_tag('div', array('class' => 'mdl-left messagehistory'));
 233
 234             $visible = 'visible';
 235             $hidden = 'hiddenelement'; //cant just use hidden as mform adds that class to its fieldset for something else
 236
 237             $recentlinkclass = $recentlabelclass = $historylinkclass = $historylabelclass = $visible;
 238             if ($history == MESSAGE_HISTORY_ALL) {
 239                 $displaycount = 0;
 240
 241                 $recentlabelclass = $historylinkclass = $hidden;
 242             } else if($viewingnewmessages) {
 243                 //if user is viewing new messages only show them the new messages
 244                 $displaycount = $countunread;
 245
 246                 $recentlabelclass = $historylabelclass = $hidden;
 247             } else {
 248                 //default to only showing the last few messages
 249                 $displaycount = MESSAGE_SHORTVIEW_LIMIT;
 250
 251                 if ($countunread>MESSAGE_SHORTVIEW_LIMIT) {
 252                     $displaycount = $countunread;
 253                 }
 254
 255                 $recentlinkclass = $historylabelclass = $hidden;
 256             }
 257
 258             $messagehistorylink =  html_writer::start_tag('div', array('class' => 'mdl-align messagehistorytype'));
 259                 $messagehistorylink .= html_writer::link($PAGE->url->out(false).'&history='.MESSAGE_HISTORY_ALL,
 260                     get_string('messagehistoryfull','message'),
 261                     array('class' => $historylinkclass));
 262
 263                 $messagehistorylink .=  html_writer::start_tag('span', array('class' => $historylabelclass));
 264                     $messagehistorylink .= get_string('messagehistoryfull','message');
 265                 $messagehistorylink .= html_writer::end_tag('span');
 266
 267                 $messagehistorylink .= '&nbsp;|&nbsp;'.html_writer::link($PAGE->url->out(false).'&history='.MESSAGE_HISTORY_SHORT,
 268                     get_string('mostrecent','message'),
 269                     array('class' => $recentlinkclass));
 270
 271                 $messagehistorylink .=  html_writer::start_tag('span', array('class' => $recentlabelclass));
 272                     $messagehistorylink .= get_string('mostrecent','message');
 273                 $messagehistorylink .= html_writer::end_tag('span');
 274
 275                 if ($viewingnewmessages) {
 276                     $messagehistorylink .=  '&nbsp;|&nbsp;'.html_writer::start_tag('span');//, array('class' => $historyclass)
 277                         $messagehistorylink .= get_string('unreadnewmessages','message',$displaycount);
 278                     $messagehistorylink .= html_writer::end_tag('span');
 279                 }
 280
 281             $messagehistorylink .= html_writer::end_tag('div');
 282
 283             message_print_message_history($user1, $user2, $search, $displaycount, $messagehistorylink, $viewingnewmessages);
 284         echo html_writer::end_tag('div');
 285
 286         //send message form
 287         if ($currentuser && has_capability('moodle/site:sendmessage', $context)) {
 288             echo html_writer::start_tag('div', array('class' => 'mdl-align messagesend'));
 289                 if (!empty($messageerror)) {
 290                     echo html_writer::tag('span', $messageerror, array('id' => 'messagewarning'));
 291                 } else {
 292                     // Display a warning if the current user is blocking non-contacts and is about to message to a non-contact
 293                     // Otherwise they may wonder why they never get a reply
 294                     $blocknoncontacts = get_user_preferences('message_blocknoncontacts', '', $user1->id);
 295                     if (!empty($blocknoncontacts)) {
 296                         $contact = $DB->get_record('message_contacts', array('userid' => $user1->id, 'contactid' => $user2->id));
 297                         if (empty($contact)) {
 298                             $msg = get_string('messagingblockednoncontact', 'message', fullname($user2));
 299                             echo html_writer::tag('span', $msg, array('id' => 'messagewarning'));
 300                         }
 301                     }
 302
 303                     $mform = new send_form();
 304                     $defaultmessage = new stdClass;
 305                     $defaultmessage->id = $user2->id;
 306                     $defaultmessage->message = '';
 307                     //$defaultmessage->messageformat = FORMAT_MOODLE;
 308                     $mform->set_data($defaultmessage);
 309                     $mform->display();
 310                 }
 311             echo html_writer::end_tag('div');
 312         }
 313     } else if ($viewing == MESSAGE_VIEW_SEARCH) {
 314         message_print_search($advancedsearch, $user1);
 315     } else if ($viewing == MESSAGE_VIEW_RECENT_CONVERSATIONS) {
 316         message_print_recent_conversations($user1);
 317     } else if ($viewing == MESSAGE_VIEW_RECENT_NOTIFICATIONS) {
 318         message_print_recent_notifications($user1);
 319     }
 320 echo html_writer::end_tag('div');
 321
 322 echo $OUTPUT->box_end();
 323
 324 echo $OUTPUT->footer();
 325
 326