MDL-47052 report_participation: fixed bug when filtering by first letter
[moodle.git] / report / participation / index.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
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.
8 //
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.
13 //
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/>.
17 /**
18  * Participation report
19  *
20  * @package    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
24  */
26 require('../../config.php');
27 require_once($CFG->dirroot.'/lib/tablelib.php');
28 require_once($CFG->dirroot.'/report/participation/locallib.php');
30 define('DEFAULT_PAGE_SIZE', 20);
31 define('SHOW_ALL_PAGE_SIZE', 5000);
33 $id         = required_param('id', PARAM_INT); // course id.
34 $roleid     = optional_param('roleid', 0, PARAM_INT); // which role to show
35 $instanceid = optional_param('instanceid', 0, PARAM_INT); // instance we're looking at.
36 $timefrom   = optional_param('timefrom', 0, PARAM_INT); // how far back to look...
37 $action     = optional_param('action', '', PARAM_ALPHA);
38 $page       = optional_param('page', 0, PARAM_INT);                     // which page to show
39 $perpage    = optional_param('perpage', DEFAULT_PAGE_SIZE, PARAM_INT);  // how many per page
40 $currentgroup = optional_param('group', 0, PARAM_INT); // Get the active group.
42 $url = new moodle_url('/report/participation/index.php', array('id'=>$id));
43 if ($roleid !== 0) $url->param('roleid');
44 if ($instanceid !== 0) $url->param('instanceid');
45 if ($timefrom !== 0) $url->param('timefrom');
46 if ($action !== '') $url->param('action');
47 if ($page !== 0) $url->param('page');
48 if ($perpage !== DEFAULT_PAGE_SIZE) $url->param('perpage');
49 $PAGE->set_url($url);
50 $PAGE->set_pagelayout('admin');
52 if ($action != 'view' and $action != 'post') {
53     $action = ''; // default to all (don't restrict)
54 }
56 if (!$course = $DB->get_record('course', array('id'=>$id))) {
57     print_error('invalidcourse');
58 }
60 if ($roleid != 0 and !$role = $DB->get_record('role', array('id'=>$roleid))) {
61     print_error('invalidrole');
62 }
64 require_login($course);
65 $context = context_course::instance($course->id);
66 require_capability('report/participation:view', $context);
68 $strparticipation = get_string('participationreport');
69 $strviews         = get_string('views');
70 $strposts         = get_string('posts');
71 $strreports       = get_string('reports');
73 $actionoptions = report_participation_get_action_options();
74 if (!array_key_exists($action, $actionoptions)) {
75     $action = '';
76 }
78 $PAGE->set_title($course->shortname .': '. $strparticipation);
79 $PAGE->set_heading($course->fullname);
80 echo $OUTPUT->header();
82 $uselegacyreader = false; // Use legacy reader with sql_internal_reader to aggregate records.
83 $onlyuselegacyreader = false; // Use only legacy log table to aggregate records.
85 $logtable = report_participation_get_log_table_name(); // Log table to use for fetaching records.
87 // If no log table, then use legacy records.
88 if (empty($logtable)) {
89     $onlyuselegacyreader = true;
90 }
92 // If no legacy and no logtable then don't proceed.
93 if (!$onlyuselegacyreader && empty($logtable)) {
94     echo $OUTPUT->box_start('generalbox', 'notice');
95     echo get_string('nologreaderenabled', 'report_participation');
96     echo $OUTPUT->box_end();
97     echo $OUTPUT->footer();
98     die();
99 }
101 $modinfo = get_fast_modinfo($course);
103 $minloginternalreader = 0; // Time of first record in sql_internal_reader.
105 if ($onlyuselegacyreader) {
106     // If no sql_inrenal_reader enabled then get min. time from log table.
107     $minlog = $DB->get_field_sql('SELECT min(time) FROM {log} WHERE course = ?', array($course->id));
108 } else {
109     $uselegacyreader = true;
110     $minlog = $DB->get_field_sql('SELECT min(time) FROM {log} WHERE course = ?', array($course->id));
112     // If legacy reader is not logging then get data from new log table.
113     // Get minimum log time for this course from preferred log reader.
114     $minloginternalreader = $DB->get_field_sql('SELECT min(timecreated) FROM {' . $logtable . '}
115                                                  WHERE courseid = ?', array($course->id));
116     // If new log store has oldest data then don't use old log table.
117     if (empty($minlog) || ($minloginternalreader <= $minlog)) {
118         $uselegacyreader = false;
119         $minlog = $minloginternalreader;
120     } else if (!empty($timefrom) && ($minloginternalreader > $timefrom)) {
121         // If timefrom is less then first record in sql_internal_reader then get record from legacy log only.
122         $onlyuselegacyreader = true;
123     }
126 // Print first controls.
127 report_participation_print_filter_form($course, $timefrom, $minlog, $action, $roleid, $instanceid);
129 $baseurl =  $CFG->wwwroot.'/report/participation/index.php?id='.$course->id.'&amp;roleid='
130     .$roleid.'&amp;instanceid='.$instanceid.'&amp;timefrom='.$timefrom.'&amp;action='.$action.'&amp;perpage='.$perpage;
131 $select = groups_allgroups_course_menu($course, $baseurl, true, $currentgroup);
133 // User cannot see any group.
134 if (empty($select)) {
135     echo $OUTPUT->heading(get_string("notingroup"));
136     echo $OUTPUT->footer();
137     exit;
138 } else {
139     echo $select;
142 // Fetch current active group.
143 $groupmode = groups_get_course_groupmode($course);
144 $currentgroup = $SESSION->activegroup[$course->id][$groupmode][$course->defaultgroupingid];
146 if (!empty($instanceid) && !empty($roleid)) {
148     // Trigger a report viewed event.
149     $event = \report_participation\event\report_viewed::create(array('context' => $context,
150             'other' => array('instanceid' => $instanceid, 'groupid' => $currentgroup, 'roleid' => $roleid,
151             'timefrom' => $timefrom, 'action' => $action)));
152     $event->trigger();
154     // from here assume we have at least the module we're using.
155     $cm = $modinfo->cms[$instanceid];
157     // Group security checks.
158     if (!groups_group_visible($currentgroup, $course, $cm)) {
159         echo $OUTPUT->heading(get_string("notingroup"));
160         echo $OUTPUT->footer();
161         exit;
162     }
164     $table = new flexible_table('course-participation-'.$course->id.'-'.$cm->id.'-'.$roleid);
165     $table->course = $course;
167     $table->define_columns(array('fullname','count','select'));
168     $table->define_headers(array(get_string('user'),((!empty($action)) ? get_string($action) : get_string('allactions')),get_string('select')));
169     $table->define_baseurl($baseurl);
171     $table->set_attribute('cellpadding','5');
172     $table->set_attribute('class', 'generaltable generalbox reporttable');
174     $table->sortable(true,'lastname','ASC');
175     $table->no_sorting('select');
177     $table->set_control_variables(array(
178                                         TABLE_VAR_SORT    => 'ssort',
179                                         TABLE_VAR_HIDE    => 'shide',
180                                         TABLE_VAR_SHOW    => 'sshow',
181                                         TABLE_VAR_IFIRST  => 'sifirst',
182                                         TABLE_VAR_ILAST   => 'silast',
183                                         TABLE_VAR_PAGE    => 'spage'
184                                         ));
185     $table->setup();
187     // We want to query both the current context and parent contexts.
188     list($relatedctxsql, $params) = $DB->get_in_or_equal($context->get_parent_context_ids(true), SQL_PARAMS_NAMED, 'relatedctx');
189     $params['roleid'] = $roleid;
190     $params['instanceid'] = $instanceid;
191     $params['timefrom'] = $timefrom;
193     $groupsql = "";
194     if (!empty($currentgroup)) {
195         $groupsql = "JOIN {groups_members} gm ON (gm.userid = u.id AND gm.groupid = :groupid)";
196         $params['groupid'] = $currentgroup;
197     }
199     $countsql = "SELECT COUNT(DISTINCT(ra.userid))
200                    FROM {role_assignments} ra
201                    JOIN {user} u ON u.id = ra.userid
202                    $groupsql
203                   WHERE ra.contextid $relatedctxsql AND ra.roleid = :roleid";
205     $totalcount = $DB->count_records_sql($countsql, $params);
207     list($twhere, $tparams) = $table->get_sql_where();
208     if ($twhere) {
209         $params = array_merge($params, $tparams);
210         $matchcount = $DB->count_records_sql($countsql.' AND '.$twhere, $params);
211     } else {
212         $matchcount = $totalcount;
213     }
215     $modulename = get_string('modulename', $cm->modname);
216     echo '<div id="participationreport">' . "\n";
217     echo '<p class="modulename">' . $modulename . ' ' . $strviews . '<br />'."\n"
218         . $modulename . ' ' . $strposts . '</p>'."\n";
220     $table->initialbars($totalcount > $perpage);
221     $table->pagesize($perpage, $matchcount);
223     if ($uselegacyreader || $onlyuselegacyreader) {
224         list($actionsql, $actionparams) = report_participation_get_action_sql($action, $cm->modname);
225         $params = array_merge($params, $actionparams);
226     }
228     if (!$onlyuselegacyreader) {
229         list($crudsql, $crudparams) = report_participation_get_crud_sql($action);
230         $params = array_merge($params, $crudparams);
231     }
233     $usernamefields = get_all_user_name_fields(true, 'u');
234     $users = array();
235     // If using legacy log then get users from old table.
236     if ($uselegacyreader || $onlyuselegacyreader) {
237         $limittime = '';
238         if ($uselegacyreader && !empty($minloginternalreader)) {
239             $limittime = ' AND time < :tilltime ';
240             $params['tilltime'] = $minloginternalreader;
241         }
242         $sql = "SELECT ra.userid, $usernamefields, u.idnumber, l.actioncount AS count
243                   FROM (SELECT DISTINCT userid FROM {role_assignments} WHERE contextid $relatedctxsql AND roleid = :roleid ) ra
244                   JOIN {user} u ON u.id = ra.userid
245              $groupsql
246              LEFT JOIN (
247                     SELECT userid, COUNT(action) AS actioncount
248                       FROM {log}
249                      WHERE cmid = :instanceid
250                            AND time > :timefrom " . $limittime . $actionsql .
251                 " GROUP BY userid) l ON (l.userid = ra.userid)";
252         if ($twhere) {
253             $sql .= ' WHERE '.$twhere; // Initial bar.
254         }
256         if ($table->get_sql_sort()) {
257             $sql .= ' ORDER BY '.$table->get_sql_sort();
258         }
259         if (!$users = $DB->get_records_sql($sql, $params, $table->get_page_start(), $table->get_page_size())) {
260             $users = array(); // Tablelib will handle saying 'Nothing to display' for us.
261         }
262     }
264     // Get record from sql_internal_reader and merge with records got from legacy log (if needed).
265     if (!$onlyuselegacyreader) {
266         $sql = "SELECT ra.userid, $usernamefields, u.idnumber, l.actioncount AS count
267                   FROM (SELECT DISTINCT userid FROM {role_assignments} WHERE contextid $relatedctxsql AND roleid = :roleid ) ra
268                   JOIN {user} u ON u.id = ra.userid
269              $groupsql
270              LEFT JOIN (
271                     SELECT userid, COUNT(crud) AS actioncount
272                       FROM {" . $logtable . "}
273                      WHERE contextinstanceid = :instanceid
274                        AND timecreated > :timefrom" . $crudsql ."
275                        AND edulevel = :edulevel
276                        AND anonymous = 0
277                        AND contextlevel = :contextlevel
278                        AND (origin = 'web' OR origin = 'ws')
279                   GROUP BY userid) l ON (l.userid = ra.userid)";
281         $params['edulevel'] = core\event\base::LEVEL_PARTICIPATING;
282         $params['contextlevel'] = CONTEXT_MODULE;
284         if ($twhere) {
285             $sql .= ' WHERE '.$twhere; // Initial bar.
286         }
288         if ($table->get_sql_sort()) {
289             $sql .= ' ORDER BY '.$table->get_sql_sort();
290         }
291         if ($u = $DB->get_records_sql($sql, $params, $table->get_page_start(), $table->get_page_size())) {
292             if (empty($users)) {
293                 $users = $u;
294             } else {
295                 // Merge two users array.
296                 foreach ($u as $key => $value) {
297                     if (isset($users[$key]) && !empty($users[$key]->count)) {
298                         if ($value->count) {
299                             $users[$key]->count += $value->count;
300                         }
301                     } else {
302                         $users[$key] = $value;
303                     }
304                 }
305             }
306             unset($u);
307             $u = null;
308         }
309     }
311     $data = array();
313     $a = new stdClass();
314     $a->count = $totalcount;
315     $a->items = $role->name;
317     if ($matchcount != $totalcount) {
318         $a->count = $matchcount.'/'.$a->count;
319     }
321     echo '<h2>'.get_string('counteditems', '', $a).'</h2>'."\n";
323     echo '<form action="'.$CFG->wwwroot.'/user/action_redir.php" method="post" id="studentsform">'."\n";
324     echo '<div>'."\n";
325     echo '<input type="hidden" name="id" value="'.$id.'" />'."\n";
326     echo '<input type="hidden" name="returnto" value="'. s($PAGE->url) .'" />'."\n";
327     echo '<input type="hidden" name="sesskey" value="'.sesskey().'" />'."\n";
329     foreach ($users as $u) {
330         $data = array('<a href="'.$CFG->wwwroot.'/user/view.php?id='.$u->userid.'&amp;course='.$course->id.'">'.fullname($u,true).'</a>'."\n",
331                       ((!empty($u->count)) ? get_string('yes').' ('.$u->count.') ' : get_string('no')),
332                       '<input type="checkbox" class="usercheckbox" name="user'.$u->userid.'" value="'.$u->count.'" />'."\n",
333                       );
334         $table->add_data($data);
335     }
337     $table->print_html();
339     if ($perpage == SHOW_ALL_PAGE_SIZE) {
340         echo '<div id="showall"><a href="'.$baseurl.'&amp;perpage='.DEFAULT_PAGE_SIZE.'">'.get_string('showperpage', '', DEFAULT_PAGE_SIZE).'</a></div>'."\n";
341     }
342     else if ($matchcount > 0 && $perpage < $matchcount) {
343         echo '<div id="showall"><a href="'.$baseurl.'&amp;perpage='.SHOW_ALL_PAGE_SIZE.'">'.get_string('showall', '', $matchcount).'</a></div>'."\n";
344     }
346     echo '<div class="selectbuttons">';
347     echo '<input type="button" id="checkall" value="'.get_string('selectall').'" /> '."\n";
348     echo '<input type="button" id="checknone" value="'.get_string('deselectall').'" /> '."\n";
349     if ($perpage >= $matchcount) {
350         echo '<input type="button" id="checknos" value="'.get_string('selectnos').'" />'."\n";
351     }
352     echo '</div>';
353     echo '<div>';
354     echo html_writer::label(get_string('withselectedusers'), 'formactionselect');
355     $displaylist['messageselect.php'] = get_string('messageselectadd');
356     echo html_writer::select($displaylist, 'formaction', '', array(''=>'choosedots'), array('id'=>'formactionselect'));
357     echo $OUTPUT->help_icon('withselectedusers');
358     echo '<input type="submit" value="' . get_string('ok') . '" />'."\n";
359     echo '</div>';
360     echo '</div>'."\n";
361     echo '</form>'."\n";
362     echo '</div>'."\n";
364     $PAGE->requires->js_init_call('M.report_participation.init');
367 echo $OUTPUT->footer();