Merge branch 'MDL-25708' of git://github.com/stronk7/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 $usergroup = optional_param('usergroup', VIEW_UNREAD_MESSAGES, PARAM_ALPHANUMEXT);
41 $history   = optional_param('history', MESSAGE_HISTORY_SHORT, PARAM_INT);
42 $search    = optional_param('search', '', PARAM_CLEAN); //TODO: use PARAM_RAW, but make sure we use s() and p() properly
44 $user1id   = optional_param('user', $USER->id, PARAM_INT);
45 $user2id   = optional_param('id', 0, PARAM_INT);
47 $addcontact     = optional_param('addcontact',     0, PARAM_INT); // adding a contact
48 $removecontact  = optional_param('removecontact',  0, PARAM_INT); // removing a contact
49 $blockcontact   = optional_param('blockcontact',   0, PARAM_INT); // blocking a contact
50 $unblockcontact = optional_param('unblockcontact', 0, PARAM_INT); // unblocking a contact
52 //for search
53 $advancedsearch = optional_param('advanced', 0, PARAM_INT);
55 //if they have numerous contacts or are viewing course participants we might need to page through them
56 $page = optional_param('page', 0, PARAM_INT);
58 $url = new moodle_url('/message/index.php');
60 if ($user2id !== 0) {
61     $url->param('id', $user2id);
62 }
64 if ($usergroup !== 0) {
65     if ($user2id !== 0 && $usergroup==VIEW_SEARCH) {
66         //if theyve searched and selected a user change the view back to contacts so the search button is displayed
67         $usergroup = VIEW_CONTACTS;
68     }
69     $url->param('usergroup', $usergroup);
70 }
72 $PAGE->set_url($url);
74 $PAGE->set_context(get_context_instance(CONTEXT_USER, $USER->id));
75 $PAGE->navigation->extend_for_user($USER);
76 $PAGE->set_pagelayout('course');
78 $context = get_context_instance(CONTEXT_SYSTEM);
80 $user1 = null;
81 $currentuser = true;
82 $showcontactactionlinks = SHOW_ACTION_LINKS_IN_CONTACT_LIST;
83 if ($user1id!=$USER->id) {
84     $user1 = $DB->get_record('user', array('id'=>$user1id));
85     if (!$user1) {
86         print_error('invaliduserid');
87     }
88     $currentuser = false;//if we're looking at someone else's messages we need to lock/remove some UI elements
89     $showcontactactionlinks = false;
90 } else {
91     $user1 = $USER;
92 }
93 unset($user1id);
95 $user2 = null;
96 if (!empty($user2id)) {
97     $user2 = $DB->get_record("user", array("id"=>$user2id));
98     if (!$user2) {
99         print_error('invaliduserid');
100     }
102 unset($user2id);
104 //the current user isnt involved in this discussion at all
105 if ($user1->id!=$USER->id && $user2->id!=$USER->id && !has_capability('moodle/site:readallmessages', $context)) {
106     print_error('accessdenied','admin');
109 /// Process any contact maintenance requests there may be
110 if ($addcontact and confirm_sesskey()) {
111     add_to_log(SITEID, 'message', 'add contact', 'index.php?user1='.$addcontact.'&amp;user2='.$USER->id, $addcontact);
112     message_add_contact($addcontact);
113     redirect($CFG->wwwroot . '/message/index.php?usergroup=contacts&id='.$addcontact);
115 if ($removecontact and confirm_sesskey()) {
116     add_to_log(SITEID, 'message', 'remove contact', 'index.php?user1='.$removecontact.'&amp;user2='.$USER->id, $removecontact);
117     message_remove_contact($removecontact);
119 if ($blockcontact and confirm_sesskey()) {
120     add_to_log(SITEID, 'message', 'block contact', 'index.php?user1='.$blockcontact.'&amp;user2='.$USER->id, $blockcontact);
121     message_block_contact($blockcontact);
123 if ($unblockcontact and confirm_sesskey()) {
124     add_to_log(SITEID, 'message', 'unblock contact', 'index.php?user1='.$unblockcontact.'&amp;user2='.$USER->id, $unblockcontact);
125     message_unblock_contact($unblockcontact);
128 //was a message sent? Do NOT allow someone looking at someone else's messages to send them.
129 $messageerror = null;
130 if ($currentuser && !empty($user2) && has_capability('moodle/site:sendmessage', $context)) {
132     // Check that the user is not blocking us!!
133     if ($contact = $DB->get_record('message_contacts', array('userid'=>$user2->id, 'contactid'=>$user1->id))) {
134         if ($contact->blocked and !has_capability('moodle/site:readallmessages', $context)) {
135             $messageerror = get_string('userisblockingyou', 'message');
136         }
137     }
138     $userpreferences = get_user_preferences(NULL, NULL, $user2->id);
140     if (!empty($userpreferences['message_blocknoncontacts'])) {  // User is blocking non-contacts
141         if (empty($contact)) {   // We are not a contact!
142             $messageerror = get_string('userisblockingyounoncontact', 'message');
143         }
144     }
146     if (empty($messageerror)) {
147         $mform = new send_form();
148         $defaultmessage = new stdClass;
149         $defaultmessage->id = $user2->id;
150         $defaultmessage->message = '';
152         //Check if the current user has sent a message
153         $data = $mform->get_data();
154         if (!empty($data) && !empty($data->message)) {
155             if (!confirm_sesskey()) {
156                 print_error('invalidsesskey');
157             }
159             $messageid = message_post_message($user1, $user2, $data->message, FORMAT_MOODLE, 'direct');
160             if (!empty($messageid)) {
161                 redirect($CFG->wwwroot . '/message/index.php?usergroup='.$usergroup.'&id='.$user2->id);
162             }
163         }
164     }
167 $strmessages = get_string('messages', 'message');
168 if (!empty($user2)) {
169     $user2fullname = fullname($user2);
171     $PAGE->set_title("$strmessages: $user2fullname");
172     $PAGE->set_heading("$strmessages: $user2fullname");
173 } else {
174     $PAGE->set_title("{$SITE->shortname}: $strmessages");
175     $PAGE->set_heading("{$SITE->shortname}: $strmessages");
178 //now the page contents
179 echo $OUTPUT->header();
181 echo $OUTPUT->box_start('message');
183 $countunread = 0; //count of unread messages from $user2
184 $countunreadtotal = 0; //count of unread messages from all users
186 //we're dealing with unread messages early so the contact list will accurately reflect what is read/unread
187 $viewingnewmessages = false;
188 if (!empty($user2)) {
189     //are there any unread messages from $user2
190     $countunread = message_count_unread_messages($user1, $user2);
191     if ($countunread>0) {
192         //mark the messages we're going to display as read
193         message_mark_messages_read($user1->id, $user2->id);
194          if($usergroup==VIEW_UNREAD_MESSAGES) {
195              $viewingnewmessages = true;
196          }
197     }
199 $countunreadtotal = message_count_unread_messages($user1);
201 if ($countunreadtotal==0 && $usergroup==VIEW_UNREAD_MESSAGES && empty($user2)) {
202     //default to showing the search
203     $usergroup = VIEW_SEARCH;
206 $blockedusers = message_get_blocked_users($user1, $user2);
207 $countblocked = count($blockedusers);
209 list($onlinecontacts, $offlinecontacts, $strangers) = message_get_contacts($user1, $user2);
211 message_print_contact_selector($countunreadtotal, $usergroup, $user1, $user2, $blockedusers, $onlinecontacts, $offlinecontacts, $strangers, $showcontactactionlinks, $page);
213 echo html_writer::start_tag('div', array('class'=>'messagearea mdl-align'));
214     if (!empty($user2)) {
216         echo html_writer::start_tag('div', array('class'=>'mdl-left messagehistory'));
218             $visible = 'visible';
219             $hidden = 'hiddenelement'; //cant just use hidden as mform adds that class to its fieldset for something else
221             $recentlinkclass = $recentlabelclass = $historylinkclass = $historylabelclass = $visible;
222             if ($history==MESSAGE_HISTORY_ALL) {
223                 $displaycount = 0;
225                 $recentlabelclass = $historylinkclass = $hidden;
226             } else if($viewingnewmessages) {
227                 //if user is viewing new messages only show them the new messages
228                 $displaycount = $countunread;
230                 $recentlabelclass = $historylabelclass = $hidden;
231             } else {
232                 //default to only showing the last few messages
233                 $displaycount = MESSAGE_SHORTVIEW_LIMIT;
235                 if ($countunread>MESSAGE_SHORTVIEW_LIMIT) {
236                     $displaycount = $countunread;
237                 }
239                 $recentlinkclass = $historylabelclass = $hidden;
240             }
242             $messagehistorylink =  html_writer::start_tag('div', array('class'=>'mdl-align messagehistorytype'));
243                 $messagehistorylink .= html_writer::link($PAGE->url->out(false).'&history='.MESSAGE_HISTORY_ALL,
244                     get_string('messagehistoryfull','message'),
245                     array('class'=>$historylinkclass));
247                 $messagehistorylink .=  html_writer::start_tag('span', array('class'=>$historylabelclass));
248                     $messagehistorylink .= get_string('messagehistoryfull','message');
249                 $messagehistorylink .= html_writer::end_tag('span');
251                 $messagehistorylink .= '&nbsp;|&nbsp;'.html_writer::link($PAGE->url->out(false).'&history='.MESSAGE_HISTORY_SHORT,
252                     get_string('mostrecent','message'),
253                     array('class'=>$recentlinkclass));
255                 $messagehistorylink .=  html_writer::start_tag('span', array('class'=>$recentlabelclass));
256                     $messagehistorylink .= get_string('mostrecent','message');
257                 $messagehistorylink .= html_writer::end_tag('span');
259                 if ($viewingnewmessages) {
260                     $messagehistorylink .=  '&nbsp;|&nbsp;'.html_writer::start_tag('span');//, array('class'=>$historyclass)
261                         $messagehistorylink .= get_string('unreadnewmessages','message',$displaycount);
262                     $messagehistorylink .= html_writer::end_tag('span');
263                 }
265             $messagehistorylink .= html_writer::end_tag('div');
267             message_print_message_history($user1, $user2, $search, $displaycount, $messagehistorylink, $viewingnewmessages);
268         echo html_writer::end_tag('div');
270         //send message form
271         if ($currentuser && has_capability('moodle/site:sendmessage', $context)) {
272             echo html_writer::start_tag('div', array('class'=>'mdl-align messagesend'));
273                 if (!empty($messageerror)) {
274                     echo $OUTPUT->heading($messageerror, 3);
275                 } else {
276                     $mform = new send_form();
277                     $defaultmessage = new stdClass;
278                     $defaultmessage->id = $user2->id;
279                     $defaultmessage->message = '';
280                     //$defaultmessage->messageformat = FORMAT_MOODLE;
281                     $mform->set_data($defaultmessage);
282                     $mform->display();
283                 }
284             echo html_writer::end_tag('div');
285         }
286     } else if ($usergroup==VIEW_SEARCH) {
287         message_print_search($advancedsearch, $user1);
288     }
289 echo html_writer::end_tag('div');
291 echo $OUTPUT->box_end();
293 echo $OUTPUT->footer();