Merge branch 'MDL-25616_recent_messages' of git://github.com/andyjdavis/moodle
[moodle.git] / message / index.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * A page displaying the user's contacts and messages
20  *
21  * @package   moodlecore
22  * @copyright 2010 Andrew Davis
23  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 require_once('../config.php');
27 require_once('lib.php');
28 require_once('send_form.php');
30 require_login(0, false);
32 if (isguestuser()) {
33     redirect($CFG->wwwroot);
34 }
36 if (empty($CFG->messaging)) {
37     print_error('disabled', 'message');
38 }
40 //VIEW_PARAM is the preferred URL parameter but we'll still accept usergroup in case its referenced externally
41 $usergroup = optional_param('usergroup', VIEW_UNREAD_MESSAGES, PARAM_ALPHANUMEXT);
42 $viewing = optional_param(VIEW_PARAM, $usergroup, PARAM_ALPHANUMEXT);
44 $history   = optional_param('history', MESSAGE_HISTORY_SHORT, PARAM_INT);
45 $search    = optional_param('search', '', PARAM_CLEAN); //TODO: use PARAM_RAW, but make sure we use s() and p() properly
47 //the same param as 1.9 and the param we have been logging. Use this parameter.
48 $user1id   = optional_param(MESSAGE_USER1_PARAM, $USER->id, PARAM_INT);
49 //2.0 shipped using this param. Retaining it only for compatibility. It should be removed.
50 $user1id   = optional_param('user', $user1id, PARAM_INT);
52 //the same param as 1.9 and the param we have been logging. Use this parameter.
53 $user2id   = optional_param(MESSAGE_USER2_PARAM, 0, PARAM_INT);
54 //2.0 shipped using this param. Retaining it only for compatibility. It should be removed.
55 $user2id   = optional_param('id', $user2id, PARAM_INT);
57 $addcontact     = optional_param('addcontact',     0, PARAM_INT); // adding a contact
58 $removecontact  = optional_param('removecontact',  0, PARAM_INT); // removing a contact
59 $blockcontact   = optional_param('blockcontact',   0, PARAM_INT); // blocking a contact
60 $unblockcontact = optional_param('unblockcontact', 0, PARAM_INT); // unblocking a contact
62 //for search
63 $advancedsearch = optional_param('advanced', 0, PARAM_INT);
65 //if they have numerous contacts or are viewing course participants we might need to page through them
66 $page = optional_param('page', 0, PARAM_INT);
68 $url = new moodle_url('/message/index.php');
70 if ($user2id !== 0) {
71     $url->param('id', $user2id);
72 }
74 if ($user2id !== 0) {
75     //Switch view back to contacts if:
76     //1) theyve searched and selected a user
77     //2) they've viewed recent messages or notifications and clicked through to a user
78     if ($viewing == VIEW_SEARCH || $viewing == VIEW_SEARCH || $viewing == VIEW_RECENT_NOTIFICATIONS) {
79         $viewing = VIEW_CONTACTS;
80     }
81 }
82 $url->param('viewing', $viewing);
84 $PAGE->set_url($url);
86 $PAGE->set_context(get_context_instance(CONTEXT_USER, $USER->id));
87 $PAGE->navigation->extend_for_user($USER);
88 $PAGE->set_pagelayout('course');
90 $context = get_context_instance(CONTEXT_SYSTEM);
92 $user1 = null;
93 $currentuser = true;
94 $showcontactactionlinks = SHOW_ACTION_LINKS_IN_CONTACT_LIST;
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     $showcontactactionlinks = 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 //the current user isnt involved in this discussion at all
117 if ($user1->id != $USER->id && (!empty($user2) && $user2->id != $USER->id) && !has_capability('moodle/site:readallmessages', $context)) {
118     print_error('accessdenied','admin');
121 /// Process any contact maintenance requests there may be
122 if ($addcontact and confirm_sesskey()) {
123     add_to_log(SITEID, 'message', 'add contact', 'index.php?user1='.$addcontact.'&amp;user2='.$USER->id, $addcontact);
124     message_add_contact($addcontact);
125     redirect($CFG->wwwroot . '/message/index.php?'.VIEW_PARAM.'=contacts&id='.$addcontact);
127 if ($removecontact and confirm_sesskey()) {
128     add_to_log(SITEID, 'message', 'remove contact', 'index.php?user1='.$removecontact.'&amp;user2='.$USER->id, $removecontact);
129     message_remove_contact($removecontact);
131 if ($blockcontact and confirm_sesskey()) {
132     add_to_log(SITEID, 'message', 'block contact', 'index.php?user1='.$blockcontact.'&amp;user2='.$USER->id, $blockcontact);
133     message_block_contact($blockcontact);
135 if ($unblockcontact and confirm_sesskey()) {
136     add_to_log(SITEID, 'message', 'unblock contact', 'index.php?user1='.$unblockcontact.'&amp;user2='.$USER->id, $unblockcontact);
137     message_unblock_contact($unblockcontact);
140 //was a message sent? Do NOT allow someone looking at someone else's messages to send them.
141 $messageerror = null;
142 if ($currentuser && !empty($user2) && has_capability('moodle/site:sendmessage', $context)) {
144     // Check that the user is not blocking us!!
145     if ($contact = $DB->get_record('message_contacts', array('userid' => $user2->id, 'contactid' => $user1->id))) {
146         if ($contact->blocked and !has_capability('moodle/site:readallmessages', $context)) {
147             $messageerror = get_string('userisblockingyou', 'message');
148         }
149     }
150     $userpreferences = get_user_preferences(NULL, NULL, $user2->id);
152     if (!empty($userpreferences['message_blocknoncontacts'])) {  // User is blocking non-contacts
153         if (empty($contact)) {   // We are not a contact!
154             $messageerror = get_string('userisblockingyounoncontact', 'message');
155         }
156     }
158     if (empty($messageerror)) {
159         $mform = new send_form();
160         $defaultmessage = new stdClass;
161         $defaultmessage->id = $user2->id;
162         $defaultmessage->message = '';
164         //Check if the current user has sent a message
165         $data = $mform->get_data();
166         if (!empty($data) && !empty($data->message)) {
167             if (!confirm_sesskey()) {
168                 print_error('invalidsesskey');
169             }
171             $messageid = message_post_message($user1, $user2, $data->message, FORMAT_MOODLE);
172             if (!empty($messageid)) {
173                 //including the id of the user sending the message in the logged URL so the URL works for admins
174                 //note message ID may be misleading as the message may potentially get a different ID when moved from message to message_read
175                 add_to_log(SITEID, 'message', 'write', 'index.php?user='.$user1->id.'&id='.$user2->id.'&history=1#m'.$messageid, $user1->id);
176                 redirect($CFG->wwwroot . '/message/index.php?'.VIEW_PARAM.'='.$viewing.'&id='.$user2->id);
177             }
178         }
179     }
182 $strmessages = get_string('messages', 'message');
183 if (!empty($user2)) {
184     $user2fullname = fullname($user2);
186     $PAGE->set_title("$strmessages: $user2fullname");
187     $PAGE->set_heading("$strmessages: $user2fullname");
188 } else {
189     $PAGE->set_title("{$SITE->shortname}: $strmessages");
190     $PAGE->set_heading("{$SITE->shortname}: $strmessages");
193 //now the page contents
194 echo $OUTPUT->header();
196 echo $OUTPUT->box_start('message');
198 $countunread = 0; //count of unread messages from $user2
199 $countunreadtotal = 0; //count of unread messages from all users
201 //we're dealing with unread messages early so the contact list will accurately reflect what is read/unread
202 $viewingnewmessages = false;
203 if (!empty($user2)) {
204     //are there any unread messages from $user2
205     $countunread = message_count_unread_messages($user1, $user2);
206     if ($countunread>0) {
207         //mark the messages we're going to display as read
208         message_mark_messages_read($user1->id, $user2->id);
209          if($viewing == VIEW_UNREAD_MESSAGES) {
210              $viewingnewmessages = true;
211          }
212     }
214 $countunreadtotal = message_count_unread_messages($user1);
216 if ($countunreadtotal == 0 && $viewing == VIEW_UNREAD_MESSAGES && empty($user2)) {
217     //default to showing the search
218     $viewing = VIEW_SEARCH;
221 $blockedusers = message_get_blocked_users($user1, $user2);
222 $countblocked = count($blockedusers);
224 list($onlinecontacts, $offlinecontacts, $strangers) = message_get_contacts($user1, $user2);
226 message_print_contact_selector($countunreadtotal, $viewing, $user1, $user2, $blockedusers, $onlinecontacts, $offlinecontacts, $strangers, $showcontactactionlinks, $page);
228 echo html_writer::start_tag('div', array('class' => 'messagearea mdl-align'));
229     if (!empty($user2)) {
231         echo html_writer::start_tag('div', array('class' => 'mdl-left messagehistory'));
233             $visible = 'visible';
234             $hidden = 'hiddenelement'; //cant just use hidden as mform adds that class to its fieldset for something else
236             $recentlinkclass = $recentlabelclass = $historylinkclass = $historylabelclass = $visible;
237             if ($history == MESSAGE_HISTORY_ALL) {
238                 $displaycount = 0;
240                 $recentlabelclass = $historylinkclass = $hidden;
241             } else if($viewingnewmessages) {
242                 //if user is viewing new messages only show them the new messages
243                 $displaycount = $countunread;
245                 $recentlabelclass = $historylabelclass = $hidden;
246             } else {
247                 //default to only showing the last few messages
248                 $displaycount = MESSAGE_SHORTVIEW_LIMIT;
250                 if ($countunread>MESSAGE_SHORTVIEW_LIMIT) {
251                     $displaycount = $countunread;
252                 }
254                 $recentlinkclass = $historylabelclass = $hidden;
255             }
257             $messagehistorylink =  html_writer::start_tag('div', array('class' => 'mdl-align messagehistorytype'));
258                 $messagehistorylink .= html_writer::link($PAGE->url->out(false).'&history='.MESSAGE_HISTORY_ALL,
259                     get_string('messagehistoryfull','message'),
260                     array('class' => $historylinkclass));
262                 $messagehistorylink .=  html_writer::start_tag('span', array('class' => $historylabelclass));
263                     $messagehistorylink .= get_string('messagehistoryfull','message');
264                 $messagehistorylink .= html_writer::end_tag('span');
266                 $messagehistorylink .= '&nbsp;|&nbsp;'.html_writer::link($PAGE->url->out(false).'&history='.MESSAGE_HISTORY_SHORT,
267                     get_string('mostrecent','message'),
268                     array('class' => $recentlinkclass));
270                 $messagehistorylink .=  html_writer::start_tag('span', array('class' => $recentlabelclass));
271                     $messagehistorylink .= get_string('mostrecent','message');
272                 $messagehistorylink .= html_writer::end_tag('span');
274                 if ($viewingnewmessages) {
275                     $messagehistorylink .=  '&nbsp;|&nbsp;'.html_writer::start_tag('span');//, array('class' => $historyclass)
276                         $messagehistorylink .= get_string('unreadnewmessages','message',$displaycount);
277                     $messagehistorylink .= html_writer::end_tag('span');
278                 }
280             $messagehistorylink .= html_writer::end_tag('div');
282             message_print_message_history($user1, $user2, $search, $displaycount, $messagehistorylink, $viewingnewmessages);
283         echo html_writer::end_tag('div');
285         //send message form
286         if ($currentuser && has_capability('moodle/site:sendmessage', $context)) {
287             echo html_writer::start_tag('div', array('class' => 'mdl-align messagesend'));
288                 if (!empty($messageerror)) {
289                     echo $OUTPUT->heading($messageerror, 3);
290                 } else {
291                     $mform = new send_form();
292                     $defaultmessage = new stdClass;
293                     $defaultmessage->id = $user2->id;
294                     $defaultmessage->message = '';
295                     //$defaultmessage->messageformat = FORMAT_MOODLE;
296                     $mform->set_data($defaultmessage);
297                     $mform->display();
298                 }
299             echo html_writer::end_tag('div');
300         }
301     } else if ($viewing == VIEW_SEARCH) {
302         message_print_search($advancedsearch, $user1);
303     } else if ($viewing == VIEW_RECENT_CONVERSATIONS) {
304         message_print_recent_conversations($user1);
305     } else if ($viewing == VIEW_RECENT_NOTIFICATIONS) {
306         message_print_recent_notifications($user1);
307     }
308 echo html_writer::end_tag('div');
310 echo $OUTPUT->box_end();
312 echo $OUTPUT->footer();