mirror of
https://github.com/moodle/moodle.git
synced 2025-01-19 06:18:28 +01:00
438 lines
16 KiB
PHP
438 lines
16 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/>.
|
|
|
|
/**
|
|
* Table log for displaying logs.
|
|
*
|
|
* @package report_log
|
|
* @copyright 2014 Rajesh Taneja <rajesh.taneja@gmail.com>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
defined('MOODLE_INTERNAL') || die;
|
|
|
|
/**
|
|
* Table log class for displaying logs.
|
|
*
|
|
* @package report_log
|
|
* @copyright 2014 Rajesh Taneja <rajesh.taneja@gmail.com>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class report_log_table_log extends table_sql {
|
|
|
|
/** @var array list of user fullnames shown in report */
|
|
private $userfullnames = array();
|
|
|
|
/** @var array list of course short names shown in report */
|
|
private $courseshortnames = array();
|
|
|
|
/** @var array list of context name shown in report */
|
|
private $contextname = array();
|
|
|
|
/** @var stdClass filters parameters */
|
|
private $filterparams;
|
|
|
|
/**
|
|
* Sets up the table_log parameters.
|
|
*
|
|
* @param string $uniqueid unique id of form.
|
|
* @param stdClass $filterparams (optional) filter params.
|
|
* - int courseid: id of course
|
|
* - int userid: user id
|
|
* - int|string modid: Module id or "site_errors" to view site errors
|
|
* - int groupid: Group id
|
|
* - \core\log\sql_select_reader logreader: reader from which data will be fetched.
|
|
* - int edulevel: educational level.
|
|
* - string action: view action
|
|
* - int date: Date from which logs to be viewed.
|
|
*/
|
|
public function __construct($uniqueid, $filterparams = null) {
|
|
parent::__construct($uniqueid);
|
|
|
|
$this->set_attribute('class', 'reportlog generaltable generalbox');
|
|
$this->filterparams = $filterparams;
|
|
// Add course column if logs are displayed for site.
|
|
$cols = array();
|
|
$headers = array();
|
|
if (empty($filterparams->courseid)) {
|
|
$cols = array('course');
|
|
$headers = array(get_string('course'));
|
|
}
|
|
|
|
$this->define_columns(array_merge($cols, array('time', 'fullnameuser', 'relatedfullnameuser', 'context', 'component',
|
|
'eventname', 'description', 'origin', 'ip')));
|
|
$this->define_headers(array_merge($headers, array(
|
|
get_string('time'),
|
|
get_string('fullnameuser'),
|
|
get_string('eventrelatedfullnameuser', 'report_log'),
|
|
get_string('eventcontext', 'report_log'),
|
|
get_string('eventcomponent', 'report_log'),
|
|
get_string('eventname'),
|
|
get_string('description'),
|
|
get_string('eventorigin', 'report_log'),
|
|
get_string('ip_address')
|
|
)
|
|
));
|
|
$this->collapsible(false);
|
|
$this->sortable(false);
|
|
$this->pageable(true);
|
|
}
|
|
|
|
/**
|
|
* Generate the course column.
|
|
*
|
|
* @param stdClass $event event data.
|
|
* @return string HTML for the course column.
|
|
*/
|
|
public function col_course($event) {
|
|
if (empty($event->courseid) || empty($this->courseshortnames[$event->courseid])) {
|
|
return '-';
|
|
} else {
|
|
return $this->courseshortnames[$event->courseid];
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Generate the time column.
|
|
*
|
|
* @param stdClass $event event data.
|
|
* @return string HTML for the time column
|
|
*/
|
|
public function col_time($event) {
|
|
$recenttimestr = get_string('strftimerecent', 'core_langconfig');
|
|
return userdate($event->timecreated, $recenttimestr);
|
|
}
|
|
|
|
/**
|
|
* Generate the username column.
|
|
*
|
|
* @param stdClass $event event data.
|
|
* @return string HTML for the username column
|
|
*/
|
|
public function col_fullnameuser($event) {
|
|
// Get extra event data for origin and realuserid.
|
|
$logextra = $event->get_logextra();
|
|
|
|
// Add username who did the action.
|
|
if (!empty($logextra['realuserid'])) {
|
|
$a = new stdClass();
|
|
$a->realusername = html_writer::link(new moodle_url("/user/view.php?id={$event->userid}&course={$event->courseid}"),
|
|
$this->userfullnames[$logextra['realuserid']]);
|
|
$a->asusername = html_writer::link(new moodle_url("/user/view.php?id={$event->userid}&course={$event->courseid}"),
|
|
$this->userfullnames[$event->userid]);
|
|
$username = get_string('eventloggedas', 'report_log', $a);
|
|
} else if (!empty($event->userid) && !empty($this->userfullnames[$event->userid])) {
|
|
$params = array('id' => $event->userid);
|
|
if ($event->courseid) {
|
|
$params['course'] = $event->courseid;
|
|
}
|
|
$username = html_writer::link(new moodle_url("/user/view.php", $params), $this->userfullnames[$event->userid]);
|
|
} else {
|
|
$username = '-';
|
|
}
|
|
return $username;
|
|
}
|
|
|
|
/**
|
|
* Generate the related username column.
|
|
*
|
|
* @param stdClass $event event data.
|
|
* @return string HTML for the related username column
|
|
*/
|
|
public function col_relatedfullnameuser($event) {
|
|
// Add affected user.
|
|
if (!empty($event->relateduserid) && isset($this->userfullnames[$event->relateduserid])) {
|
|
return html_writer::link(new moodle_url("/user/view.php?id=" . $event->relateduserid . "&course=" .
|
|
$event->courseid), $this->userfullnames[$event->relateduserid]);
|
|
} else {
|
|
return '-';
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Generate the context column.
|
|
*
|
|
* @param stdClass $event event data.
|
|
* @return string HTML for the context column
|
|
*/
|
|
public function col_context($event) {
|
|
// Add context name.
|
|
if ($event->contextid) {
|
|
// If context name was fetched before then return, else get one.
|
|
if (isset($this->contextname[$event->contextid])) {
|
|
return $this->contextname[$event->contextid];
|
|
} else {
|
|
$context = context::instance_by_id($event->contextid, IGNORE_MISSING);
|
|
if ($context) {
|
|
$contextname = $context->get_context_name(true);
|
|
if ($url = $context->get_url()) {
|
|
$contextname = html_writer::link($url, $contextname);
|
|
}
|
|
} else {
|
|
$contextname = get_string('other');
|
|
}
|
|
}
|
|
} else {
|
|
$contextname = get_string('other');
|
|
}
|
|
|
|
$this->contextname[$event->contextid] = $contextname;
|
|
return $contextname;
|
|
}
|
|
|
|
/**
|
|
* Generate the component column.
|
|
*
|
|
* @param stdClass $event event data.
|
|
* @return string HTML for the component column
|
|
*/
|
|
public function col_component($event) {
|
|
// Component.
|
|
$componentname = $event->component;
|
|
if (($event->component === 'core') || ($event->component === 'legacy')) {
|
|
return get_string('coresystem');
|
|
} else if (get_string_manager()->string_exists('pluginname', $event->component)) {
|
|
return get_string('pluginname', $event->component);
|
|
} else {
|
|
return $componentname;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Generate the event name column.
|
|
*
|
|
* @param stdClass $event event data.
|
|
* @return string HTML for the event name column
|
|
*/
|
|
public function col_eventname($event) {
|
|
// Event name.
|
|
$eventname = $event->get_name();
|
|
if ($url = $event->get_url()) {
|
|
$eventname = html_writer::link($url, $eventname);
|
|
}
|
|
return $eventname;
|
|
}
|
|
|
|
/**
|
|
* Generate the description column.
|
|
*
|
|
* @param stdClass $event event data.
|
|
* @return string HTML for the description column
|
|
*/
|
|
public function col_description($event) {
|
|
// Description.
|
|
return $event->get_description();
|
|
}
|
|
|
|
/**
|
|
* Generate the origin column.
|
|
*
|
|
* @param stdClass $event event data.
|
|
* @return string HTML for the origin column
|
|
*/
|
|
public function col_origin($event) {
|
|
// Get extra event data for origin and realuserid.
|
|
$logextra = $event->get_logextra();
|
|
|
|
// Add event origin, normally IP/cron.
|
|
return $logextra['origin'];
|
|
}
|
|
|
|
/**
|
|
* Generate the ip column.
|
|
*
|
|
* @param stdClass $event event data.
|
|
* @return string HTML for the ip column
|
|
*/
|
|
public function col_ip($event) {
|
|
// Get extra event data for origin and realuserid.
|
|
$logextra = $event->get_logextra();
|
|
|
|
$link = new moodle_url("/iplookup/index.php?ip={$logextra['ip']}&user=$event->userid");
|
|
return html_writer::link($link, $logextra['ip']);
|
|
}
|
|
|
|
/**
|
|
* Helper function to get legacy crud action.
|
|
*
|
|
* @param string $crud crud action
|
|
* @return string legacy action.
|
|
*/
|
|
public function get_legacy_crud_action($crud) {
|
|
$legacyactionmap = array('c' => 'add', 'r' => 'view', 'u' => 'update', 'd' => 'delete');
|
|
if (array_key_exists($crud, $legacyactionmap)) {
|
|
return $legacyactionmap[$crud];
|
|
} else {
|
|
// From old legacy log.
|
|
return '-view';
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Helper function which is used by build logs to get action sql and param.
|
|
*
|
|
* @return array sql and param for action.
|
|
*/
|
|
public function get_action_sql() {
|
|
global $DB;
|
|
|
|
// In new logs we have a field to pick, and in legacy try get this from action.
|
|
if ($this->filterparams->logreader instanceof logstore_legacy\log\store) {
|
|
$action = $this->get_legacy_crud_action($this->filterparams->action);
|
|
$firstletter = substr($action, 0, 1);
|
|
if ($firstletter == '-') {
|
|
$sql = $DB->sql_like('action', ':action', false, true, true);
|
|
$params['action'] = '%'.substr($action, 1).'%';
|
|
} else {
|
|
$sql = $DB->sql_like('action', ':action', false);
|
|
$params['action'] = '%'.$action.'%';
|
|
}
|
|
} else {
|
|
$sql = "crud = :crud";
|
|
$params['crud'] = $this->filterparams->action;
|
|
}
|
|
return array($sql, $params);
|
|
}
|
|
|
|
/**
|
|
* Query the reader. Store results in the object for use by build_table.
|
|
*
|
|
* @param int $pagesize size of page for paginated displayed table.
|
|
* @param bool $useinitialsbar do you want to use the initials bar.
|
|
*/
|
|
public function query_db($pagesize, $useinitialsbar = true) {
|
|
|
|
$joins = array();
|
|
$params = array();
|
|
|
|
$groupid = 0;
|
|
if (!empty($this->filterparams->courseid)) {
|
|
if (!empty($this->filterparams->groupid)) {
|
|
$groupid = $this->filterparams->groupid;
|
|
}
|
|
|
|
$joins[] = "courseid = :courseid";
|
|
$params['courseid'] = $this->filterparams->courseid;
|
|
}
|
|
|
|
if (!empty($this->filterparams->siteerrors)) {
|
|
$joins[] = "( action='error' OR action='infected' OR action='failed' )";
|
|
}
|
|
|
|
if (!empty($this->filterparams->modid)) {
|
|
$joins[] = "contextinstanceid = :contextinstanceid";
|
|
$params['contextinstanceid'] = $this->filterparams->modid;
|
|
}
|
|
|
|
if (!empty($this->filterparams->action)) {
|
|
list($actionsql, $actionparams) = $this->get_action_sql();
|
|
$joins[] = $actionsql;
|
|
$params = array_merge($params, $actionparams);
|
|
}
|
|
|
|
// Getting all members of a group.
|
|
if ($groupid and empty($this->filterparams->userid)) {
|
|
if ($gusers = groups_get_members($groupid)) {
|
|
$gusers = array_keys($gusers);
|
|
$joins[] = 'userid IN (' . implode(',', $gusers) . ')';
|
|
} else {
|
|
$joins[] = 'userid = 0'; // No users in groups, so we want something that will always be false.
|
|
}
|
|
} else if (!empty($this->filterparams->userid)) {
|
|
$joins[] = "userid = :userid";
|
|
$params['userid'] = $this->filterparams->userid;
|
|
}
|
|
|
|
if (!empty($this->filterparams->date)) {
|
|
$joins[] = "timecreated > :date";
|
|
$params['date'] = $this->filterparams->date;
|
|
}
|
|
|
|
if (isset($this->filterparams->edulevel) && ($this->filterparams->edulevel >= 0)) {
|
|
$joins[] = "edulevel = :edulevel";
|
|
$params['edulevel'] = $this->filterparams->edulevel;
|
|
}
|
|
|
|
$selector = implode(' AND ', $joins);
|
|
|
|
if (!$this->is_downloading()) {
|
|
$total = $this->filterparams->logreader->get_events_select_count($selector, $params);
|
|
$this->pagesize($pagesize, $total);
|
|
}
|
|
$this->rawdata = $this->filterparams->logreader->get_events_select($selector, $params, $this->filterparams->orderby,
|
|
$this->get_page_start(), $this->get_page_size());
|
|
|
|
// Set initial bars.
|
|
if ($useinitialsbar && !$this->is_downloading()) {
|
|
$this->initialbars($total > $pagesize);
|
|
}
|
|
|
|
// Update list of users and courses list which will be displayed on log page.
|
|
$this->update_users_and_courses_used();
|
|
}
|
|
|
|
/**
|
|
* Helper function to create list of course shortname and user fullname shown in log report.
|
|
* This will update $this->userfullnames and $this->courseshortnames array with userfullname and courseshortname (with link),
|
|
* which will be used to render logs in table.
|
|
*/
|
|
public function update_users_and_courses_used() {
|
|
global $SITE, $DB;
|
|
|
|
$this->userfullnames = array();
|
|
$this->courseshortnames = array($SITE->id => $SITE->shortname);
|
|
$userids = array();
|
|
$courseids = array();
|
|
// For each event cache full username and course.
|
|
// Get list of userids and courseids which will be shown in log report.
|
|
foreach ($this->rawdata as $event) {
|
|
$logextra = $event->get_logextra();
|
|
if (!empty($event->userid) && !in_array($event->userid, $userids)) {
|
|
$userids[] = $event->userid;
|
|
}
|
|
if (!empty($logextra['realuserid']) && !in_array($logextra['realuserid'], $userids)) {
|
|
$userids[] = $logextra['realuserid'];
|
|
}
|
|
if (!empty($event->relateduserid) && !in_array($event->relateduserid, $userids)) {
|
|
$userids[] = $event->relateduserid;
|
|
}
|
|
|
|
if (!empty($event->courseid) && ($event->courseid != $SITE->id) && !in_array($event->courseid, $courseids)) {
|
|
$courseids[] = $event->courseid;
|
|
}
|
|
}
|
|
|
|
// Get user fullname and put that in return list.
|
|
if (!empty($userids)) {
|
|
list($usql, $uparams) = $DB->get_in_or_equal($userids);
|
|
$users = $DB->get_records_sql("SELECT id," . get_all_user_name_fields(true) . " FROM {user} WHERE id " . $usql,
|
|
$uparams);
|
|
foreach ($users as $userid => $user) {
|
|
$this->userfullnames[$userid] = fullname($user);
|
|
}
|
|
}
|
|
|
|
// Get course shortname and put that in return list.
|
|
if (!empty($courseids)) { // If all logs don't belog to site level then get course info.
|
|
list($coursesql, $courseparams) = $DB->get_in_or_equal($courseids);
|
|
$courses = $DB->get_records_sql("SELECT id,shortname FROM {course} WHERE id " . $coursesql, $courseparams);
|
|
foreach ($courses as $courseid => $course) {
|
|
$url = new moodle_url("/course/view.php", array('id' => $courseid));
|
|
$this->courseshortnames[$courseid] = html_writer::link($url, format_string($course->shortname));
|
|
}
|
|
}
|
|
}
|
|
} |