message MDL-25616 adding recent conversations and recent notifications screens
[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 $user1id   = optional_param('user', $USER->id, PARAM_INT);
48 $user2id   = optional_param('id', 0, PARAM_INT);
50 $addcontact     = optional_param('addcontact',     0, PARAM_INT); // adding a contact
51 $removecontact  = optional_param('removecontact',  0, PARAM_INT); // removing a contact
52 $blockcontact   = optional_param('blockcontact',   0, PARAM_INT); // blocking a contact
53 $unblockcontact = optional_param('unblockcontact', 0, PARAM_INT); // unblocking a contact
55 //for search
56 $advancedsearch = optional_param('advanced', 0, PARAM_INT);
58 //if they have numerous contacts or are viewing course participants we might need to page through them
59 $page = optional_param('page', 0, PARAM_INT);
61 $url = new moodle_url('/message/index.php');
63 if ($user2id !== 0) {
64     $url->param('id', $user2id);
65 }
67 if ($user2id !== 0) {
68     //Switch view back to contacts if:
69     //1) theyve searched and selected a user
70     //2) they've viewed recent messages or notifications and clicked through to a user
71     if ($viewing == VIEW_SEARCH || $viewing == VIEW_SEARCH || $viewing == VIEW_RECENT_NOTIFICATIONS) {
72         $viewing = VIEW_CONTACTS;
73     }
74 }
75 $url->param('viewing', $viewing);
77 $PAGE->set_url($url);
79 $PAGE->set_context(get_context_instance(CONTEXT_USER, $USER->id));
80 $PAGE->navigation->extend_for_user($USER);
81 $PAGE->set_pagelayout('course');
83 $context = get_context_instance(CONTEXT_SYSTEM);
85 $user1 = null;
86 $currentuser = true;
87 $showcontactactionlinks = SHOW_ACTION_LINKS_IN_CONTACT_LIST;
88 if ($user1id != $USER->id) {
89     $user1 = $DB->get_record('user', array('id' => $user1id));
90     if (!$user1) {
91         print_error('invaliduserid');
92     }
93     $currentuser = false;//if we're looking at someone else's messages we need to lock/remove some UI elements
94     $showcontactactionlinks = false;
95 } else {
96     $user1 = $USER;
97 }
98 unset($user1id);
100 $user2 = null;
101 if (!empty($user2id)) {
102     $user2 = $DB->get_record("user", array("id" => $user2id));
103     if (!$user2) {
104         print_error('invaliduserid');
105     }
107 unset($user2id);
109 //the current user isnt involved in this discussion at all
110 if ($user1->id != $USER->id && (!empty($user2) && $user2->id != $USER->id) && !has_capability('moodle/site:readallmessages', $context)) {
111     print_error('accessdenied','admin');
114 /// Process any contact maintenance requests there may be
115 if ($addcontact and confirm_sesskey()) {
116     add_to_log(SITEID, 'message', 'add contact', 'index.php?user1='.$addcontact.'&amp;user2='.$USER->id, $addcontact);
117     message_add_contact($addcontact);
118     redirect($CFG->wwwroot . '/message/index.php?'.VIEW_PARAM.'=contacts&id='.$addcontact);
120 if ($removecontact and confirm_sesskey()) {
121     add_to_log(SITEID, 'message', 'remove contact', 'index.php?user1='.$removecontact.'&amp;user2='.$USER->id, $removecontact);
122     message_remove_contact($removecontact);
124 if ($blockcontact and confirm_sesskey()) {
125     add_to_log(SITEID, 'message', 'block contact', 'index.php?user1='.$blockcontact.'&amp;user2='.$USER->id, $blockcontact);
126     message_block_contact($blockcontact);
128 if ($unblockcontact and confirm_sesskey()) {
129     add_to_log(SITEID, 'message', 'unblock contact', 'index.php?user1='.$unblockcontact.'&amp;user2='.$USER->id, $unblockcontact);
130     message_unblock_contact($unblockcontact);
133 //was a message sent? Do NOT allow someone looking at someone else's messages to send them.
134 $messageerror = null;
135 if ($currentuser && !empty($user2) && has_capability('moodle/site:sendmessage', $context)) {
137     // Check that the user is not blocking us!!
138     if ($contact = $DB->get_record('message_contacts', array('userid' => $user2->id, 'contactid' => $user1->id))) {
139         if ($contact->blocked and !has_capability('moodle/site:readallmessages', $context)) {
140             $messageerror = get_string('userisblockingyou', 'message');
141         }
142     }
143     $userpreferences = get_user_preferences(NULL, NULL, $user2->id);
145     if (!empty($userpreferences['message_blocknoncontacts'])) {  // User is blocking non-contacts
146         if (empty($contact)) {   // We are not a contact!
147             $messageerror = get_string('userisblockingyounoncontact', 'message');
148         }
149     }
151     if (empty($messageerror)) {
152         $mform = new send_form();
153         $defaultmessage = new stdClass;
154         $defaultmessage->id = $user2->id;
155         $defaultmessage->message = '';
157         //Check if the current user has sent a message
158         $data = $mform->get_data();
159         if (!empty($data) && !empty($data->message)) {
160             if (!confirm_sesskey()) {
161                 print_error('invalidsesskey');
162             }
164             $messageid = message_post_message($user1, $user2, $data->message, FORMAT_MOODLE);
165             if (!empty($messageid)) {
166                 redirect($CFG->wwwroot . '/message/index.php?'.VIEW_PARAM.'='.$viewing.'&id='.$user2->id);
167             }
168         }
169     }
172 $strmessages = get_string('messages', 'message');
173 if (!empty($user2)) {
174     $user2fullname = fullname($user2);
176     $PAGE->set_title("$strmessages: $user2fullname");
177     $PAGE->set_heading("$strmessages: $user2fullname");
178 } else {
179     $PAGE->set_title("{$SITE->shortname}: $strmessages");
180     $PAGE->set_heading("{$SITE->shortname}: $strmessages");
183 //now the page contents
184 echo $OUTPUT->header();
186 echo $OUTPUT->box_start('message');
188 $countunread = 0; //count of unread messages from $user2
189 $countunreadtotal = 0; //count of unread messages from all users
191 //we're dealing with unread messages early so the contact list will accurately reflect what is read/unread
192 $viewingnewmessages = false;
193 if (!empty($user2)) {
194     //are there any unread messages from $user2
195     $countunread = message_count_unread_messages($user1, $user2);
196     if ($countunread>0) {
197         //mark the messages we're going to display as read
198         message_mark_messages_read($user1->id, $user2->id);
199          if($viewing == VIEW_UNREAD_MESSAGES) {
200              $viewingnewmessages = true;
201          }
202     }
204 $countunreadtotal = message_count_unread_messages($user1);
206 if ($countunreadtotal == 0 && $viewing == VIEW_UNREAD_MESSAGES && empty($user2)) {
207     //default to showing the search
208     $viewing = VIEW_SEARCH;
211 $blockedusers = message_get_blocked_users($user1, $user2);
212 $countblocked = count($blockedusers);
214 list($onlinecontacts, $offlinecontacts, $strangers) = message_get_contacts($user1, $user2);
216 message_print_contact_selector($countunreadtotal, $viewing, $user1, $user2, $blockedusers, $onlinecontacts, $offlinecontacts, $strangers, $showcontactactionlinks, $page);
218 echo html_writer::start_tag('div', array('class' => 'messagearea mdl-align'));
219     if (!empty($user2)) {
221         echo html_writer::start_tag('div', array('class' => 'mdl-left messagehistory'));
223             $visible = 'visible';
224             $hidden = 'hiddenelement'; //cant just use hidden as mform adds that class to its fieldset for something else
226             $recentlinkclass = $recentlabelclass = $historylinkclass = $historylabelclass = $visible;
227             if ($history == MESSAGE_HISTORY_ALL) {
228                 $displaycount = 0;
230                 $recentlabelclass = $historylinkclass = $hidden;
231             } else if($viewingnewmessages) {
232                 //if user is viewing new messages only show them the new messages
233                 $displaycount = $countunread;
235                 $recentlabelclass = $historylabelclass = $hidden;
236             } else {
237                 //default to only showing the last few messages
238                 $displaycount = MESSAGE_SHORTVIEW_LIMIT;
240                 if ($countunread>MESSAGE_SHORTVIEW_LIMIT) {
241                     $displaycount = $countunread;
242                 }
244                 $recentlinkclass = $historylabelclass = $hidden;
245             }
247             $messagehistorylink =  html_writer::start_tag('div', array('class' => 'mdl-align messagehistorytype'));
248                 $messagehistorylink .= html_writer::link($PAGE->url->out(false).'&history='.MESSAGE_HISTORY_ALL,
249                     get_string('messagehistoryfull','message'),
250                     array('class' => $historylinkclass));
252                 $messagehistorylink .=  html_writer::start_tag('span', array('class' => $historylabelclass));
253                     $messagehistorylink .= get_string('messagehistoryfull','message');
254                 $messagehistorylink .= html_writer::end_tag('span');
256                 $messagehistorylink .= '&nbsp;|&nbsp;'.html_writer::link($PAGE->url->out(false).'&history='.MESSAGE_HISTORY_SHORT,
257                     get_string('mostrecent','message'),
258                     array('class' => $recentlinkclass));
260                 $messagehistorylink .=  html_writer::start_tag('span', array('class' => $recentlabelclass));
261                     $messagehistorylink .= get_string('mostrecent','message');
262                 $messagehistorylink .= html_writer::end_tag('span');
264                 if ($viewingnewmessages) {
265                     $messagehistorylink .=  '&nbsp;|&nbsp;'.html_writer::start_tag('span');//, array('class' => $historyclass)
266                         $messagehistorylink .= get_string('unreadnewmessages','message',$displaycount);
267                     $messagehistorylink .= html_writer::end_tag('span');
268                 }
270             $messagehistorylink .= html_writer::end_tag('div');
272             message_print_message_history($user1, $user2, $search, $displaycount, $messagehistorylink, $viewingnewmessages);
273         echo html_writer::end_tag('div');
275         //send message form
276         if ($currentuser && has_capability('moodle/site:sendmessage', $context)) {
277             echo html_writer::start_tag('div', array('class' => 'mdl-align messagesend'));
278                 if (!empty($messageerror)) {
279                     echo $OUTPUT->heading($messageerror, 3);
280                 } else {
281                     $mform = new send_form();
282                     $defaultmessage = new stdClass;
283                     $defaultmessage->id = $user2->id;
284                     $defaultmessage->message = '';
285                     //$defaultmessage->messageformat = FORMAT_MOODLE;
286                     $mform->set_data($defaultmessage);
287                     $mform->display();
288                 }
289             echo html_writer::end_tag('div');
290         }
291     } else if ($viewing == VIEW_SEARCH) {
292         message_print_search($advancedsearch, $user1);
293     } else if ($viewing == VIEW_RECENT_CONVERSATIONS) {
294         message_print_recent_conversations($user1);
295     } else if ($viewing == VIEW_RECENT_NOTIFICATIONS) {
296         message_print_recent_notifications($user1);
297     }
298 echo html_writer::end_tag('div');
300 echo $OUTPUT->box_end();
302 echo $OUTPUT->footer();