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