2 // This file is part of Moodle - http://moodle.org/
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 // GNU General Public License for more details.
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle. If not, see <http://www.gnu.org/licenses/>.
18 * Participation report
21 * @subpackage participation
22 * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
23 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26 use core\report_helper
;
28 require('../../config.php');
29 require_once($CFG->dirroot
.'/lib/tablelib.php');
30 require_once($CFG->dirroot
.'/notes/lib.php');
31 require_once($CFG->dirroot
.'/report/participation/locallib.php');
33 $participantsperpage = intval(get_config('moodlecourse', 'participantsperpage'));
34 define('DEFAULT_PAGE_SIZE', (!empty($participantsperpage) ?
$participantsperpage : 20));
35 define('SHOW_ALL_PAGE_SIZE', 5000);
37 $id = required_param('id', PARAM_INT
); // course id.
38 $roleid = optional_param('roleid', 0, PARAM_INT
); // which role to show
39 $instanceid = optional_param('instanceid', 0, PARAM_INT
); // instance we're looking at.
40 $timefrom = optional_param('timefrom', 0, PARAM_INT
); // how far back to look...
41 $action = optional_param('action', '', PARAM_ALPHA
);
42 $page = optional_param('page', 0, PARAM_INT
); // which page to show
43 $perpage = optional_param('perpage', DEFAULT_PAGE_SIZE
, PARAM_INT
); // how many per page
44 $currentgroup = optional_param('group', null, PARAM_INT
); // Get the active group.
46 $url = new moodle_url('/report/participation/index.php', array('id'=>$id));
47 if ($roleid !== 0) $url->param('roleid');
48 if ($instanceid !== 0) $url->param('instanceid');
49 if ($timefrom !== 0) $url->param('timefrom');
50 if ($action !== '') $url->param('action');
51 if ($page !== 0) $url->param('page');
52 if ($perpage !== DEFAULT_PAGE_SIZE
) $url->param('perpage');
54 $PAGE->set_pagelayout('admin');
56 if ($action != 'view' and $action != 'post') {
57 $action = ''; // default to all (don't restrict)
60 if (!$course = $DB->get_record('course', array('id'=>$id))) {
61 print_error('invalidcourse');
64 if ($roleid != 0 and !$role = $DB->get_record('role', array('id'=>$roleid))) {
65 print_error('invalidrole');
68 require_login($course);
69 $context = context_course
::instance($course->id
);
70 require_capability('report/participation:view', $context);
72 $strparticipation = get_string('participationreport');
73 $strviews = get_string('views');
74 $strposts = get_string('posts');
75 $strreports = get_string('reports');
77 $actionoptions = report_participation_get_action_options();
78 if (!array_key_exists($action, $actionoptions)) {
82 $PAGE->set_title(format_string($course->shortname
, true, array('context' => $context)) .': '. $strparticipation);
83 $PAGE->set_heading(format_string($course->fullname
, true, array('context' => $context)));
84 echo $OUTPUT->header();
86 // Print the selector dropdown.
87 $pluginname = get_string('pluginname', 'report_participation');
88 report_helper
::print_report_selector($pluginname);
89 // Release session lock.
90 \core\session\manager
::write_close();
92 // Logs will not have been recorded before the course timecreated time.
93 $minlog = $course->timecreated
;
94 $onlyuselegacyreader = false; // Use only legacy log table to aggregate records.
96 $logtable = report_participation_get_log_table_name(); // Log table to use for fetaching records.
98 // If no log table, then use legacy records.
99 if (empty($logtable)) {
100 $onlyuselegacyreader = true;
103 $modinfo = get_fast_modinfo($course);
105 // Print first controls.
106 report_participation_print_filter_form($course, $timefrom, $minlog, $action, $roleid, $instanceid);
108 $baseurl = new moodle_url('/report/participation/index.php', array(
111 'instanceid' => $instanceid,
112 'timefrom' => $timefrom,
114 'perpage' => $perpage,
115 'group' => $currentgroup
117 $select = groups_allgroups_course_menu($course, $baseurl, true, $currentgroup);
119 // User cannot see any group.
120 if (empty($select)) {
121 echo $OUTPUT->heading(get_string("notingroup"));
122 echo $OUTPUT->footer();
128 // Fetch current active group.
129 $groupmode = groups_get_course_groupmode($course);
130 $currentgroup = $SESSION->activegroup
[$course->id
][$groupmode][$course->defaultgroupingid
];
132 if (!empty($instanceid) && !empty($roleid)) {
133 $uselegacyreader = $DB->record_exists('log', ['course' => $course->id
]);
135 // Trigger a report viewed event.
136 $event = \report_participation\event\report_viewed
::create(array('context' => $context,
137 'other' => array('instanceid' => $instanceid, 'groupid' => $currentgroup, 'roleid' => $roleid,
138 'timefrom' => $timefrom, 'action' => $action)));
141 // from here assume we have at least the module we're using.
142 $cm = $modinfo->cms
[$instanceid];
144 // Group security checks.
145 if (!groups_group_visible($currentgroup, $course, $cm)) {
146 echo $OUTPUT->heading(get_string("notingroup"));
147 echo $OUTPUT->footer();
151 $table = new flexible_table('course-participation-'.$course->id
.'-'.$cm->id
.'-'.$roleid);
152 $table->course
= $course;
154 $actionheader = !empty($action) ?
get_string($action) : get_string('allactions');
156 if (empty($CFG->messaging
)) {
157 $table->define_columns(array('fullname', 'count'));
158 $table->define_headers(array(get_string('user'), $actionheader));
160 $table->define_columns(array('fullname', 'count', 'select'));
161 $mastercheckbox = new \core\output\
checkbox_toggleall('participants-table', true, [
162 'id' => 'select-all-participants',
163 'name' => 'select-all-participants',
164 'label' => get_string('select'),
165 // Consistent labels to prevent select column from resizing.
166 'selectall' => get_string('select'),
167 'deselectall' => get_string('select'),
169 $table->define_headers(array(get_string('user'), $actionheader, $OUTPUT->render($mastercheckbox)));
171 $table->define_baseurl($baseurl);
173 $table->set_attribute('class', 'generaltable generalbox reporttable');
175 $table->sortable(true,'lastname','ASC');
176 $table->no_sorting('select');
178 $table->set_control_variables(array(
179 TABLE_VAR_SORT
=> 'ssort',
180 TABLE_VAR_HIDE
=> 'shide',
181 TABLE_VAR_SHOW
=> 'sshow',
182 TABLE_VAR_IFIRST
=> 'sifirst',
183 TABLE_VAR_ILAST
=> 'silast',
184 TABLE_VAR_PAGE
=> 'spage'
188 // We want to query both the current context and parent contexts.
189 list($relatedctxsql, $params) = $DB->get_in_or_equal($context->get_parent_context_ids(true), SQL_PARAMS_NAMED
, 'relatedctx');
190 $params['roleid'] = $roleid;
191 $params['instanceid'] = $instanceid;
192 $params['timefrom'] = $timefrom;
195 if (!empty($currentgroup)) {
196 $groupsql = "JOIN {groups_members} gm ON (gm.userid = u.id AND gm.groupid = :groupid)";
197 $params['groupid'] = $currentgroup;
200 $countsql = "SELECT COUNT(DISTINCT(ra.userid))
201 FROM {role_assignments} ra
202 JOIN {user} u ON u.id = ra.userid
204 WHERE ra.contextid $relatedctxsql AND ra.roleid = :roleid";
206 $totalcount = $DB->count_records_sql($countsql, $params);
208 list($twhere, $tparams) = $table->get_sql_where();
210 $params = array_merge($params, $tparams);
211 $matchcount = $DB->count_records_sql($countsql.' AND '.$twhere, $params);
213 $matchcount = $totalcount;
216 $modulename = get_string('modulename', $cm->modname
);
217 echo '<div id="participationreport">' . "\n";
218 echo '<p class="modulename">' . $modulename . ' ' . $strviews . '<br />'."\n"
219 . $modulename . ' ' . $strposts . '</p>'."\n";
221 $table->initialbars($totalcount > $perpage);
222 $table->pagesize($perpage, $matchcount);
224 if ($uselegacyreader ||
$onlyuselegacyreader) {
225 list($actionsql, $actionparams) = report_participation_get_action_sql($action, $cm->modname
);
226 $params = array_merge($params, $actionparams);
229 if (!$onlyuselegacyreader) {
230 list($crudsql, $crudparams) = report_participation_get_crud_sql($action);
231 $params = array_merge($params, $crudparams);
234 $userfieldsapi = \core_user\fields
::for_name();
235 $usernamefields = $userfieldsapi->get_sql('u', false, '', '', false)->selects
;
237 // If using legacy log then get users from old table.
238 if ($uselegacyreader ||
$onlyuselegacyreader) {
239 $sql = "SELECT ra.userid, $usernamefields, u.idnumber, l.actioncount AS count
240 FROM (SELECT DISTINCT userid FROM {role_assignments} WHERE contextid $relatedctxsql AND roleid = :roleid ) ra
241 JOIN {user} u ON u.id = ra.userid
244 SELECT userid, COUNT(action) AS actioncount
246 WHERE cmid = :instanceid
247 AND time > :timefrom " . $actionsql .
248 " GROUP BY userid) l ON (l.userid = ra.userid)";
250 $sql .= ' WHERE '.$twhere; // Initial bar.
253 if ($table->get_sql_sort()) {
254 $sql .= ' ORDER BY '.$table->get_sql_sort();
256 if (!$users = $DB->get_records_sql($sql, $params, $table->get_page_start(), $table->get_page_size())) {
257 $users = array(); // Tablelib will handle saying 'Nothing to display' for us.
261 // Get record from sql_internal_table_reader and merge with records got from legacy log (if needed).
262 if (!$onlyuselegacyreader) {
263 $sql = "SELECT ra.userid, $usernamefields, u.idnumber, COUNT(DISTINCT l.timecreated) AS count
265 JOIN {role_assignments} ra ON u.id = ra.userid AND ra.contextid $relatedctxsql AND ra.roleid = :roleid
267 LEFT JOIN {" . $logtable . "} l
268 ON l.contextinstanceid = :instanceid
269 AND l.timecreated > :timefrom" . $crudsql ."
270 AND l.edulevel = :edulevel
272 AND l.contextlevel = :contextlevel
273 AND (l.origin = 'web' OR l.origin = 'ws')
274 AND l.userid = ra.userid";
275 // We add this after the WHERE statement that may come below.
276 $groupbysql = " GROUP BY ra.userid, $usernamefields, u.idnumber";
278 $params['edulevel'] = core\event\base
::LEVEL_PARTICIPATING
;
279 $params['contextlevel'] = CONTEXT_MODULE
;
282 $sql .= ' WHERE '.$twhere; // Initial bar.
285 if ($table->get_sql_sort()) {
286 $sql .= ' ORDER BY '.$table->get_sql_sort();
288 if ($u = $DB->get_records_sql($sql, $params, $table->get_page_start(), $table->get_page_size())) {
292 // Merge two users array.
293 foreach ($u as $key => $value) {
294 if (isset($users[$key]) && !empty($users[$key]->count
)) {
296 $users[$key]->count +
= $value->count
;
299 $users[$key] = $value;
311 $a->count
= $totalcount;
312 $a->items
= format_string($role->name
, true, array('context' => $context));
314 if ($matchcount != $totalcount) {
315 $a->count
= $matchcount.'/'.$a->count
;
318 echo '<h2>'.get_string('counteditems', '', $a).'</h2>'."\n";
320 if (!empty($CFG->messaging
)) {
321 echo '<form action="'.$CFG->wwwroot
.'/user/action_redir.php" method="post" id="participantsform">'."\n";
323 echo '<input type="hidden" name="id" value="'.$id.'" />'."\n";
324 echo '<input type="hidden" name="returnto" value="'. s($PAGE->url
) .'" />'."\n";
325 echo '<input type="hidden" name="sesskey" value="'.sesskey().'" />'."\n";
328 foreach ($users as $u) {
330 $data[] = html_writer
::link(new moodle_url('/user/view.php', array('id' => $u->userid
, 'course' => $course->id
)),
332 $data[] = !empty($u->count
) ?
get_string('yes').' ('.$u->count
.') ' : get_string('no');
334 if (!empty($CFG->messaging
)) {
335 $togglegroup = 'participants-table';
336 if (empty($u->count
)) {
337 $togglegroup .= ' no';
339 $checkbox = new \core\output\
checkbox_toggleall($togglegroup, false, [
340 'classes' => 'usercheckbox',
341 'name' => 'user' . $u->userid
,
342 'value' => $u->count
,
344 $data[] = $OUTPUT->render($checkbox);
346 $table->add_data($data);
349 $table->print_html();
351 if ($perpage == SHOW_ALL_PAGE_SIZE
) {
352 $perpageurl = new moodle_url($baseurl, array('perpage' => DEFAULT_PAGE_SIZE
));
353 echo html_writer
::start_div('', array('id' => 'showall'));
354 echo html_writer
::link($perpageurl, get_string('showperpage', '', DEFAULT_PAGE_SIZE
));
355 echo html_writer
::end_div();
356 } else if ($matchcount > 0 && $perpage < $matchcount) {
357 $perpageurl = new moodle_url($baseurl, array('perpage' => SHOW_ALL_PAGE_SIZE
));
358 echo html_writer
::start_div('', array('id' => 'showall'));
359 echo html_writer
::link($perpageurl, get_string('showall', '', $matchcount));
360 echo html_writer
::end_div();
363 if (!empty($CFG->messaging
)) {
364 echo '<div class="selectbuttons btn-group">';
365 if ($perpage >= $matchcount) {
366 $checknos = new \core\output\
checkbox_toggleall('participants-table no', true, [
367 'id' => 'select-nos',
368 'name' => 'select-nos',
369 'label' => get_string('selectnos'),
370 'selectall' => get_string('selectnos'),
371 'deselectall' => get_string('deselectnos'),
373 echo $OUTPUT->render($checknos);
376 echo '<div class="py-3">';
377 echo html_writer
::label(get_string('withselectedusers'), 'formactionid');
378 $displaylist['#messageselect'] = get_string('messageselectadd');
379 $withselectedparams = array(
380 'id' => 'formactionid',
381 'data-action' => 'toggle',
382 'data-togglegroup' => 'participants-table',
383 'data-toggle' => 'action',
386 echo html_writer
::select($displaylist, 'formaction', '', array('' => 'choosedots'), $withselectedparams);
391 $options = new stdClass();
392 $options->courseid
= $course->id
;
393 $options->noteStateNames
= note_get_state_names();
394 $options->stateHelpIcon
= $OUTPUT->help_icon('publishstate', 'notes');
395 $PAGE->requires
->js_call_amd('report_participation/participants', 'init', [$options]);
400 echo $OUTPUT->footer();