mirror of
https://github.com/moodle/moodle.git
synced 2025-01-19 14:27:22 +01:00
230 lines
8.7 KiB
PHP
230 lines
8.7 KiB
PHP
<?php
|
|
// This file is part of Moodle - http://moodle.org/
|
|
//
|
|
// Moodle is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// Moodle is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
/**
|
|
* A page displaying the user's contacts and messages
|
|
*
|
|
* @package core_message
|
|
* @copyright 2010 Andrew Davis
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
require_once('../config.php');
|
|
|
|
require_login(null, false);
|
|
|
|
if (isguestuser()) {
|
|
redirect($CFG->wwwroot);
|
|
}
|
|
|
|
if (empty($CFG->messaging)) {
|
|
print_error('disabled', 'message');
|
|
}
|
|
|
|
// The id of the user we want to view messages from.
|
|
$id = optional_param('id', 0, PARAM_INT);
|
|
|
|
// It's possible for someone with the right capabilities to view a conversation between two other users. For BC
|
|
// we are going to accept other URL parameters to figure this out.
|
|
$user1id = optional_param('user1', $USER->id, PARAM_INT);
|
|
$user2id = optional_param('user2', $id, PARAM_INT);
|
|
$contactsfirst = optional_param('contactsfirst', 0, PARAM_INT);
|
|
|
|
$url = new moodle_url('/message/index.php');
|
|
if ($id) {
|
|
$url->param('id', $id);
|
|
} else {
|
|
if ($user1id) {
|
|
$url->param('user1', $user1id);
|
|
}
|
|
if ($user2id) {
|
|
$url->param('user2', $user2id);
|
|
}
|
|
if ($contactsfirst) {
|
|
$url->param('contactsfirst', $contactsfirst);
|
|
}
|
|
}
|
|
$PAGE->set_url($url);
|
|
|
|
$user1 = null;
|
|
$currentuser = true;
|
|
if ($user1id != $USER->id) {
|
|
$user1 = core_user::get_user($user1id, '*', MUST_EXIST);
|
|
$currentuser = false;
|
|
} else {
|
|
$user1 = $USER;
|
|
}
|
|
|
|
$user2 = null;
|
|
if (!empty($user2id)) {
|
|
$user2 = core_user::get_user($user2id, '*', MUST_EXIST);
|
|
}
|
|
|
|
$user2realuser = !empty($user2) && core_user::is_real_user($user2->id);
|
|
$systemcontext = context_system::instance();
|
|
if ($currentuser === false && !has_capability('moodle/site:readallmessages', $systemcontext)) {
|
|
print_error('accessdenied', 'admin');
|
|
}
|
|
|
|
$PAGE->set_context(context_user::instance($user1->id));
|
|
$PAGE->set_pagelayout('standard');
|
|
$strmessages = get_string('messages', 'message');
|
|
if ($user2realuser) {
|
|
$user2fullname = fullname($user2);
|
|
|
|
$PAGE->set_title("$strmessages: $user2fullname");
|
|
$PAGE->set_heading("$strmessages: $user2fullname");
|
|
} else {
|
|
$PAGE->set_title("{$SITE->shortname}: $strmessages");
|
|
$PAGE->set_heading("{$SITE->shortname}: $strmessages");
|
|
}
|
|
|
|
// Remove the user node from the main navigation for this page.
|
|
$usernode = $PAGE->navigation->find('users', null);
|
|
$usernode->remove();
|
|
|
|
$settings = $PAGE->settingsnav->find('messages', null);
|
|
$settings->make_active();
|
|
|
|
// Get the renderer and the information we are going to be use.
|
|
$renderer = $PAGE->get_renderer('core_message');
|
|
$requestedconversation = false;
|
|
if ($contactsfirst) {
|
|
$conversations = \core_message\api::get_contacts($user1->id, 0, 20);
|
|
} else {
|
|
$conversations = \core_message\api::get_conversations($user1->id, 0, 20);
|
|
|
|
// Format the conversations in the legacy style, as the get_conversations method has since been changed.
|
|
$conversations = \core_message\helper::get_conversations_legacy_formatter($conversations);
|
|
}
|
|
$messages = [];
|
|
if (!$user2realuser) {
|
|
// If there are conversations, but the user has not chosen a particular one, then render the most recent one.
|
|
$user2 = new stdClass();
|
|
$user2->id = null;
|
|
if (!empty($conversations)) {
|
|
$contact = reset($conversations);
|
|
$user2->id = $contact->userid;
|
|
}
|
|
} else {
|
|
// The user has specifically requested to see a conversation. Add the flag to
|
|
// the context so that we can render the messaging app appropriately - this is
|
|
// used for smaller screens as it allows the UI to be responsive.
|
|
$requestedconversation = true;
|
|
}
|
|
|
|
// Mark the conversation as read.
|
|
if (!empty($user2->id)) {
|
|
$hasbeenreadallmessages = false;
|
|
if ($currentuser && isset($conversations[$user2->id])) {
|
|
// Mark the conversation we are loading as read.
|
|
if ($conversationid = \core_message\api::get_conversation_between_users([$user1->id, $user2->id])) {
|
|
\core_message\api::mark_all_messages_as_read($user1->id, $conversationid);
|
|
$hasbeenreadallmessages = true;
|
|
}
|
|
|
|
// Ensure the UI knows it's read as well.
|
|
$conversations[$user2->id]->isread = 1;
|
|
}
|
|
|
|
// Get the conversationid.
|
|
if (!isset($conversationid)) {
|
|
if (!$conversationid = \core_message\api::get_conversation_between_users([$user1->id, $user2->id])) {
|
|
// If the individual conversationid doesn't exist, create it.
|
|
$conversation = \core_message\api::create_conversation(
|
|
\core_message\api::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL,
|
|
[$user1->id, $user2->id]
|
|
);
|
|
$conversationid = $conversation->id;
|
|
}
|
|
}
|
|
|
|
$convmessages = \core_message\api::get_conversation_messages($user1->id, $conversationid, 0, 20, 'timecreated DESC');
|
|
$messages = [];
|
|
if (!empty($convmessages)) {
|
|
$messages = $convmessages['messages'];
|
|
|
|
// Parse the messages to add missing fields for backward compatibility.
|
|
$messages = array_reverse($messages);
|
|
// Keeps track of the last day, month and year combo we were viewing.
|
|
$day = '';
|
|
$month = '';
|
|
$year = '';
|
|
foreach ($messages as $message) {
|
|
// Add useridto.
|
|
if (empty($message->useridto)) {
|
|
if ($message->useridfrom == $user1->id) {
|
|
$message->useridto = $user2->id;
|
|
} else {
|
|
$message->useridto = $user1->id;
|
|
}
|
|
}
|
|
|
|
// Add currentuserid.
|
|
$message->currentuserid = $USER->id;
|
|
|
|
// Check if we are now viewing a different block period.
|
|
$message->displayblocktime = false;
|
|
$date = usergetdate($message->timecreated);
|
|
if ($day != $date['mday'] || $month != $date['month'] || $year != $date['year']) {
|
|
$day = $date['mday'];
|
|
$month = $date['month'];
|
|
$year = $date['year'];
|
|
$message->displayblocktime = true;
|
|
$message->blocktime = userdate($message->timecreated, get_string('strftimedaydate'));
|
|
}
|
|
|
|
// We don't have this information here so, for now, we leave an empty value or the current time.
|
|
// This is a temporary solution because a new UI is being built in MDL-63303.
|
|
$message->timeread = 0;
|
|
if ($hasbeenreadallmessages && $message->useridfrom != $user1->id) {
|
|
// As all the messages sent by the other user have been marked as read previously, we will change
|
|
// timeread to the current time to avoid the last message will be duplicated after calling to the
|
|
// core_message_data_for_messagearea_messages via javascript.
|
|
// We only need to change that to the other user, because for the current user, messages are always
|
|
// marked as unread.
|
|
$message->timeread = time();
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
$pollmin = !empty($CFG->messagingminpoll) ? $CFG->messagingminpoll : MESSAGE_DEFAULT_MIN_POLL_IN_SECONDS;
|
|
$pollmax = !empty($CFG->messagingmaxpoll) ? $CFG->messagingmaxpoll : MESSAGE_DEFAULT_MAX_POLL_IN_SECONDS;
|
|
$polltimeout = !empty($CFG->messagingtimeoutpoll) ? $CFG->messagingtimeoutpoll : MESSAGE_DEFAULT_TIMEOUT_POLL_IN_SECONDS;
|
|
$messagearea = new \core_message\output\messagearea\message_area($user1->id, $user2->id, $conversations, $messages,
|
|
$requestedconversation, $contactsfirst, $pollmin, $pollmax, $polltimeout);
|
|
|
|
// Now the page contents.
|
|
echo $OUTPUT->header();
|
|
echo $OUTPUT->heading(get_string('messages', 'message'));
|
|
|
|
// Display a message if the messages have not been migrated yet.
|
|
if (!get_user_preferences('core_message_migrate_data', false, $user1id)) {
|
|
$notify = new \core\output\notification(get_string('messagingdatahasnotbeenmigrated', 'message'),
|
|
\core\output\notification::NOTIFY_WARNING);
|
|
echo $OUTPUT->render($notify);
|
|
}
|
|
|
|
// Display a message that the user is viewing someone else's messages.
|
|
if (!$currentuser) {
|
|
$notify = new \core\output\notification(get_string('viewinganotherusersmessagearea', 'message'),
|
|
\core\output\notification::NOTIFY_WARNING);
|
|
echo $OUTPUT->render($notify);
|
|
}
|
|
echo $renderer->render($messagearea);
|
|
echo $OUTPUT->footer();
|