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', array('user1' => $user1id));
  68
  69 if ($user2id !== 0) {
  70     $url->param('user2', $user2id);
  71
  72     //Switch view back to contacts if:
  73     //1) theyve searched and selected a user
  74     //2) they've viewed recent messages or notifications and clicked through to a user
  75     if ($viewing == MESSAGE_VIEW_SEARCH || $viewing == MESSAGE_VIEW_RECENT_NOTIFICATIONS) {
  76         $viewing = MESSAGE_VIEW_CONTACTS;
  77     }
  78 }
  79
  80 if ($viewing != MESSAGE_VIEW_UNREAD_MESSAGES) {
  81     $url->param('viewing', $viewing);
  82 }
  83
  84 $PAGE->set_url($url);
  85
  86 // Disable message notification popups while the user is viewing their messages
  87 $PAGE->set_popup_notification_allowed(false);
  88
  89 $user1 = null;
  90 $currentuser = true;
  91 $showactionlinks = true;
  92 if ($user1id != $USER->id) {
  93     $user1 = $DB->get_record('user', array('id' => $user1id));
  94     if (!$user1) {
  95         print_error('invaliduserid');
  96     }
  97     $currentuser = false;//if we're looking at someone else's messages we need to lock/remove some UI elements
  98     $showactionlinks = false;
  99 } else {
 100     $user1 = $USER;
 101 }
 102 unset($user1id);
 103
 104 $user2 = null;
 105 if (!empty($user2id)) {
 106     $user2 = core_user::get_user($user2id);
 107     if (!$user2) {
 108         print_error('invaliduserid');
 109     }
 110 }
 111 unset($user2id);
 112
 113 $user2realuser = !empty($user2) && core_user::is_real_user($user2->id);
 114 $showactionlinks = $showactionlinks && $user2realuser;
 115 $systemcontext = context_system::instance();
 116
 117 if ($currentuser === false && !has_capability('moodle/site:readallmessages', $systemcontext)) {
 118     print_error('accessdenied','admin');
 119 }
 120
 121 if (substr($viewing, 0, 7) == MESSAGE_VIEW_COURSE) {
 122     $courseid = intval(substr($viewing, 7));
 123     require_login($courseid);
 124     require_capability('moodle/course:viewparticipants', context_course::instance($courseid));
 125     $PAGE->set_pagelayout('incourse');
 126 } else {
 127     $PAGE->set_pagelayout('standard');
 128 }
 129 // Page context should always be set to user.
 130 $PAGE->set_context(context_user::instance($user1->id));
 131 if (!empty($user1->id) && $user1->id != $USER->id) {
 132     $PAGE->navigation->extend_for_user($user1);
 133 }
 134 if (!empty($user2->id) && $user2realuser && ($user2->id != $USER->id)) {
 135     $PAGE->navigation->extend_for_user($user2);
 136 }
 137
 138 /// Process any contact maintenance requests there may be
 139 if ($addcontact and confirm_sesskey()) {
 140     message_add_contact($addcontact);
 141     redirect($CFG->wwwroot . '/message/index.php?viewing=contacts&id='.$addcontact);
 142 }
 143 if ($removecontact and confirm_sesskey()) {
 144     message_remove_contact($removecontact);
 145 }
 146 if ($blockcontact and confirm_sesskey()) {
 147     message_block_contact($blockcontact);
 148 }
 149 if ($unblockcontact and confirm_sesskey()) {
 150     message_unblock_contact($unblockcontact);
 151 }
 152
 153 //was a message sent? Do NOT allow someone looking at someone else's messages to send them.
 154 $messageerror = null;
 155 if ($currentuser && !empty($user2) && has_capability('moodle/site:sendmessage', $systemcontext)) {
 156     // Check that the user is not blocking us!!
 157     if ($contact = $DB->get_record('message_contacts', array('userid' => $user2->id, 'contactid' => $user1->id))) {
 158         if ($contact->blocked and !has_capability('moodle/site:readallmessages', $systemcontext)) {
 159             $messageerror = get_string('userisblockingyou', 'message');
 160         }
 161     }
 162     $userpreferences = get_user_preferences(NULL, NULL, $user2->id);
 163
 164     if (!empty($userpreferences['message_blocknoncontacts'])) {  // User is blocking non-contacts
 165         if (empty($contact)) {   // We are not a contact!
 166             $messageerror = get_string('userisblockingyounoncontact', 'message', fullname($user2));
 167         }
 168     }
 169
 170     if (empty($messageerror)) {
 171         $mform = new send_form();
 172         $defaultmessage = new stdClass;
 173         $defaultmessage->id = $user2->id;
 174         $defaultmessage->viewing = $viewing;
 175         $defaultmessage->message = '';
 176
 177         //Check if the current user has sent a message
 178         $data = $mform->get_data();
 179         if (!empty($data) && !empty($data->message)) {
 180             if (!confirm_sesskey()) {
 181                 print_error('invalidsesskey');
 182             }
 183             $messageid = message_post_message($user1, $user2, $data->message, FORMAT_MOODLE);
 184             if (!empty($messageid)) {
 185                 //including the id of the user sending the message in the logged URL so the URL works for admins
 186                 //note message ID may be misleading as the message may potentially get a different ID when moved from message to message_read
 187                 redirect($CFG->wwwroot . '/message/index.php?viewing='.$viewing.'&id='.$user2->id);
 188             }
 189         }
 190     }
 191 }
 192
 193 $strmessages = get_string('messages', 'message');
 194 if ($user2realuser) {
 195     $user2fullname = fullname($user2);
 196
 197     $PAGE->set_title("$strmessages: $user2fullname");
 198 } else {
 199     $PAGE->set_title("{$SITE->shortname}: $strmessages");
 200 }
 201 $PAGE->set_heading(fullname($user1));
 202
 203 // Remove the user node from the main navigation for this page.
 204 $usernode = $PAGE->navigation->find('users', null);
 205 $usernode->remove();
 206
 207 $settings = $PAGE->settingsnav->find('messages', null);
 208 // Add the user we are contacting to the breadcrumb.
 209 if (!empty($user2realuser)) {
 210     $usernode = $settings->add(fullname($user2), $url);
 211     $usernode->make_active();
 212 } else {
 213     $settings->make_active();
 214 }
 215
 216 //now the page contents
 217 echo $OUTPUT->header();
 218
 219 echo $OUTPUT->box_start('message');
 220
 221 $countunread = 0; //count of unread messages from $user2
 222 $countunreadtotal = 0; //count of unread messages from all users
 223
 224 //we're dealing with unread messages early so the contact list will accurately reflect what is read/unread
 225 $viewingnewmessages = false;
 226 if (!empty($user2)) {
 227     //are there any unread messages from $user2
 228     $countunread = message_count_unread_messages($user1, $user2);
 229     if ($countunread>0) {
 230         //mark the messages we're going to display as read
 231         message_mark_messages_read($user1->id, $user2->id);
 232          if($viewing == MESSAGE_VIEW_UNREAD_MESSAGES) {
 233              $viewingnewmessages = true;
 234          }
 235     }
 236 }
 237 $countunreadtotal = message_count_unread_messages($user1);
 238
 239 if ($currentuser && $countunreadtotal == 0 && $viewing == MESSAGE_VIEW_UNREAD_MESSAGES && empty($user2)) {
 240     // If the user has no unread messages, show the search box.
 241     // We don't do this when a user is viewing another user's messages as search doesn't
 242     // handle user A searching user B's messages properly.
 243     $viewing = MESSAGE_VIEW_SEARCH;
 244 }
 245
 246 $blockedusers = message_get_blocked_users($user1, $user2);
 247 $countblocked = count($blockedusers);
 248
 249 list($onlinecontacts, $offlinecontacts, $strangers) = message_get_contacts($user1, $user2);
 250
 251 message_print_contact_selector($countunreadtotal, $viewing, $user1, $user2, $blockedusers, $onlinecontacts, $offlinecontacts, $strangers, $showactionlinks, $page);
 252
 253 echo html_writer::start_tag('div', array('class' => 'messagearea mdl-align'));
 254     if (!empty($user2)) {
 255
 256         echo html_writer::start_tag('div', array('class' => 'mdl-left messagehistory'));
 257
 258             $visible = 'visible';
 259             $hidden = 'hiddenelement'; //cant just use hidden as mform adds that class to its fieldset for something else
 260
 261             $recentlinkclass = $recentlabelclass = $historylinkclass = $historylabelclass = $visible;
 262             if ($history == MESSAGE_HISTORY_ALL) {
 263                 $displaycount = 0;
 264
 265                 $recentlabelclass = $historylinkclass = $hidden;
 266             } else if($viewingnewmessages) {
 267                 //if user is viewing new messages only show them the new messages
 268                 $displaycount = $countunread;
 269
 270                 $recentlabelclass = $historylabelclass = $hidden;
 271             } else {
 272                 //default to only showing the last few messages
 273                 $displaycount = MESSAGE_SHORTVIEW_LIMIT;
 274
 275                 if ($countunread>MESSAGE_SHORTVIEW_LIMIT) {
 276                     $displaycount = $countunread;
 277                 }
 278
 279                 $recentlinkclass = $historylabelclass = $hidden;
 280             }
 281
 282             $messagehistorylink =  html_writer::start_tag('div', array('class' => 'mdl-align messagehistorytype'));
 283                 $messagehistorylink .= html_writer::link($PAGE->url->out(false).'&history='.MESSAGE_HISTORY_ALL,
 284                     get_string('messagehistoryfull','message'),
 285                     array('class' => $historylinkclass));
 286
 287                 $messagehistorylink .=  html_writer::start_tag('span', array('class' => $historylabelclass));
 288                     $messagehistorylink .= get_string('messagehistoryfull','message');
 289                 $messagehistorylink .= html_writer::end_tag('span');
 290
 291                 $messagehistorylink .= '&nbsp;|&nbsp;'.html_writer::link($PAGE->url->out(false).'&history='.MESSAGE_HISTORY_SHORT,
 292                     get_string('mostrecent','message'),
 293                     array('class' => $recentlinkclass));
 294
 295                 $messagehistorylink .=  html_writer::start_tag('span', array('class' => $recentlabelclass));
 296                     $messagehistorylink .= get_string('mostrecent','message');
 297                 $messagehistorylink .= html_writer::end_tag('span');
 298
 299                 if ($viewingnewmessages) {
 300                     $messagehistorylink .=  '&nbsp;|&nbsp;'.html_writer::start_tag('span');//, array('class' => $historyclass)
 301                         $messagehistorylink .= get_string('unreadnewmessages','message',$displaycount);
 302                     $messagehistorylink .= html_writer::end_tag('span');
 303                 }
 304
 305             $messagehistorylink .= html_writer::end_tag('div');
 306
 307             message_print_message_history($user1, $user2, $search, $displaycount, $messagehistorylink, $viewingnewmessages, $showactionlinks);
 308         echo html_writer::end_tag('div');
 309
 310         //send message form
 311         if ($currentuser && has_capability('moodle/site:sendmessage', $systemcontext) && $user2realuser) {
 312             echo html_writer::start_tag('div', array('class' => 'mdl-align messagesend'));
 313                 if (!empty($messageerror)) {
 314                     echo html_writer::tag('span', $messageerror, array('id' => 'messagewarning'));
 315                 } else {
 316                     // Display a warning if the current user is blocking non-contacts and is about to message to a non-contact
 317                     // Otherwise they may wonder why they never get a reply
 318                     $blocknoncontacts = get_user_preferences('message_blocknoncontacts', '', $user1->id);
 319                     if (!empty($blocknoncontacts)) {
 320                         $contact = $DB->get_record('message_contacts', array('userid' => $user1->id, 'contactid' => $user2->id));
 321                         if (empty($contact)) {
 322                             $msg = get_string('messagingblockednoncontact', 'message', fullname($user2));
 323                             echo html_writer::tag('span', $msg, array('id' => 'messagewarning'));
 324                         }
 325                     }
 326
 327                     $mform = new send_form();
 328                     $defaultmessage = new stdClass;
 329                     $defaultmessage->id = $user2->id;
 330                     $defaultmessage->viewing = $viewing;
 331                     $defaultmessage->message = '';
 332                     //$defaultmessage->messageformat = FORMAT_MOODLE;
 333                     $mform->set_data($defaultmessage);
 334                     $mform->display();
 335                 }
 336             echo html_writer::end_tag('div');
 337         }
 338     } else if ($viewing == MESSAGE_VIEW_SEARCH) {
 339         message_print_search($advancedsearch, $user1);
 340     } else if ($viewing == MESSAGE_VIEW_RECENT_CONVERSATIONS) {
 341         message_print_recent_conversations($user1, false, $showactionlinks);
 342     } else if ($viewing == MESSAGE_VIEW_RECENT_NOTIFICATIONS) {
 343         message_print_recent_notifications($user1);
 344     }
 345 echo html_writer::end_tag('div');
 346
 347 echo $OUTPUT->box_end();
 348
 349 echo $OUTPUT->footer();
 350
 351