MDL-63480 reports: Fix name filters in completion reports
[moodle.git] / report / progress / 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  * Activity progress reports
19  *
20  * @package    report
21  * @subpackage progress
22  * @copyright  2008 Sam Marshall
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 require('../../config.php');
27 require_once($CFG->libdir . '/completionlib.php');
29 define('COMPLETION_REPORT_PAGE', 25);
31 // Get course
32 $id = required_param('course',PARAM_INT);
33 $course = $DB->get_record('course',array('id'=>$id));
34 if (!$course) {
35     print_error('invalidcourseid');
36 }
37 $context = context_course::instance($course->id);
39 // Sort (default lastname, optionally firstname)
40 $sort = optional_param('sort','',PARAM_ALPHA);
41 $firstnamesort = $sort == 'firstname';
43 // CSV format
44 $format = optional_param('format','',PARAM_ALPHA);
45 $excel = $format == 'excelcsv';
46 $csv = $format == 'csv' || $excel;
48 // Paging
49 $start   = optional_param('start', 0, PARAM_INT);
50 $sifirst = optional_param('sifirst', 'all', PARAM_NOTAGS);
51 $silast  = optional_param('silast', 'all', PARAM_NOTAGS);
52 $start   = optional_param('start', 0, PARAM_INT);
54 // Whether to show extra user identity information
55 $extrafields = get_extra_user_fields($context);
56 $leftcols = 1 + count($extrafields);
58 function csv_quote($value) {
59     global $excel;
60     if ($excel) {
61         return core_text::convert('"'.str_replace('"',"'",$value).'"','UTF-8','UTF-16LE');
62     } else {
63         return '"'.str_replace('"',"'",$value).'"';
64     }
65 }
67 $url = new moodle_url('/report/progress/index.php', array('course'=>$id));
68 if ($sort !== '') {
69     $url->param('sort', $sort);
70 }
71 if ($format !== '') {
72     $url->param('format', $format);
73 }
74 if ($start !== 0) {
75     $url->param('start', $start);
76 }
77 if ($sifirst !== 'all') {
78     $url->param('sifirst', $sifirst);
79 }
80 if ($silast !== 'all') {
81     $url->param('silast', $silast);
82 }
83 $PAGE->set_url($url);
84 $PAGE->set_pagelayout('report');
86 require_login($course);
88 // Check basic permission
89 require_capability('report/progress:view',$context);
91 // Get group mode
92 $group = groups_get_course_group($course,true); // Supposed to verify group
93 if ($group===0 && $course->groupmode==SEPARATEGROUPS) {
94     require_capability('moodle/site:accessallgroups',$context);
95 }
97 // Get data on activities and progress of all users, and give error if we've
98 // nothing to display (no users or no activities)
99 $reportsurl = $CFG->wwwroot.'/course/report.php?id='.$course->id;
100 $completion = new completion_info($course);
101 $activities = $completion->get_activities();
103 if ($sifirst !== 'all') {
104     set_user_preference('ifirst', $sifirst);
106 if ($silast !== 'all') {
107     set_user_preference('ilast', $silast);
110 if (!empty($USER->preference['ifirst'])) {
111     $sifirst = $USER->preference['ifirst'];
112 } else {
113     $sifirst = 'all';
116 if (!empty($USER->preference['ilast'])) {
117     $silast = $USER->preference['ilast'];
118 } else {
119     $silast = 'all';
122 // Generate where clause
123 $where = array();
124 $where_params = array();
126 if ($sifirst !== 'all') {
127     $where[] = $DB->sql_like('u.firstname', ':sifirst', false, false);
128     $where_params['sifirst'] = $sifirst.'%';
131 if ($silast !== 'all') {
132     $where[] = $DB->sql_like('u.lastname', ':silast', false, false);
133     $where_params['silast'] = $silast.'%';
136 // Get user match count
137 $total = $completion->get_num_tracked_users(implode(' AND ', $where), $where_params, $group);
139 // Total user count
140 $grandtotal = $completion->get_num_tracked_users('', array(), $group);
142 // Get user data
143 $progress = array();
145 if ($total) {
146     $progress = $completion->get_progress_all(
147         implode(' AND ', $where),
148         $where_params,
149         $group,
150         $firstnamesort ? 'u.firstname ASC, u.lastname ASC' : 'u.lastname ASC, u.firstname ASC',
151         $csv ? 0 : COMPLETION_REPORT_PAGE,
152         $csv ? 0 : $start,
153         $context
154     );
157 if ($csv && $grandtotal && count($activities)>0) { // Only show CSV if there are some users/actvs
159     $shortname = format_string($course->shortname, true, array('context' => $context));
160     header('Content-Disposition: attachment; filename=progress.'.
161         preg_replace('/[^a-z0-9-]/','_',core_text::strtolower(strip_tags($shortname))).'.csv');
162     // Unicode byte-order mark for Excel
163     if ($excel) {
164         header('Content-Type: text/csv; charset=UTF-16LE');
165         print chr(0xFF).chr(0xFE);
166         $sep="\t".chr(0);
167         $line="\n".chr(0);
168     } else {
169         header('Content-Type: text/csv; charset=UTF-8');
170         $sep=",";
171         $line="\n";
172     }
173 } else {
175     // Navigation and header
176     $strreports = get_string("reports");
177     $strcompletion = get_string('activitycompletion', 'completion');
179     $PAGE->set_title($strcompletion);
180     $PAGE->set_heading($course->fullname);
181     echo $OUTPUT->header();
182     $PAGE->requires->js_call_amd('report_progress/completion_override', 'init', [fullname($USER)]);
184     // Handle groups (if enabled)
185     groups_print_course_menu($course,$CFG->wwwroot.'/report/progress/?course='.$course->id);
188 if (count($activities)==0) {
189     echo $OUTPUT->container(get_string('err_noactivities', 'completion'), 'errorbox errorboxcontent');
190     echo $OUTPUT->footer();
191     exit;
194 // If no users in this course what-so-ever
195 if (!$grandtotal) {
196     echo $OUTPUT->container(get_string('err_nousers', 'completion'), 'errorbox errorboxcontent');
197     echo $OUTPUT->footer();
198     exit;
201 // Build link for paging
202 $link = $CFG->wwwroot.'/report/progress/?course='.$course->id;
203 if (strlen($sort)) {
204     $link .= '&amp;sort='.$sort;
206 $link .= '&amp;start=';
208 $pagingbar = '';
210 // Initials bar.
211 $prefixfirst = 'sifirst';
212 $prefixlast = 'silast';
213 $pagingbar .= $OUTPUT->initials_bar($sifirst, 'firstinitial', get_string('firstname'), $prefixfirst, $url);
214 $pagingbar .= $OUTPUT->initials_bar($silast, 'lastinitial', get_string('lastname'), $prefixlast, $url);
216 // Do we need a paging bar?
217 if ($total > COMPLETION_REPORT_PAGE) {
219     // Paging bar
220     $pagingbar .= '<div class="paging">';
221     $pagingbar .= get_string('page').': ';
223     $sistrings = array();
224     if ($sifirst != 'all') {
225         $sistrings[] =  "sifirst={$sifirst}";
226     }
227     if ($silast != 'all') {
228         $sistrings[] =  "silast={$silast}";
229     }
230     $sistring = !empty($sistrings) ? '&amp;'.implode('&amp;', $sistrings) : '';
232     // Display previous link
233     if ($start > 0) {
234         $pstart = max($start - COMPLETION_REPORT_PAGE, 0);
235         $pagingbar .= "(<a class=\"previous\" href=\"{$link}{$pstart}{$sistring}\">".get_string('previous').'</a>)&nbsp;';
236     }
238     // Create page links
239     $curstart = 0;
240     $curpage = 0;
241     while ($curstart < $total) {
242         $curpage++;
244         if ($curstart == $start) {
245             $pagingbar .= '&nbsp;'.$curpage.'&nbsp;';
246         } else {
247             $pagingbar .= "&nbsp;<a href=\"{$link}{$curstart}{$sistring}\">$curpage</a>&nbsp;";
248         }
250         $curstart += COMPLETION_REPORT_PAGE;
251     }
253     // Display next link
254     $nstart = $start + COMPLETION_REPORT_PAGE;
255     if ($nstart < $total) {
256         $pagingbar .= "&nbsp;(<a class=\"next\" href=\"{$link}{$nstart}{$sistring}\">".get_string('next').'</a>)';
257     }
259     $pagingbar .= '</div>';
262 // Okay, let's draw the table of progress info,
264 // Start of table
265 if (!$csv) {
266     print '<br class="clearer"/>'; // ugh
268     print $pagingbar;
270     if (!$total) {
271         echo $OUTPUT->heading(get_string('nothingtodisplay'));
272         echo $OUTPUT->footer();
273         exit;
274     }
276     print '<div id="completion-progress-wrapper" class="no-overflow">';
277     print '<table id="completion-progress" class="generaltable flexible boxaligncenter" style="text-align:left"><thead><tr style="vertical-align:top">';
279     // User heading / sort option
280     print '<th scope="col" class="completion-sortchoice">';
282     $sistring = "&amp;silast={$silast}&amp;sifirst={$sifirst}";
284     if ($firstnamesort) {
285         print
286             get_string('firstname')." / <a href=\"./?course={$course->id}{$sistring}\">".
287             get_string('lastname').'</a>';
288     } else {
289         print "<a href=\"./?course={$course->id}&amp;sort=firstname{$sistring}\">".
290             get_string('firstname').'</a> / '.
291             get_string('lastname');
292     }
293     print '</th>';
295     // Print user identity columns
296     foreach ($extrafields as $field) {
297         echo '<th scope="col" class="completion-identifyfield">' .
298                 get_user_field_name($field) . '</th>';
299     }
300 } else {
301     foreach ($extrafields as $field) {
302         echo $sep . csv_quote(get_user_field_name($field));
303     }
306 // Activities
307 $formattedactivities = array();
308 foreach($activities as $activity) {
309     $datepassed = $activity->completionexpected && $activity->completionexpected <= time();
310     $datepassedclass = $datepassed ? 'completion-expired' : '';
312     if ($activity->completionexpected) {
313         $datetext=userdate($activity->completionexpected,get_string('strftimedate','langconfig'));
314     } else {
315         $datetext='';
316     }
318     // Some names (labels) come URL-encoded and can be very long, so shorten them
319     $displayname = format_string($activity->name, true, array('context' => $activity->context));
321     if ($csv) {
322         print $sep.csv_quote($displayname).$sep.csv_quote($datetext);
323     } else {
324         $shortenedname = shorten_text($displayname);
325         print '<th scope="col" class="completion-header '.$datepassedclass.'">'.
326             '<a href="'.$CFG->wwwroot.'/mod/'.$activity->modname.
327             '/view.php?id='.$activity->id.'" title="' . s($displayname) . '">'.
328             '<div class="rotated-text-container"><span class="rotated-text">'.$shortenedname.'</span></div>'.
329             '<div class="modicon">'.
330             $OUTPUT->image_icon('icon', get_string('modulename', $activity->modname), $activity->modname) .
331             '</div>'.
332             '</a>';
333         if ($activity->completionexpected) {
334             print '<div class="completion-expected"><span>'.$datetext.'</span></div>';
335         }
336         print '</th>';
337     }
338     $formattedactivities[$activity->id] = (object)array(
339         'datepassedclass' => $datepassedclass,
340         'displayname' => $displayname,
341     );
344 if ($csv) {
345     print $line;
346 } else {
347     print '</tr></thead><tbody>';
350 // Row for each user
351 foreach($progress as $user) {
352     // User name
353     if ($csv) {
354         print csv_quote(fullname($user));
355         foreach ($extrafields as $field) {
356             echo $sep . csv_quote($user->{$field});
357         }
358     } else {
359         print '<tr><th scope="row"><a href="'.$CFG->wwwroot.'/user/view.php?id='.
360             $user->id.'&amp;course='.$course->id.'">'.fullname($user).'</a></th>';
361         foreach ($extrafields as $field) {
362             echo '<td>' . s($user->{$field}) . '</td>';
363         }
364     }
366     // Progress for each activity
367     foreach($activities as $activity) {
369         // Get progress information and state
370         if (array_key_exists($activity->id, $user->progress)) {
371             $thisprogress = $user->progress[$activity->id];
372             $state = $thisprogress->completionstate;
373             $overrideby = $thisprogress->overrideby;
374             $date = userdate($thisprogress->timemodified);
375         } else {
376             $state = COMPLETION_INCOMPLETE;
377             $overrideby = 0;
378             $date = '';
379         }
381         // Work out how it corresponds to an icon
382         switch($state) {
383             case COMPLETION_INCOMPLETE :
384                 $completiontype = 'n'.($overrideby ? '-override' : '');
385                 break;
386             case COMPLETION_COMPLETE :
387                 $completiontype = 'y'.($overrideby ? '-override' : '');
388                 break;
389             case COMPLETION_COMPLETE_PASS :
390                 $completiontype = 'pass';
391                 break;
392             case COMPLETION_COMPLETE_FAIL :
393                 $completiontype = 'fail';
394                 break;
395         }
396         $completiontrackingstring = $activity->completion == COMPLETION_TRACKING_AUTOMATIC ? 'auto' : 'manual';
397         $completionicon = 'completion-' . $completiontrackingstring. '-' . $completiontype;
399         if ($overrideby) {
400             $overridebyuser = \core_user::get_user($overrideby, '*', MUST_EXIST);
401             $describe = get_string('completion-' . $completiontype, 'completion', fullname($overridebyuser));
402         } else {
403             $describe = get_string('completion-' . $completiontype, 'completion');
404         }
405         $a=new StdClass;
406         $a->state=$describe;
407         $a->date=$date;
408         $a->user=fullname($user);
409         $a->activity = $formattedactivities[$activity->id]->displayname;
410         $fulldescribe=get_string('progress-title','completion',$a);
412         if ($csv) {
413             print $sep.csv_quote($describe).$sep.csv_quote($date);
414         } else {
415             $celltext = $OUTPUT->pix_icon('i/' . $completionicon, s($fulldescribe));
416             if (has_capability('moodle/course:overridecompletion', $context) &&
417                     $state != COMPLETION_COMPLETE_PASS && $state != COMPLETION_COMPLETE_FAIL) {
418                 $newstate = ($state == COMPLETION_COMPLETE) ? COMPLETION_INCOMPLETE : COMPLETION_COMPLETE;
419                 $changecompl = $user->id . '-' . $activity->id . '-' . $newstate;
420                 $url = new moodle_url($PAGE->url, ['sesskey' => sesskey()]);
421                 $celltext = html_writer::link($url, $celltext, array('class' => 'changecompl', 'data-changecompl' => $changecompl,
422                                                                      'data-activityname' => $a->activity,
423                                                                      'data-userfullname' => $a->user,
424                                                                      'data-completiontracking' => $completiontrackingstring,
425                                                                      'aria-role' => 'button'));
426             }
427             print '<td class="completion-progresscell '.$formattedactivities[$activity->id]->datepassedclass.'">'.
428                 $celltext . '</td>';
429         }
430     }
432     if ($csv) {
433         print $line;
434     } else {
435         print '</tr>';
436     }
439 if ($csv) {
440     exit;
442 print '</tbody></table>';
443 print '</div>';
444 print $pagingbar;
446 print '<ul class="progress-actions"><li><a href="index.php?course='.$course->id.
447     '&amp;format=csv">'.get_string('csvdownload','completion').'</a></li>
448     <li><a href="index.php?course='.$course->id.'&amp;format=excelcsv">'.
449     get_string('excelcsvdownload','completion').'</a></li></ul>';
451 echo $OUTPUT->footer();