mirror of
https://github.com/moodle/moodle.git
synced 2025-01-18 05:58:34 +01:00
ed44f0aa62
Fix the alternate name warning which is generated when course participation report is viewed
361 lines
14 KiB
PHP
361 lines
14 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/>.
|
|
|
|
/**
|
|
* Participation report
|
|
*
|
|
* @package report
|
|
* @subpackage participation
|
|
* @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
require('../../config.php');
|
|
require_once($CFG->dirroot.'/lib/tablelib.php');
|
|
|
|
define('DEFAULT_PAGE_SIZE', 20);
|
|
define('SHOW_ALL_PAGE_SIZE', 5000);
|
|
|
|
$id = required_param('id', PARAM_INT); // course id.
|
|
$roleid = optional_param('roleid', 0, PARAM_INT); // which role to show
|
|
$instanceid = optional_param('instanceid', 0, PARAM_INT); // instance we're looking at.
|
|
$timefrom = optional_param('timefrom', 0, PARAM_INT); // how far back to look...
|
|
$action = optional_param('action', '', PARAM_ALPHA);
|
|
$page = optional_param('page', 0, PARAM_INT); // which page to show
|
|
$perpage = optional_param('perpage', DEFAULT_PAGE_SIZE, PARAM_INT); // how many per page
|
|
$currentgroup = optional_param('group', 0, PARAM_INT); // Get the active group.
|
|
|
|
$url = new moodle_url('/report/participation/index.php', array('id'=>$id));
|
|
if ($roleid !== 0) $url->param('roleid');
|
|
if ($instanceid !== 0) $url->param('instanceid');
|
|
if ($timefrom !== 0) $url->param('timefrom');
|
|
if ($action !== '') $url->param('action');
|
|
if ($page !== 0) $url->param('page');
|
|
if ($perpage !== DEFAULT_PAGE_SIZE) $url->param('perpage');
|
|
$PAGE->set_url($url);
|
|
$PAGE->set_pagelayout('admin');
|
|
|
|
if ($action != 'view' and $action != 'post') {
|
|
$action = ''; // default to all (don't restrict)
|
|
}
|
|
|
|
if (!$course = $DB->get_record('course', array('id'=>$id))) {
|
|
print_error('invalidcourse');
|
|
}
|
|
|
|
if ($roleid != 0 and !$role = $DB->get_record('role', array('id'=>$roleid))) {
|
|
print_error('invalidrole');
|
|
}
|
|
|
|
require_login($course);
|
|
$context = context_course::instance($course->id);
|
|
require_capability('report/participation:view', $context);
|
|
|
|
$strparticipation = get_string('participationreport');
|
|
$strviews = get_string('views');
|
|
$strposts = get_string('posts');
|
|
$strview = get_string('view');
|
|
$strpost = get_string('post');
|
|
$strallactions = get_string('allactions');
|
|
$strreports = get_string('reports');
|
|
|
|
$actionoptions = array('' => $strallactions,
|
|
'view' => $strview,
|
|
'post' => $strpost,);
|
|
if (!array_key_exists($action, $actionoptions)) {
|
|
$action = '';
|
|
}
|
|
|
|
$PAGE->set_title($course->shortname .': '. $strparticipation);
|
|
$PAGE->set_heading($course->fullname);
|
|
echo $OUTPUT->header();
|
|
|
|
// Trigger a content view event.
|
|
$event = \report_participation\event\content_viewed::create(array('courseid' => $course->id,
|
|
'other' => array('content' => 'participants')));
|
|
$event->set_page_detail();
|
|
$event->set_legacy_logdata(array($course->id, "course", "report participation",
|
|
"report/participation/index.php?id=$course->id", $course->id));
|
|
$event->trigger();
|
|
|
|
$modinfo = get_fast_modinfo($course);
|
|
|
|
$modules = $DB->get_records_select('modules', "visible = 1", null, 'name ASC');
|
|
|
|
$instanceoptions = array();
|
|
foreach ($modules as $module) {
|
|
if (empty($modinfo->instances[$module->name])) {
|
|
continue;
|
|
}
|
|
$instances = array();
|
|
foreach ($modinfo->instances[$module->name] as $cm) {
|
|
// Skip modules such as label which do not actually have links;
|
|
// this means there's nothing to participate in
|
|
if (!$cm->has_view()) {
|
|
continue;
|
|
}
|
|
$instances[$cm->id] = format_string($cm->name);
|
|
}
|
|
if (count($instances) == 0) {
|
|
continue;
|
|
}
|
|
$instanceoptions[] = array(get_string('modulenameplural', $module->name)=>$instances);
|
|
}
|
|
|
|
$timeoptions = array();
|
|
// get minimum log time for this course
|
|
$minlog = $DB->get_field_sql('SELECT min(time) FROM {log} WHERE course = ?', array($course->id));
|
|
|
|
$now = usergetmidnight(time());
|
|
|
|
// days
|
|
for ($i = 1; $i < 7; $i++) {
|
|
if (strtotime('-'.$i.' days',$now) >= $minlog) {
|
|
$timeoptions[strtotime('-'.$i.' days',$now)] = get_string('numdays','moodle',$i);
|
|
}
|
|
}
|
|
// weeks
|
|
for ($i = 1; $i < 10; $i++) {
|
|
if (strtotime('-'.$i.' weeks',$now) >= $minlog) {
|
|
$timeoptions[strtotime('-'.$i.' weeks',$now)] = get_string('numweeks','moodle',$i);
|
|
}
|
|
}
|
|
// months
|
|
for ($i = 2; $i < 12; $i++) {
|
|
if (strtotime('-'.$i.' months',$now) >= $minlog) {
|
|
$timeoptions[strtotime('-'.$i.' months',$now)] = get_string('nummonths','moodle',$i);
|
|
}
|
|
}
|
|
// try a year
|
|
if (strtotime('-1 year',$now) >= $minlog) {
|
|
$timeoptions[strtotime('-1 year',$now)] = get_string('lastyear');
|
|
}
|
|
|
|
// TODO: we need a new list of roles that are visible here
|
|
$roles = get_roles_used_in_context($context);
|
|
$guestrole = get_guest_role();
|
|
$roles[$guestrole->id] = $guestrole;
|
|
$roleoptions = role_fix_names($roles, $context, ROLENAME_ALIAS, true);
|
|
|
|
// print first controls.
|
|
echo '<form class="participationselectform" action="index.php" method="get"><div>'."\n".
|
|
'<input type="hidden" name="id" value="'.$course->id.'" />'."\n";
|
|
echo '<label for="menuinstanceid">'.get_string('activitymodule').'</label>'."\n";
|
|
echo html_writer::select($instanceoptions, 'instanceid', $instanceid);
|
|
echo '<label for="menutimefrom">'.get_string('lookback').'</label>'."\n";
|
|
echo html_writer::select($timeoptions,'timefrom',$timefrom);
|
|
echo '<label for="menuroleid">'.get_string('showonly').'</label>'."\n";
|
|
echo html_writer::select($roleoptions,'roleid',$roleid,false);
|
|
echo '<label for="menuaction">'.get_string('showactions').'</label>'."\n";
|
|
echo html_writer::select($actionoptions,'action',$action,false);
|
|
echo '<input type="submit" value="'.get_string('go').'" />'."\n</div></form>\n";
|
|
|
|
$baseurl = $CFG->wwwroot.'/report/participation/index.php?id='.$course->id.'&roleid='
|
|
.$roleid.'&instanceid='.$instanceid.'&timefrom='.$timefrom.'&action='.$action.'&perpage='.$perpage;
|
|
$select = groups_allgroups_course_menu($course, $baseurl, true, $currentgroup);
|
|
|
|
// User cannot see any group.
|
|
if (empty($select)) {
|
|
echo $OUTPUT->heading(get_string("notingroup"));
|
|
echo $OUTPUT->footer();
|
|
exit;
|
|
} else {
|
|
echo $select;
|
|
}
|
|
|
|
// Fetch current active group.
|
|
$groupmode = groups_get_course_groupmode($course);
|
|
$currentgroup = $SESSION->activegroup[$course->id][$groupmode][$course->defaultgroupingid];
|
|
|
|
if (!empty($instanceid) && !empty($roleid)) {
|
|
// from here assume we have at least the module we're using.
|
|
$cm = $modinfo->cms[$instanceid];
|
|
|
|
// Group security checks.
|
|
if (!groups_group_visible($currentgroup, $course, $cm)) {
|
|
echo $OUTPUT->heading(get_string("notingroup"));
|
|
echo $OUTPUT->footer();
|
|
exit;
|
|
}
|
|
|
|
$modulename = get_string('modulename', $cm->modname);
|
|
|
|
include_once($CFG->dirroot.'/mod/'.$cm->modname.'/lib.php');
|
|
|
|
$viewfun = $cm->modname.'_get_view_actions';
|
|
$postfun = $cm->modname.'_get_post_actions';
|
|
|
|
if (!function_exists($viewfun) || !function_exists($postfun)) {
|
|
print_error('modulemissingcode', 'error', $baseurl, $cm->modname);
|
|
}
|
|
|
|
$viewnames = $viewfun();
|
|
$postnames = $postfun();
|
|
|
|
$table = new flexible_table('course-participation-'.$course->id.'-'.$cm->id.'-'.$roleid);
|
|
$table->course = $course;
|
|
|
|
$table->define_columns(array('fullname','count','select'));
|
|
$table->define_headers(array(get_string('user'),((!empty($action)) ? get_string($action) : get_string('allactions')),get_string('select')));
|
|
$table->define_baseurl($baseurl);
|
|
|
|
$table->set_attribute('cellpadding','5');
|
|
$table->set_attribute('class', 'generaltable generalbox reporttable');
|
|
|
|
$table->sortable(true,'lastname','ASC');
|
|
$table->no_sorting('select');
|
|
|
|
$table->set_control_variables(array(
|
|
TABLE_VAR_SORT => 'ssort',
|
|
TABLE_VAR_HIDE => 'shide',
|
|
TABLE_VAR_SHOW => 'sshow',
|
|
TABLE_VAR_IFIRST => 'sifirst',
|
|
TABLE_VAR_ILAST => 'silast',
|
|
TABLE_VAR_PAGE => 'spage'
|
|
));
|
|
$table->setup();
|
|
|
|
switch ($action) {
|
|
case 'view':
|
|
$actions = $viewnames;
|
|
break;
|
|
case 'post':
|
|
$actions = $postnames;
|
|
break;
|
|
default:
|
|
// some modules have stuff we want to hide, ie mail blocked etc so do actually need to limit here.
|
|
$actions = array_merge($viewnames, $postnames);
|
|
}
|
|
|
|
list($actionsql, $params) = $DB->get_in_or_equal($actions, SQL_PARAMS_NAMED, 'action');
|
|
$actionsql = "action $actionsql";
|
|
|
|
// We want to query both the current context and parent contexts.
|
|
list($relatedctxsql, $relatedctxparams) = $DB->get_in_or_equal($context->get_parent_context_ids(true), SQL_PARAMS_NAMED, 'relatedctx');
|
|
|
|
$groupsql = "";
|
|
if (!empty($currentgroup)) {
|
|
$groupsql = "JOIN {groups_members} gm ON (gm.userid = u.id AND gm.groupid = :groupid)";
|
|
$params['groupid'] = $currentgroup;
|
|
}
|
|
$usernamefields = get_all_user_name_fields(true, 'u');
|
|
$sql = "SELECT ra.userid, $usernamefields, u.idnumber, l.actioncount AS count
|
|
FROM (SELECT * FROM {role_assignments} WHERE contextid $relatedctxsql AND roleid = :roleid ) ra
|
|
JOIN {user} u ON u.id = ra.userid
|
|
$groupsql
|
|
LEFT JOIN (
|
|
SELECT userid, COUNT(action) AS actioncount FROM {log} WHERE cmid = :instanceid AND time > :timefrom AND $actionsql GROUP BY userid
|
|
) l ON (l.userid = ra.userid)";
|
|
$params = array_merge($params, $relatedctxparams);
|
|
$params['roleid'] = $roleid;
|
|
$params['instanceid'] = $instanceid;
|
|
$params['timefrom'] = $timefrom;
|
|
|
|
list($twhere, $tparams) = $table->get_sql_where();
|
|
if ($twhere) {
|
|
$sql .= ' WHERE '.$twhere; //initial bar
|
|
$params = array_merge($params, $tparams);
|
|
}
|
|
|
|
if ($table->get_sql_sort()) {
|
|
$sql .= ' ORDER BY '.$table->get_sql_sort();
|
|
}
|
|
|
|
$countsql = "SELECT COUNT(DISTINCT(ra.userid))
|
|
FROM {role_assignments} ra
|
|
JOIN {user} u ON u.id = ra.userid
|
|
$groupsql
|
|
WHERE ra.contextid $relatedctxsql AND ra.roleid = :roleid";
|
|
|
|
$totalcount = $DB->count_records_sql($countsql, $params);
|
|
|
|
if ($twhere) {
|
|
$matchcount = $DB->count_records_sql($countsql.' AND '.$twhere, $params);
|
|
} else {
|
|
$matchcount = $totalcount;
|
|
}
|
|
|
|
echo '<div id="participationreport">' . "\n";
|
|
echo '<p class="modulename">'.$modulename . ' ' . $strviews.': '.implode(', ',$viewnames).'<br />'."\n"
|
|
. $modulename . ' ' . $strposts.': '.implode(', ',$postnames).'</p>'."\n";
|
|
|
|
$table->initialbars($totalcount > $perpage);
|
|
$table->pagesize($perpage, $matchcount);
|
|
|
|
if (!$users = $DB->get_records_sql($sql, $params, $table->get_page_start(), $table->get_page_size())) {
|
|
$users = array(); // tablelib will handle saying 'Nothing to display' for us.
|
|
}
|
|
|
|
$data = array();
|
|
|
|
$a = new stdClass();
|
|
$a->count = $totalcount;
|
|
$a->items = $role->name;
|
|
|
|
if ($matchcount != $totalcount) {
|
|
$a->count = $matchcount.'/'.$a->count;
|
|
}
|
|
|
|
echo '<h2>'.get_string('counteditems', '', $a).'</h2>'."\n";
|
|
|
|
echo '<form action="'.$CFG->wwwroot.'/user/action_redir.php" method="post" id="studentsform">'."\n";
|
|
echo '<div>'."\n";
|
|
echo '<input type="hidden" name="id" value="'.$id.'" />'."\n";
|
|
echo '<input type="hidden" name="returnto" value="'. s($PAGE->url) .'" />'."\n";
|
|
echo '<input type="hidden" name="sesskey" value="'.sesskey().'" />'."\n";
|
|
|
|
foreach ($users as $u) {
|
|
$data = array('<a href="'.$CFG->wwwroot.'/user/view.php?id='.$u->userid.'&course='.$course->id.'">'.fullname($u,true).'</a>'."\n",
|
|
((!empty($u->count)) ? get_string('yes').' ('.$u->count.') ' : get_string('no')),
|
|
'<input type="checkbox" class="usercheckbox" name="user'.$u->userid.'" value="'.$u->count.'" />'."\n",
|
|
);
|
|
$table->add_data($data);
|
|
}
|
|
|
|
$table->print_html();
|
|
|
|
if ($perpage == SHOW_ALL_PAGE_SIZE) {
|
|
echo '<div id="showall"><a href="'.$baseurl.'&perpage='.DEFAULT_PAGE_SIZE.'">'.get_string('showperpage', '', DEFAULT_PAGE_SIZE).'</a></div>'."\n";
|
|
}
|
|
else if ($matchcount > 0 && $perpage < $matchcount) {
|
|
echo '<div id="showall"><a href="'.$baseurl.'&perpage='.SHOW_ALL_PAGE_SIZE.'">'.get_string('showall', '', $matchcount).'</a></div>'."\n";
|
|
}
|
|
|
|
echo '<div class="selectbuttons">';
|
|
echo '<input type="button" id="checkall" value="'.get_string('selectall').'" /> '."\n";
|
|
echo '<input type="button" id="checknone" value="'.get_string('deselectall').'" /> '."\n";
|
|
if ($perpage >= $matchcount) {
|
|
echo '<input type="button" id="checknos" value="'.get_string('selectnos').'" />'."\n";
|
|
}
|
|
echo '</div>';
|
|
echo '<div>';
|
|
echo html_writer::label(get_string('withselectedusers'), 'formactionselect');
|
|
$displaylist['messageselect.php'] = get_string('messageselectadd');
|
|
echo html_writer::select($displaylist, 'formaction', '', array(''=>'choosedots'), array('id'=>'formactionselect'));
|
|
echo $OUTPUT->help_icon('withselectedusers');
|
|
echo '<input type="submit" value="' . get_string('ok') . '" />'."\n";
|
|
echo '</div>';
|
|
echo '</div>'."\n";
|
|
echo '</form>'."\n";
|
|
echo '</div>'."\n";
|
|
|
|
$PAGE->requires->js_init_call('M.report_participation.init');
|
|
}
|
|
|
|
echo $OUTPUT->footer();
|
|
|
|
|