Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 3.9.x will end* 10 May 2021 (12 months).
  • Bug fixes for security issues in 3.9.x will end* 8 May 2023 (36 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.
<?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/>.

// This page prints reports and info about chats.

require_once('../../config.php');
require_once('lib.php');

$id            = required_param('id', PARAM_INT);
$start         = optional_param('start', 0, PARAM_INT);   // Start of period.
$end           = optional_param('end', 0, PARAM_INT);     // End of period.
$deletesession = optional_param('deletesession', 0, PARAM_BOOL);
$confirmdelete = optional_param('confirmdelete', 0, PARAM_BOOL);
$showall      = optional_param('show_all', 0, PARAM_BOOL);

$url = new moodle_url('/mod/chat/report.php', array('id' => $id));
if ($start !== 0) {
    $url->param('start', $start);
}
if ($end !== 0) {
    $url->param('end', $end);
}
if ($deletesession !== 0) {
    $url->param('deletesession', $deletesession);
}
if ($confirmdelete !== 0) {
    $url->param('confirmdelete', $confirmdelete);
}
$PAGE->set_url($url);

if (! $cm = get_coursemodule_from_id('chat', $id)) {
< print_error('invalidcoursemodule');
> throw new \moodle_exception('invalidcoursemodule');
} if (! $chat = $DB->get_record('chat', array('id' => $cm->instance))) {
< print_error('invalidcoursemodule');
> throw new \moodle_exception('invalidcoursemodule');
} if (! $course = $DB->get_record('course', array('id' => $chat->course))) {
< print_error('coursemisconf');
> throw new \moodle_exception('coursemisconf');
}
> require_login($course, false, $cm);
$context = context_module::instance($cm->id); $PAGE->set_context($context); $PAGE->set_heading($course->fullname);
< require_login($course, false, $cm); <
if (empty($chat->studentlogs) && !has_capability('mod/chat:readlog', $context)) { notice(get_string('nopermissiontoseethechatlog', 'chat')); } $params = array( 'context' => $context, 'objectid' => $chat->id, 'other' => array( 'start' => $start, 'end' => $end ) ); $event = \mod_chat\event\sessions_viewed::create($params); $event->add_record_snapshot('chat', $chat); $event->trigger(); $strchats = get_string('modulenameplural', 'chat'); $strchat = get_string('modulename', 'chat'); $strchatreport = get_string('chatreport', 'chat'); $strseesession = get_string('seesession', 'chat'); $strdeletesession = get_string('deletesession', 'chat'); $navlinks = array(); $canexportsess = has_capability('mod/chat:exportsession', $context); $canviewfullnames = has_capability('moodle/site:viewfullnames', $context);
> $PAGE->activityheader->set_attrs([ // Print a session if one has been specified. > 'title' => '', > 'description' => '', if ($start and $end and !$confirmdelete) { // Show a full transcript. > 'hidecompletion' => true, $PAGE->navbar->add($strchatreport); > 'hideoverflow' => true, $PAGE->set_title(format_string($chat->name).": $strchatreport"); > ]);
< $PAGE->set_title(format_string($chat->name).": $strchatreport");
< echo $OUTPUT->heading(format_string($chat->name), 2);
// Check to see if groups are being used here. $groupmode = groups_get_activity_groupmode($cm); $currentgroup = groups_get_activity_group($cm, true); groups_print_activity_menu($cm, $CFG->wwwroot . "/mod/chat/report.php?id=$cm->id"); if ($deletesession and has_capability('mod/chat:deletelog', $context)) { echo $OUTPUT->confirm(get_string('deletesessionsure', 'chat'), "report.php?id=$cm->id&deletesession=1&confirmdelete=1&start=$start&end=$end", "report.php?id=$cm->id"); } if (!$messages = chat_get_session_messages($chat->id, $currentgroup, $start, $end, 'timestamp ASC')) { echo $OUTPUT->heading(get_string('nomessages', 'chat')); } else { echo '<p class="boxaligncenter">'.userdate($start).' --> '. userdate($end).'</p>'; echo $OUTPUT->box_start('center'); $participates = array(); foreach ($messages as $message) { // We are walking FORWARDS through messages. if (!isset($participates[$message->userid])) { $participates[$message->userid] = true; } $formatmessage = chat_format_message($message, $course->id, $USER); if (isset($formatmessage->html)) { echo $formatmessage->html; } } $participatedcap = array_key_exists($USER->id, $participates) && has_capability('mod/chat:exportparticipatedsession', $context); if (!empty($CFG->enableportfolios) && ($canexportsess || $participatedcap)) { require_once($CFG->libdir . '/portfoliolib.php'); $buttonoptions = array( 'id' => $cm->id, 'start' => $start, 'end' => $end, ); $button = new portfolio_add_button(); $button->set_callback_options('chat_portfolio_caller', $buttonoptions, 'mod_chat'); $button->render(); } echo $OUTPUT->box_end(); } if (!$deletesession or !has_capability('mod/chat:deletelog', $context)) { echo $OUTPUT->continue_button("report.php?id=$cm->id"); } echo $OUTPUT->footer(); exit; } // Print the Sessions display. $PAGE->navbar->add($strchatreport);
< $PAGE->set_title(format_string($chat->name).": $strchatreport");
> $PAGE->set_title($strchatreport);
echo $OUTPUT->header();
< echo $OUTPUT->heading(format_string($chat->name).': '.get_string('sessions', 'chat'), 2);
> echo $OUTPUT->heading(get_string('sessions', 'chat'), 2);
// Check to see if groups are being used here if ($groupmode = groups_get_activity_groupmode($cm)) { // Groups are being used. $currentgroup = groups_get_activity_group($cm, true); groups_print_activity_menu($cm, $CFG->wwwroot . "/mod/chat/report.php?id=$cm->id"); } else { $currentgroup = false; } $params = array('currentgroup' => $currentgroup, 'chatid' => $chat->id, 'start' => $start, 'end' => $end); // If the user is allocated to a group, only show discussions with people in // the same group, or no group. if (!empty($currentgroup)) { $groupselect = " AND (groupid = :currentgroup OR groupid = 0)"; } else { $groupselect = ""; } // Delete a session if one has been specified. if ($deletesession and has_capability('mod/chat:deletelog', $context) and $confirmdelete and $start and $end and confirm_sesskey()) { $DB->delete_records_select('chat_messages', "chatid = :chatid AND timestamp >= :start AND timestamp <= :end $groupselect", $params); $strdeleted = get_string('deleted'); echo $OUTPUT->notification("$strdeleted: ".userdate($start).' --> '. userdate($end)); unset($deletesession); } // Get the messages. if (empty($messages)) { // May have already got them above. if (!$messages = chat_get_session_messages($chat->id, $currentgroup, 0, 0, 'timestamp DESC')) { echo $OUTPUT->heading(get_string('nomessages', 'chat'), 3); echo $OUTPUT->footer(); exit; } } if ($showall) { $headingstr = get_string('listing_all_sessions', 'chat') . '&nbsp;'; $headingstr .= html_writer::link("report.php?id={$cm->id}&show_all=0", get_string('list_complete_sessions', 'chat')); echo $OUTPUT->heading($headingstr, 3); } // Show all the sessions. $completesessions = 0; echo '<div class="list-group">'; $sessions = chat_get_sessions($messages, $showall); foreach ($sessions as $session) { echo '<div class="list-group-item">'; echo '<p>'.userdate($session->sessionstart).' --> '. userdate($session->sessionend).'</p>'; echo $OUTPUT->box_start(); arsort($session->sessionusers); foreach ($session->sessionusers as $sessionuser => $usermessagecount) { if ($user = $DB->get_record('user', array('id' => $sessionuser))) { $OUTPUT->user_picture($user, array('courseid' => $course->id)); echo '&nbsp;' . fullname($user, $canviewfullnames); echo "&nbsp;($usermessagecount)<br />"; } } echo '<p align="right">'; echo "<a href=\"report.php?id=$cm->id&amp;start=$session->sessionstart&amp;end=$session->sessionend\">$strseesession</a>"; $participatedcap = (array_key_exists($USER->id, $session->sessionusers) && has_capability('mod/chat:exportparticipatedsession', $context)); if (!empty($CFG->enableportfolios) && ($canexportsess || $participatedcap)) { require_once($CFG->libdir . '/portfoliolib.php'); $buttonoptions = array( 'id' => $cm->id, 'start' => $session->sessionstart, 'end' => $session->sessionend, ); $button = new portfolio_add_button(); $button->set_callback_options('chat_portfolio_caller', $buttonoptions, 'mod_chat'); $portfoliobutton = $button->to_html(PORTFOLIO_ADD_TEXT_LINK); if (!empty($portfoliobutton)) { echo '<br />' . $portfoliobutton; } } if (has_capability('mod/chat:deletelog', $context)) { $deleteurl = "report.php?id=$cm->id&amp;start=$session->sessionstart&amp;end=$session->sessionend&amp;deletesession=1"; echo "<br /><a href=\"$deleteurl\">$strdeletesession</a>"; } echo '</p>'; echo $OUTPUT->box_end(); echo '</div>'; if ($session->iscomplete) { $completesessions++; } } echo '</div>'; if (!empty($CFG->enableportfolios) && $canexportsess) { require_once($CFG->libdir . '/portfoliolib.php'); $button = new portfolio_add_button(); $button->set_callback_options('chat_portfolio_caller', array('id' => $cm->id), 'mod_chat'); $button->render(null, get_string('addalltoportfolio', 'portfolio')); } if (!$showall and $completesessions == 0) { echo html_writer::start_tag('p'); echo get_string('no_complete_sessions_found', 'chat') . '&nbsp;'; echo html_writer::link('report.php?id='.$cm->id.'&show_all=1', get_string('list_all_sessions', 'chat')); echo html_writer::end_tag('p'); } // Finish the page. echo $OUTPUT->footer();