43e52934818c826c824b84a3b47bd77d5d1a54cf
[moodle.git] / 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/>.
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  */
25 require_once('../config.php');
26 require_once('lib.php');
27 require_once('send_form.php');
29 require_login(0, false);
31 if (isguestuser()) {
32     redirect($CFG->wwwroot);
33 }
35 if (empty($CFG->messaging)) {
36     print_error('disabled', 'message');
37 }
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);
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
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);
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);
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
61 //for search
62 $advancedsearch = optional_param('advanced', 0, PARAM_INT);
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);
67 $url = new moodle_url('/message/index.php', array('user1' => $user1id));
69 if ($user2id !== 0) {
70     $url->param('user2', $user2id);
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 }
80 if ($viewing != MESSAGE_VIEW_UNREAD_MESSAGES) {
81     $url->param('viewing', $viewing);
82 }
84 $PAGE->set_url($url);
86 $navigationurl = new moodle_url('/message/index.php', array('user1' => $user1id));
87 navigation_node::override_active_url($navigationurl);
89 // Disable message notification popups while the user is viewing their messages
90 $PAGE->set_popup_notification_allowed(false);
92 $user1 = null;
93 $currentuser = true;
94 $showactionlinks = true;
95 if ($user1id != $USER->id) {
96     $user1 = $DB->get_record('user', array('id' => $user1id));
97     if (!$user1) {
98         print_error('invaliduserid');
99     }
100     $currentuser = false;//if we're looking at someone else's messages we need to lock/remove some UI elements
101     $showactionlinks = false;
102 } else {
103     $user1 = $USER;
105 unset($user1id);
107 $user2 = null;
108 if (!empty($user2id)) {
109     $user2 = $DB->get_record("user", array("id" => $user2id));
110     if (!$user2) {
111         print_error('invaliduserid');
112     }
114 unset($user2id);
116 $systemcontext = context_system::instance();
118 if (!empty($user2) && $user1->id == $user2->id) {
119     print_error('invaliduserid');
122 // Is the user involved in the conversation?
123 // Do they have the ability to read other user's conversations?
124 if (!message_current_user_is_involved($user1, $user2) && !has_capability('moodle/site:readallmessages', $systemcontext)) {
125     print_error('accessdenied','admin');
128 $PAGE->set_context(context_user::instance($user1->id));
129 $PAGE->set_pagelayout('course');
130 $PAGE->navigation->extend_for_user($user1);
132 /// Process any contact maintenance requests there may be
133 if ($addcontact and confirm_sesskey()) {
134     add_to_log(SITEID, 'message', 'add contact', 'index.php?user1='.$addcontact.'&amp;user2='.$USER->id, $addcontact);
135     message_add_contact($addcontact);
136     redirect($CFG->wwwroot . '/message/index.php?viewing=contacts&id='.$addcontact);
138 if ($removecontact and confirm_sesskey()) {
139     add_to_log(SITEID, 'message', 'remove contact', 'index.php?user1='.$removecontact.'&amp;user2='.$USER->id, $removecontact);
140     message_remove_contact($removecontact);
142 if ($blockcontact and confirm_sesskey()) {
143     add_to_log(SITEID, 'message', 'block contact', 'index.php?user1='.$blockcontact.'&amp;user2='.$USER->id, $blockcontact);
144     message_block_contact($blockcontact);
146 if ($unblockcontact and confirm_sesskey()) {
147     add_to_log(SITEID, 'message', 'unblock contact', 'index.php?user1='.$unblockcontact.'&amp;user2='.$USER->id, $unblockcontact);
148     message_unblock_contact($unblockcontact);
151 //was a message sent? Do NOT allow someone looking at someone else's messages to send them.
152 $messageerror = null;
153 if ($currentuser && !empty($user2) && has_capability('moodle/site:sendmessage', $systemcontext)) {
154     // Check that the user is not blocking us!!
155     if ($contact = $DB->get_record('message_contacts', array('userid' => $user2->id, 'contactid' => $user1->id))) {
156         if ($contact->blocked and !has_capability('moodle/site:readallmessages', $systemcontext)) {
157             $messageerror = get_string('userisblockingyou', 'message');
158         }
159     }
160     $userpreferences = get_user_preferences(NULL, NULL, $user2->id);
162     if (!empty($userpreferences['message_blocknoncontacts'])) {  // User is blocking non-contacts
163         if (empty($contact)) {   // We are not a contact!
164             $messageerror = get_string('userisblockingyounoncontact', 'message', fullname($user2));
165         }
166     }
168     if (empty($messageerror)) {
169         $mform = new send_form();
170         $defaultmessage = new stdClass;
171         $defaultmessage->id = $user2->id;
172         $defaultmessage->message = '';
174         //Check if the current user has sent a message
175         $data = $mform->get_data();
176         if (!empty($data) && !empty($data->message)) {
177             if (!confirm_sesskey()) {
178                 print_error('invalidsesskey');
179             }
180             $messageid = message_post_message($user1, $user2, $data->message, FORMAT_MOODLE);
181             if (!empty($messageid)) {
182                 //including the id of the user sending the message in the logged URL so the URL works for admins
183                 //note message ID may be misleading as the message may potentially get a different ID when moved from message to message_read
184                 add_to_log(SITEID, 'message', 'write', 'index.php?user='.$user1->id.'&id='.$user2->id.'&history=1#m'.$messageid, $user1->id);
185                 redirect($CFG->wwwroot . '/message/index.php?viewing='.$viewing.'&id='.$user2->id);
186             }
187         }
188     }
191 $strmessages = get_string('messages', 'message');
192 if (!empty($user2)) {
193     $user2fullname = fullname($user2);
195     $PAGE->set_title("$strmessages: $user2fullname");
196     $PAGE->set_heading("$strmessages: $user2fullname");
197 } else {
198     $PAGE->set_title("{$SITE->shortname}: $strmessages");
199     $PAGE->set_heading("{$SITE->shortname}: $strmessages");
202 //now the page contents
203 echo $OUTPUT->header();
205 echo $OUTPUT->box_start('message');
207 $countunread = 0; //count of unread messages from $user2
208 $countunreadtotal = 0; //count of unread messages from all users
210 //we're dealing with unread messages early so the contact list will accurately reflect what is read/unread
211 $viewingnewmessages = false;
212 if (!empty($user2)) {
213     //are there any unread messages from $user2
214     $countunread = message_count_unread_messages($user1, $user2);
215     if ($countunread>0) {
216         //mark the messages we're going to display as read
217         message_mark_messages_read($user1->id, $user2->id);
218          if($viewing == MESSAGE_VIEW_UNREAD_MESSAGES) {
219              $viewingnewmessages = true;
220          }
221     }
223 $countunreadtotal = message_count_unread_messages($user1);
225 if ($currentuser && $countunreadtotal == 0 && $viewing == MESSAGE_VIEW_UNREAD_MESSAGES && empty($user2)) {
226     // If the user has no unread messages, show the search box.
227     // We don't do this when a user is viewing another user's messages as search doesn't
228     // handle user A searching user B's messages properly.
229     $viewing = MESSAGE_VIEW_SEARCH;
232 $blockedusers = message_get_blocked_users($user1, $user2);
233 $countblocked = count($blockedusers);
235 list($onlinecontacts, $offlinecontacts, $strangers) = message_get_contacts($user1, $user2);
237 message_print_contact_selector($countunreadtotal, $viewing, $user1, $user2, $blockedusers, $onlinecontacts, $offlinecontacts, $strangers, $showactionlinks, $page);
239 echo html_writer::start_tag('div', array('class' => 'messagearea mdl-align'));
240     if (!empty($user2)) {
242         echo html_writer::start_tag('div', array('class' => 'mdl-left messagehistory'));
244             $visible = 'visible';
245             $hidden = 'hiddenelement'; //cant just use hidden as mform adds that class to its fieldset for something else
247             $recentlinkclass = $recentlabelclass = $historylinkclass = $historylabelclass = $visible;
248             if ($history == MESSAGE_HISTORY_ALL) {
249                 $displaycount = 0;
251                 $recentlabelclass = $historylinkclass = $hidden;
252             } else if($viewingnewmessages) {
253                 //if user is viewing new messages only show them the new messages
254                 $displaycount = $countunread;
256                 $recentlabelclass = $historylabelclass = $hidden;
257             } else {
258                 //default to only showing the last few messages
259                 $displaycount = MESSAGE_SHORTVIEW_LIMIT;
261                 if ($countunread>MESSAGE_SHORTVIEW_LIMIT) {
262                     $displaycount = $countunread;
263                 }
265                 $recentlinkclass = $historylabelclass = $hidden;
266             }
268             $messagehistorylink =  html_writer::start_tag('div', array('class' => 'mdl-align messagehistorytype'));
269                 $messagehistorylink .= html_writer::link($PAGE->url->out(false).'&history='.MESSAGE_HISTORY_ALL,
270                     get_string('messagehistoryfull','message'),
271                     array('class' => $historylinkclass));
273                 $messagehistorylink .=  html_writer::start_tag('span', array('class' => $historylabelclass));
274                     $messagehistorylink .= get_string('messagehistoryfull','message');
275                 $messagehistorylink .= html_writer::end_tag('span');
277                 $messagehistorylink .= '&nbsp;|&nbsp;'.html_writer::link($PAGE->url->out(false).'&history='.MESSAGE_HISTORY_SHORT,
278                     get_string('mostrecent','message'),
279                     array('class' => $recentlinkclass));
281                 $messagehistorylink .=  html_writer::start_tag('span', array('class' => $recentlabelclass));
282                     $messagehistorylink .= get_string('mostrecent','message');
283                 $messagehistorylink .= html_writer::end_tag('span');
285                 if ($viewingnewmessages) {
286                     $messagehistorylink .=  '&nbsp;|&nbsp;'.html_writer::start_tag('span');//, array('class' => $historyclass)
287                         $messagehistorylink .= get_string('unreadnewmessages','message',$displaycount);
288                     $messagehistorylink .= html_writer::end_tag('span');
289                 }
291             $messagehistorylink .= html_writer::end_tag('div');
293             message_print_message_history($user1, $user2, $search, $displaycount, $messagehistorylink, $viewingnewmessages, $showactionlinks);
294         echo html_writer::end_tag('div');
296         //send message form
297         if ($currentuser && has_capability('moodle/site:sendmessage', $systemcontext)) {
298             echo html_writer::start_tag('div', array('class' => 'mdl-align messagesend'));
299                 if (!empty($messageerror)) {
300                     echo html_writer::tag('span', $messageerror, array('id' => 'messagewarning'));
301                 } else {
302                     // Display a warning if the current user is blocking non-contacts and is about to message to a non-contact
303                     // Otherwise they may wonder why they never get a reply
304                     $blocknoncontacts = get_user_preferences('message_blocknoncontacts', '', $user1->id);
305                     if (!empty($blocknoncontacts)) {
306                         $contact = $DB->get_record('message_contacts', array('userid' => $user1->id, 'contactid' => $user2->id));
307                         if (empty($contact)) {
308                             $msg = get_string('messagingblockednoncontact', 'message', fullname($user2));
309                             echo html_writer::tag('span', $msg, array('id' => 'messagewarning'));
310                         }
311                     }
313                     $mform = new send_form();
314                     $defaultmessage = new stdClass;
315                     $defaultmessage->id = $user2->id;
316                     $defaultmessage->message = '';
317                     //$defaultmessage->messageformat = FORMAT_MOODLE;
318                     $mform->set_data($defaultmessage);
319                     $mform->display();
320                 }
321             echo html_writer::end_tag('div');
322         }
323     } else if ($viewing == MESSAGE_VIEW_SEARCH) {
324         message_print_search($advancedsearch, $user1);
325     } else if ($viewing == MESSAGE_VIEW_RECENT_CONVERSATIONS) {
326         message_print_recent_conversations($user1, false, $showactionlinks);
327     } else if ($viewing == MESSAGE_VIEW_RECENT_NOTIFICATIONS) {
328         message_print_recent_notifications($user1);
329     }
330 echo html_writer::end_tag('div');
332 echo $OUTPUT->box_end();
334 echo $OUTPUT->footer();