Merge branch 'w07_MDL-26211_20_https' of git://github.com/skodak/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 //the same param as 1.9 and the param we have been logging. Use this parameter.
45 $user1id   = optional_param(MESSAGE_USER1_PARAM, $USER->id, PARAM_INT);
46 //2.0 shipped using this param. Retaining it only for compatibility. It should be removed.
47 $user1id   = optional_param('user', $user1id, PARAM_INT);
49 //the same param as 1.9 and the param we have been logging. Use this parameter.
50 $user2id   = optional_param(MESSAGE_USER2_PARAM, 0, PARAM_INT);
51 //2.0 shipped using this param. Retaining it only for compatibility. It should be removed.
52 $user2id   = optional_param('id', $user2id, PARAM_INT);
54 $addcontact     = optional_param('addcontact',     0, PARAM_INT); // adding a contact
55 $removecontact  = optional_param('removecontact',  0, PARAM_INT); // removing a contact
56 $blockcontact   = optional_param('blockcontact',   0, PARAM_INT); // blocking a contact
57 $unblockcontact = optional_param('unblockcontact', 0, PARAM_INT); // unblocking a contact
59 //for search
60 $advancedsearch = optional_param('advanced', 0, PARAM_INT);
62 //if they have numerous contacts or are viewing course participants we might need to page through them
63 $page = optional_param('page', 0, PARAM_INT);
65 $url = new moodle_url('/message/index.php');
67 if ($user2id !== 0) {
68     $url->param('id', $user2id);
69 }
71 if ($usergroup !== 0) {
72     if ($user2id !== 0 && $usergroup==VIEW_SEARCH) {
73         //if theyve searched and selected a user change the view back to contacts so the search button is displayed
74         $usergroup = VIEW_CONTACTS;
75     }
76     $url->param('usergroup', $usergroup);
77 }
79 $PAGE->set_url($url);
81 $PAGE->set_context(get_context_instance(CONTEXT_USER, $USER->id));
82 $PAGE->navigation->extend_for_user($USER);
83 $PAGE->set_pagelayout('course');
85 $context = get_context_instance(CONTEXT_SYSTEM);
87 $user1 = null;
88 $currentuser = true;
89 $showcontactactionlinks = SHOW_ACTION_LINKS_IN_CONTACT_LIST;
90 if ($user1id!=$USER->id) {
91     $user1 = $DB->get_record('user', array('id'=>$user1id));
92     if (!$user1) {
93         print_error('invaliduserid');
94     }
95     $currentuser = false;//if we're looking at someone else's messages we need to lock/remove some UI elements
96     $showcontactactionlinks = false;
97 } else {
98     $user1 = $USER;
99 }
100 unset($user1id);
102 $user2 = null;
103 if (!empty($user2id)) {
104     $user2 = $DB->get_record("user", array("id"=>$user2id));
105     if (!$user2) {
106         print_error('invaliduserid');
107     }
109 unset($user2id);
111 //the current user isnt involved in this discussion at all
112 if ($user1->id!=$USER->id && $user2->id!=$USER->id && !has_capability('moodle/site:readallmessages', $context)) {
113     print_error('accessdenied','admin');
116 /// Process any contact maintenance requests there may be
117 if ($addcontact and confirm_sesskey()) {
118     add_to_log(SITEID, 'message', 'add contact', 'index.php?user1='.$addcontact.'&amp;user2='.$USER->id, $addcontact);
119     message_add_contact($addcontact);
120     redirect($CFG->wwwroot . '/message/index.php?usergroup=contacts&id='.$addcontact);
122 if ($removecontact and confirm_sesskey()) {
123     add_to_log(SITEID, 'message', 'remove contact', 'index.php?user1='.$removecontact.'&amp;user2='.$USER->id, $removecontact);
124     message_remove_contact($removecontact);
126 if ($blockcontact and confirm_sesskey()) {
127     add_to_log(SITEID, 'message', 'block contact', 'index.php?user1='.$blockcontact.'&amp;user2='.$USER->id, $blockcontact);
128     message_block_contact($blockcontact);
130 if ($unblockcontact and confirm_sesskey()) {
131     add_to_log(SITEID, 'message', 'unblock contact', 'index.php?user1='.$unblockcontact.'&amp;user2='.$USER->id, $unblockcontact);
132     message_unblock_contact($unblockcontact);
135 //was a message sent? Do NOT allow someone looking at someone else's messages to send them.
136 $messageerror = null;
137 if ($currentuser && !empty($user2) && has_capability('moodle/site:sendmessage', $context)) {
139     // Check that the user is not blocking us!!
140     if ($contact = $DB->get_record('message_contacts', array('userid'=>$user2->id, 'contactid'=>$user1->id))) {
141         if ($contact->blocked and !has_capability('moodle/site:readallmessages', $context)) {
142             $messageerror = get_string('userisblockingyou', 'message');
143         }
144     }
145     $userpreferences = get_user_preferences(NULL, NULL, $user2->id);
147     if (!empty($userpreferences['message_blocknoncontacts'])) {  // User is blocking non-contacts
148         if (empty($contact)) {   // We are not a contact!
149             $messageerror = get_string('userisblockingyounoncontact', 'message');
150         }
151     }
153     if (empty($messageerror)) {
154         $mform = new send_form();
155         $defaultmessage = new stdClass;
156         $defaultmessage->id = $user2->id;
157         $defaultmessage->message = '';
159         //Check if the current user has sent a message
160         $data = $mform->get_data();
161         if (!empty($data) && !empty($data->message)) {
162             if (!confirm_sesskey()) {
163                 print_error('invalidsesskey');
164             }
166             $messageid = message_post_message($user1, $user2, $data->message, FORMAT_MOODLE, 'direct');
167             if (!empty($messageid)) {
168                 //including the id of the user sending the message in the logged URL so the URL works for admins
169                 //note message ID may be misleading as the message may potentially get a different ID when moved from message to message_read
170                 add_to_log(SITEID, 'message', 'write', 'index.php?user='.$user1->id.'&id='.$user2->id.'&history=1#m'.$messageid, $user1->id);
171                 redirect($CFG->wwwroot . '/message/index.php?usergroup='.$usergroup.'&id='.$user2->id);
172             }
173         }
174     }
177 $strmessages = get_string('messages', 'message');
178 if (!empty($user2)) {
179     $user2fullname = fullname($user2);
181     $PAGE->set_title("$strmessages: $user2fullname");
182     $PAGE->set_heading("$strmessages: $user2fullname");
183 } else {
184     $PAGE->set_title("{$SITE->shortname}: $strmessages");
185     $PAGE->set_heading("{$SITE->shortname}: $strmessages");
188 //now the page contents
189 echo $OUTPUT->header();
191 echo $OUTPUT->box_start('message');
193 $countunread = 0; //count of unread messages from $user2
194 $countunreadtotal = 0; //count of unread messages from all users
196 //we're dealing with unread messages early so the contact list will accurately reflect what is read/unread
197 $viewingnewmessages = false;
198 if (!empty($user2)) {
199     //are there any unread messages from $user2
200     $countunread = message_count_unread_messages($user1, $user2);
201     if ($countunread>0) {
202         //mark the messages we're going to display as read
203         message_mark_messages_read($user1->id, $user2->id);
204          if($usergroup==VIEW_UNREAD_MESSAGES) {
205              $viewingnewmessages = true;
206          }
207     }
209 $countunreadtotal = message_count_unread_messages($user1);
211 if ($countunreadtotal==0 && $usergroup==VIEW_UNREAD_MESSAGES && empty($user2)) {
212     //default to showing the search
213     $usergroup = VIEW_SEARCH;
216 $blockedusers = message_get_blocked_users($user1, $user2);
217 $countblocked = count($blockedusers);
219 list($onlinecontacts, $offlinecontacts, $strangers) = message_get_contacts($user1, $user2);
221 message_print_contact_selector($countunreadtotal, $usergroup, $user1, $user2, $blockedusers, $onlinecontacts, $offlinecontacts, $strangers, $showcontactactionlinks, $page);
223 echo html_writer::start_tag('div', array('class'=>'messagearea mdl-align'));
224     if (!empty($user2)) {
226         echo html_writer::start_tag('div', array('class'=>'mdl-left messagehistory'));
228             $visible = 'visible';
229             $hidden = 'hiddenelement'; //cant just use hidden as mform adds that class to its fieldset for something else
231             $recentlinkclass = $recentlabelclass = $historylinkclass = $historylabelclass = $visible;
232             if ($history==MESSAGE_HISTORY_ALL) {
233                 $displaycount = 0;
235                 $recentlabelclass = $historylinkclass = $hidden;
236             } else if($viewingnewmessages) {
237                 //if user is viewing new messages only show them the new messages
238                 $displaycount = $countunread;
240                 $recentlabelclass = $historylabelclass = $hidden;
241             } else {
242                 //default to only showing the last few messages
243                 $displaycount = MESSAGE_SHORTVIEW_LIMIT;
245                 if ($countunread>MESSAGE_SHORTVIEW_LIMIT) {
246                     $displaycount = $countunread;
247                 }
249                 $recentlinkclass = $historylabelclass = $hidden;
250             }
252             $messagehistorylink =  html_writer::start_tag('div', array('class'=>'mdl-align messagehistorytype'));
253                 $messagehistorylink .= html_writer::link($PAGE->url->out(false).'&history='.MESSAGE_HISTORY_ALL,
254                     get_string('messagehistoryfull','message'),
255                     array('class'=>$historylinkclass));
257                 $messagehistorylink .=  html_writer::start_tag('span', array('class'=>$historylabelclass));
258                     $messagehistorylink .= get_string('messagehistoryfull','message');
259                 $messagehistorylink .= html_writer::end_tag('span');
261                 $messagehistorylink .= '&nbsp;|&nbsp;'.html_writer::link($PAGE->url->out(false).'&history='.MESSAGE_HISTORY_SHORT,
262                     get_string('mostrecent','message'),
263                     array('class'=>$recentlinkclass));
265                 $messagehistorylink .=  html_writer::start_tag('span', array('class'=>$recentlabelclass));
266                     $messagehistorylink .= get_string('mostrecent','message');
267                 $messagehistorylink .= html_writer::end_tag('span');
269                 if ($viewingnewmessages) {
270                     $messagehistorylink .=  '&nbsp;|&nbsp;'.html_writer::start_tag('span');//, array('class'=>$historyclass)
271                         $messagehistorylink .= get_string('unreadnewmessages','message',$displaycount);
272                     $messagehistorylink .= html_writer::end_tag('span');
273                 }
275             $messagehistorylink .= html_writer::end_tag('div');
277             message_print_message_history($user1, $user2, $search, $displaycount, $messagehistorylink, $viewingnewmessages);
278         echo html_writer::end_tag('div');
280         //send message form
281         if ($currentuser && has_capability('moodle/site:sendmessage', $context)) {
282             echo html_writer::start_tag('div', array('class'=>'mdl-align messagesend'));
283                 if (!empty($messageerror)) {
284                     echo $OUTPUT->heading($messageerror, 3);
285                 } else {
286                     $mform = new send_form();
287                     $defaultmessage = new stdClass;
288                     $defaultmessage->id = $user2->id;
289                     $defaultmessage->message = '';
290                     //$defaultmessage->messageformat = FORMAT_MOODLE;
291                     $mform->set_data($defaultmessage);
292                     $mform->display();
293                 }
294             echo html_writer::end_tag('div');
295         }
296     } else if ($usergroup==VIEW_SEARCH) {
297         message_print_search($advancedsearch, $user1);
298     }
299 echo html_writer::end_tag('div');
301 echo $OUTPUT->box_end();
303 echo $OUTPUT->footer();