MDL-31918 Use cached module info for activity completion report
[moodle.git] / report / completion / 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  * Course completion progress report
19  *
20  * @package    report
21  * @subpackage completion
22  * @copyright  2009 Catalyst IT Ltd
23  * @author     Aaron Barnes <aaronb@catalyst.net.nz>
24  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
27 require('../../config.php');
28 require_once($CFG->libdir.'/completionlib.php');
30 /**
31  * Configuration
32  */
33 define('COMPLETION_REPORT_PAGE',        25);
34 define('COMPLETION_REPORT_COL_TITLES',  true);
36 /*
37  * Setup page, check permissions
38  */
40 // Get course
41 $courseid = required_param('course', PARAM_INT);
42 $format = optional_param('format','',PARAM_ALPHA);
43 $sort = optional_param('sort','',PARAM_ALPHA);
44 $edituser = optional_param('edituser', 0, PARAM_INT);
47 $course = $DB->get_record('course', array('id' => $courseid), '*', MUST_EXIST);
48 $context = context_course::instance($course->id);
50 $url = new moodle_url('/report/completion/index.php', array('course'=>$course->id));
51 $PAGE->set_url($url);
52 $PAGE->set_pagelayout('report');
54 $firstnamesort = ($sort == 'firstname');
55 $excel = ($format == 'excelcsv');
56 $csv = ($format == 'csv' || $excel);
58 // Paging
59 $start   = optional_param('start', 0, PARAM_INT);
60 $sifirst = optional_param('sifirst', 'all', PARAM_ALPHA);
61 $silast  = optional_param('silast', 'all', PARAM_ALPHA);
63 // Whether to show extra user identity information
64 $extrafields = get_extra_user_fields($context);
65 $leftcols = 1 + count($extrafields);
67 // Function for quoting csv cell values
68 function csv_quote($value) {
69     global $excel;
70     if ($excel) {
71         $tl = textlib_get_instance();
72         return $tl->convert('"'.str_replace('"',"'",$value).'"','UTF-8','UTF-16LE');
73     } else {
74         return '"'.str_replace('"',"'",$value).'"';
75     }
76 }
79 // Check permissions
80 require_login($course);
82 require_capability('report/completion:view', $context);
84 // Get group mode
85 $group = groups_get_course_group($course, true); // Supposed to verify group
86 if ($group === 0 && $course->groupmode == SEPARATEGROUPS) {
87     require_capability('moodle/site:accessallgroups',$context);
88 }
90 /**
91  * Load data
92  */
94 // Retrieve course_module data for all modules in the course
95 $modinfo = get_fast_modinfo($course);
97 // Get criteria for course
98 $completion = new completion_info($course);
100 if (!$completion->has_criteria()) {
101     print_error('err_nocriteria', 'completion', $CFG->wwwroot.'/course/report.php?id='.$course->id);
104 // Get criteria and put in correct order
105 $criteria = array();
107 foreach ($completion->get_criteria(COMPLETION_CRITERIA_TYPE_COURSE) as $criterion) {
108     $criteria[] = $criterion;
111 foreach ($completion->get_criteria(COMPLETION_CRITERIA_TYPE_ACTIVITY) as $criterion) {
112     $criteria[] = $criterion;
115 foreach ($completion->get_criteria() as $criterion) {
116     if (!in_array($criterion->criteriatype, array(
117             COMPLETION_CRITERIA_TYPE_COURSE, COMPLETION_CRITERIA_TYPE_ACTIVITY))) {
118         $criteria[] = $criterion;
119     }
122 // Can logged in user mark users as complete?
123 // (if the logged in user has a role defined in the role criteria)
124 $allow_marking = false;
125 $allow_marking_criteria = null;
127 if (!$csv) {
128     // Get role criteria
129     $rcriteria = $completion->get_criteria(COMPLETION_CRITERIA_TYPE_ROLE);
131     if (!empty($rcriteria)) {
133         foreach ($rcriteria as $rcriterion) {
134             $users = get_role_users($rcriterion->role, $context, true);
136             // If logged in user has this role, allow marking complete
137             if ($users && in_array($USER->id, array_keys($users))) {
138                 $allow_marking = true;
139                 $allow_marking_criteria = $rcriterion->id;
140                 break;
141             }
142         }
143     }
146 /*
147  * Setup page header
148  */
149 if ($csv) {
150     $shortname = format_string($course->shortname, true, array('context' => $context));
151     $textlib = textlib_get_instance();
152     header('Content-Disposition: attachment; filename=progress.'.
153         preg_replace('/[^a-z0-9-]/','_',$textlib->strtolower(strip_tags($shortname))).'.csv');
154     // Unicode byte-order mark for Excel
155     if ($excel) {
156         header('Content-Type: text/csv; charset=UTF-16LE');
157         print chr(0xFF).chr(0xFE);
158         $sep="\t".chr(0);
159         $line="\n".chr(0);
160     } else {
161         header('Content-Type: text/csv; charset=UTF-8');
162         $sep=",";
163         $line="\n";
164     }
166 } else {
167     // Navigation and header
168     $strcompletion = get_string('coursecompletion');
170     $PAGE->set_title($strcompletion);
171     $PAGE->set_heading($course->fullname);
173     echo $OUTPUT->header();
175     $PAGE->requires->yui2_lib(
176         array(
177             'yahoo',
178             'dom',
179             'element',
180             'event',
181         )
182     );
184     $PAGE->requires->js('/report/completion/textrotate.js');
186     // Handle groups (if enabled)
187     groups_print_course_menu($course, $CFG->wwwroot.'/report/completion/?course='.$course->id);
191 // Generate where clause
192 $where = array();
193 $where_params = array();
195 if ($sifirst !== 'all') {
196     $where[] = $DB->sql_like('u.firstname', ':sifirst', false);
197     $where_params['sifirst'] = $sifirst.'%';
200 if ($silast !== 'all') {
201     $where[] = $DB->sql_like('u.lastname', ':silast', false);
202     $where_params['silast'] = $silast.'%';
205 // Get user match count
206 $total = $completion->get_num_tracked_users(implode(' AND ', $where), $where_params, $group);
208 // Total user count
209 $grandtotal = $completion->get_num_tracked_users('', array(), $group);
211 // If no users in this course what-so-ever
212 if (!$grandtotal) {
213     echo $OUTPUT->container(get_string('err_nousers', 'completion'), 'errorbox errorboxcontent');
214     echo $OUTPUT->footer();
215     exit;
218 // Get user data
219 $progress = array();
221 if ($total) {
222     $progress = $completion->get_progress_all(
223         implode(' AND ', $where),
224         $where_params,
225         $group,
226         $firstnamesort ? 'u.firstname ASC' : 'u.lastname ASC',
227         $csv ? 0 : COMPLETION_REPORT_PAGE,
228         $csv ? 0 : $start,
229         $context
230     );
234 // Build link for paging
235 $link = $CFG->wwwroot.'/report/completion/?course='.$course->id;
236 if (strlen($sort)) {
237     $link .= '&amp;sort='.$sort;
239 $link .= '&amp;start=';
241 // Build the the page by Initial bar
242 $initials = array('first', 'last');
243 $alphabet = explode(',', get_string('alphabet', 'langconfig'));
245 $pagingbar = '';
246 foreach ($initials as $initial) {
247     $var = 'si'.$initial;
249     $othervar = $initial == 'first' ? 'silast' : 'sifirst';
250     $othervar = $$othervar != 'all' ? "&amp;{$othervar}={$$othervar}" : '';
252     $pagingbar .= ' <div class="initialbar '.$initial.'initial">';
253     $pagingbar .= get_string($initial.'name').':&nbsp;';
255     if ($$var == 'all') {
256         $pagingbar .= '<strong>'.get_string('all').'</strong> ';
257     }
258     else {
259         $pagingbar .= "<a href=\"{$link}{$othervar}\">".get_string('all').'</a> ';
260     }
262     foreach ($alphabet as $letter) {
263         if ($$var === $letter) {
264             $pagingbar .= '<strong>'.$letter.'</strong> ';
265         }
266         else {
267             $pagingbar .= "<a href=\"$link&amp;$var={$letter}{$othervar}\">$letter</a> ";
268         }
269     }
271     $pagingbar .= '</div>';
274 // Do we need a paging bar?
275 if ($total > COMPLETION_REPORT_PAGE) {
277     // Paging bar
278     $pagingbar .= '<div class="paging">';
279     $pagingbar .= get_string('page').': ';
281     $sistrings = array();
282     if ($sifirst != 'all') {
283         $sistrings[] =  "sifirst={$sifirst}";
284     }
285     if ($silast != 'all') {
286         $sistrings[] =  "silast={$silast}";
287     }
288     $sistring = !empty($sistrings) ? '&amp;'.implode('&amp;', $sistrings) : '';
290     // Display previous link
291     if ($start > 0) {
292         $pstart = max($start - COMPLETION_REPORT_PAGE, 0);
293         $pagingbar .= "(<a class=\"previous\" href=\"{$link}{$pstart}{$sistring}\">".get_string('previous').'</a>)&nbsp;';
294     }
296     // Create page links
297     $curstart = 0;
298     $curpage = 0;
299     while ($curstart < $total) {
300         $curpage++;
302         if ($curstart == $start) {
303             $pagingbar .= '&nbsp;'.$curpage.'&nbsp;';
304         }
305         else {
306             $pagingbar .= "&nbsp;<a href=\"{$link}{$curstart}{$sistring}\">$curpage</a>&nbsp;";
307         }
309         $curstart += COMPLETION_REPORT_PAGE;
310     }
312     // Display next link
313     $nstart = $start + COMPLETION_REPORT_PAGE;
314     if ($nstart < $total) {
315         $pagingbar .= "&nbsp;(<a class=\"next\" href=\"{$link}{$nstart}{$sistring}\">".get_string('next').'</a>)';
316     }
318     $pagingbar .= '</div>';
322 /*
323  * Draw table header
324  */
326 // Start of table
327 if (!$csv) {
328     print '<br class="clearer"/>'; // ugh
330     $total_header = ($total == $grandtotal) ? $total : "{$total}/{$grandtotal}";
331     echo $OUTPUT->heading(get_string('allparticipants').": {$total_header}", 3);
333     print $pagingbar;
335     if (!$total) {
336         echo $OUTPUT->heading(get_string('nothingtodisplay'), 2);
337         echo $OUTPUT->footer();
338         exit;
339     }
341     print '<table id="completion-progress" class="generaltable flexible boxaligncenter completionreport" style="text-align: left" cellpadding="5" border="1">';
343     // Print criteria group names
344     print PHP_EOL.'<tr style="vertical-align: top">';
345     echo '<th scope="row" class="rowheader" colspan="' . $leftcols . '">' .
346             get_string('criteriagroup', 'completion') . '</th>';
348     $current_group = false;
349     $col_count = 0;
350     for ($i = 0; $i <= count($criteria); $i++) {
352         if (isset($criteria[$i])) {
353             $criterion = $criteria[$i];
355             if ($current_group && $criterion->criteriatype === $current_group->criteriatype) {
356                 ++$col_count;
357                 continue;
358             }
359         }
361         // Print header cell
362         if ($col_count) {
363             print '<th scope="col" colspan="'.$col_count.'" class="colheader criteriagroup">'.$current_group->get_type_title().'</th>';
364         }
366         if (isset($criteria[$i])) {
367             // Move to next criteria type
368             $current_group = $criterion;
369             $col_count = 1;
370         }
371     }
373     // Overall course completion status
374     print '<th style="text-align: center;">'.get_string('course').'</th>';
376     print '</tr>';
378     // Print aggregation methods
379     print PHP_EOL.'<tr style="vertical-align: top">';
380     echo '<th scope="row" class="rowheader" colspan="' . $leftcols . '">' .
381             get_string('aggregationmethod', 'completion').'</th>';
383     $current_group = false;
384     $col_count = 0;
385     for ($i = 0; $i <= count($criteria); $i++) {
387         if (isset($criteria[$i])) {
388             $criterion = $criteria[$i];
390             if ($current_group && $criterion->criteriatype === $current_group->criteriatype) {
391                 ++$col_count;
392                 continue;
393             }
394         }
396         // Print header cell
397         if ($col_count) {
398             $has_agg = array(
399                 COMPLETION_CRITERIA_TYPE_COURSE,
400                 COMPLETION_CRITERIA_TYPE_ACTIVITY,
401                 COMPLETION_CRITERIA_TYPE_ROLE,
402             );
404             if (in_array($current_group->criteriatype, $has_agg)) {
405                 // Try load a aggregation method
406                 $method = $completion->get_aggregation_method($current_group->criteriatype);
408                 $method = $method == 1 ? get_string('all') : get_string('any');
410             } else {
411                 $method = '-';
412             }
414             print '<th scope="col" colspan="'.$col_count.'" class="colheader aggheader">'.$method.'</th>';
415         }
417         if (isset($criteria[$i])) {
418             // Move to next criteria type
419             $current_group = $criterion;
420             $col_count = 1;
421         }
422     }
424     // Overall course aggregation method
425     print '<th scope="col" class="colheader aggheader aggcriteriacourse">';
427     // Get course aggregation
428     $method = $completion->get_aggregation_method();
430     print $method == 1 ? get_string('all') : get_string('any');
431     print '</th>';
433     print '</tr>';
436     // Print criteria titles
437     if (COMPLETION_REPORT_COL_TITLES) {
439         print PHP_EOL.'<tr>';
440         echo '<th scope="row" class="rowheader" colspan="' . $leftcols . '">' .
441                 get_string('criteria', 'completion') . '</th>';
443         foreach ($criteria as $criterion) {
444             // Get criteria details
445             $details = $criterion->get_title_detailed();
446             print '<th scope="col" class="colheader criterianame">';
447             print '<span class="completion-criterianame">'.$details.'</span>';
448             print '</th>';
449         }
451         // Overall course completion status
452         print '<th scope="col" class="colheader criterianame">';
454         print '<span class="completion-criterianame">'.get_string('coursecomplete', 'completion').'</span>';
456         print '</th></tr>';
457     }
459     // Print user heading and icons
460     print '<tr>';
462     // User heading / sort option
463     print '<th scope="col" class="completion-sortchoice" style="clear: both;">';
465     $sistring = "&amp;silast={$silast}&amp;sifirst={$sifirst}";
467     if ($firstnamesort) {
468         print
469             get_string('firstname')." / <a href=\"./?course={$course->id}{$sistring}\">".
470             get_string('lastname').'</a>';
471     } else {
472         print "<a href=\"./?course={$course->id}&amp;sort=firstname{$sistring}\">".
473             get_string('firstname').'</a> / '.
474             get_string('lastname');
475     }
476     print '</th>';
479     // Print user identity columns
480     foreach ($extrafields as $field) {
481         echo '<th scope="col" class="completion-identifyfield">' .
482                 get_user_field_name($field) . '</th>';
483     }
485     ///
486     /// Print criteria icons
487     ///
488     foreach ($criteria as $criterion) {
490         // Generate icon details
491         $icon = '';
492         $iconlink = '';
493         $icontitle = ''; // Required if $iconlink set
494         $iconalt = ''; // Required
495         switch ($criterion->criteriatype) {
497             case COMPLETION_CRITERIA_TYPE_ACTIVITY:
498                 // Display icon
499                 $icon = $OUTPUT->pix_url('icon', $criterion->module);
500                 $iconlink = $CFG->wwwroot.'/mod/'.$criterion->module.'/view.php?id='.$criterion->moduleinstance;
501                 $icontitle = $modinfo->cms[$criterion->moduleinstance]->name;
502                 $iconalt = get_string('modulename', $criterion->module);
503                 break;
505             case COMPLETION_CRITERIA_TYPE_COURSE:
506                 // Load course
507                 $crs = $DB->get_record('course', array('id' => $criterion->courseinstance));
509                 // Display icon
510                 $iconlink = $CFG->wwwroot.'/course/view.php?id='.$criterion->courseinstance;
511                 $icontitle = format_string($crs->fullname, true, array('context' => get_context_instance(CONTEXT_COURSE, $crs->id, MUST_EXIST)));
512                 $iconalt = format_string($crs->shortname, true, array('context' => get_context_instance(CONTEXT_COURSE, $crs->id)));
513                 break;
515             case COMPLETION_CRITERIA_TYPE_ROLE:
516                 // Load role
517                 $role = $DB->get_record('role', array('id' => $criterion->role));
519                 // Display icon
520                 $iconalt = $role->name;
521                 break;
522         }
524         // Print icon and cell
525         print '<th class="criteriaicon">';
527         // Create icon if not supplied
528         if (!$icon) {
529             $icon = $OUTPUT->pix_url('i/'.$COMPLETION_CRITERIA_TYPES[$criterion->criteriatype]);
530         }
532         print ($iconlink ? '<a href="'.$iconlink.'" title="'.$icontitle.'">' : '');
533         print '<img src="'.$icon.'" class="icon" alt="'.$iconalt.'" '.(!$iconlink ? 'title="'.$iconalt.'"' : '').' />';
534         print ($iconlink ? '</a>' : '');
536         print '</th>';
537     }
539     // Overall course completion status
540     print '<th class="criteriaicon">';
541     print '<img src="'.$OUTPUT->pix_url('i/course').'" class="icon" alt="'.get_string('course').'" title="'.get_string('coursecomplete', 'completion').'" />';
542     print '</th>';
544     print '</tr>';
547 } else {
548     // The CSV file does not contain any headers
552 ///
553 /// Display a row for each user
554 ///
555 foreach ($progress as $user) {
557     // User name
558     if ($csv) {
559         print csv_quote(fullname($user));
560         foreach ($extrafields as $field) {
561             echo $sep . csv_quote($user->{$field});
562         }
563     } else {
564         print PHP_EOL.'<tr id="user-'.$user->id.'">';
566         print '<th scope="row"><a href="'.$CFG->wwwroot.'/user/view.php?id='.
567             $user->id.'&amp;course='.$course->id.'">'.fullname($user).'</a></th>';
568         foreach ($extrafields as $field) {
569             echo '<td>' . s($user->{$field}) . '</td>';
570         }
571     }
573     // Progress for each course completion criteria
574     foreach ($criteria as $criterion) {
576         // Handle activity completion differently
577         if ($criterion->criteriatype == COMPLETION_CRITERIA_TYPE_ACTIVITY) {
579             // Load activity
580             $activity = $modinfo->cms[$criterion->moduleinstance];
582             // Get progress information and state
583             if (array_key_exists($activity->id,$user->progress)) {
584                 $thisprogress=$user->progress[$activity->id];
585                 $state=$thisprogress->completionstate;
586                 $date=userdate($thisprogress->timemodified);
587             } else {
588                 $state=COMPLETION_INCOMPLETE;
589                 $date='';
590             }
592             $criteria_completion = $completion->get_user_completion($user->id, $criterion);
594             // Work out how it corresponds to an icon
595             switch($state) {
596                 case COMPLETION_INCOMPLETE : $completiontype='n'; break;
597                 case COMPLETION_COMPLETE : $completiontype='y'; break;
598                 case COMPLETION_COMPLETE_PASS : $completiontype='pass'; break;
599                 case COMPLETION_COMPLETE_FAIL : $completiontype='fail'; break;
600             }
602             $completionicon='completion-'.
603                 ($activity->completion==COMPLETION_TRACKING_AUTOMATIC ? 'auto' : 'manual').
604                 '-'.$completiontype;
606             $describe=get_string('completion-alt-auto-'.$completiontype,'completion');
607             $a=new StdClass;
608             $a->state=$describe;
609             $a->date=$date;
610             $a->user=fullname($user);
611             $a->activity=strip_tags($activity->name);
612             $fulldescribe=get_string('progress-title','completion',$a);
614             if ($csv) {
615                 print $sep.csv_quote($describe).$sep.csv_quote($date);
616             } else {
617                 print '<td class="completion-progresscell">';
619                 print '<img src="'.$OUTPUT->pix_url('i/'.$completionicon).
620                       '" alt="'.$describe.'" class="icon" title="'.$fulldescribe.'" />';
622                 print '</td>';
623             }
625             continue;
626         }
628         // Handle all other criteria
629         $criteria_completion = $completion->get_user_completion($user->id, $criterion);
630         $is_complete = $criteria_completion->is_complete();
632         $completiontype = $is_complete ? 'y' : 'n';
633         $completionicon = 'completion-auto-'.$completiontype;
635         $describe = get_string('completion-alt-auto-'.$completiontype, 'completion');
637         $a = new stdClass();
638         $a->state    = $describe;
639         $a->date     = $is_complete ? userdate($criteria_completion->timecompleted) : '';
640         $a->user     = fullname($user);
641         $a->activity = strip_tags($criterion->get_title());
642         $fulldescribe = get_string('progress-title', 'completion', $a);
644         if ($csv) {
645             print $sep.csv_quote($describe);
646         } else {
648             if ($allow_marking_criteria === $criterion->id) {
649                 $describe = get_string('completion-alt-auto-'.$completiontype,'completion');
651                 print '<td class="completion-progresscell">'.
652                     '<a href="'.$CFG->wwwroot.'/course/togglecompletion.php?user='.$user->id.'&amp;course='.$course->id.'&amp;rolec='.$allow_marking_criteria.'&amp;sesskey='.sesskey().'">'.
653                     '<img src="'.$OUTPUT->pix_url('i/completion-manual-'.($is_complete ? 'y' : 'n')).
654                     '" alt="'.$describe.'" class="icon" title="'.get_string('markcomplete', 'completion').'" /></a></td>';
655             } else {
656                 print '<td class="completion-progresscell">'.
657                     '<img src="'.$OUTPUT->pix_url('i/'.$completionicon).
658                     '" alt="'.$describe.'" class="icon" title="'.$fulldescribe.'" /></td>';
659             }
660         }
661     }
663     // Handle overall course completion
665     // Load course completion
666     $params = array(
667         'userid'    => $user->id,
668         'course'    => $course->id
669     );
671     $ccompletion = new completion_completion($params);
672     $completiontype =  $ccompletion->is_complete() ? 'y' : 'n';
674     $describe = get_string('completion-alt-auto-'.$completiontype, 'completion');
676     $a = new StdClass;
677     $a->state    = $describe;
678     $a->date     = '';
679     $a->user     = fullname($user);
680     $a->activity = strip_tags(get_string('coursecomplete', 'completion'));
681     $fulldescribe = get_string('progress-title', 'completion', $a);
683     if ($csv) {
684         print $sep.csv_quote($describe);
685     } else {
687         print '<td class="completion-progresscell">';
689         // Display course completion status icon
690         print '<img src="'.$OUTPUT->pix_url('i/completion-auto-'.$completiontype).
691                '" alt="'.$describe.'" class="icon" title="'.$fulldescribe.'" />';
693         print '</td>';
694     }
696     if ($csv) {
697         print $line;
698     } else {
699         print '</tr>';
700     }
703 if ($csv) {
704     exit;
706 print '</table>';
707 print $pagingbar;
709 print '<ul class="progress-actions"><li><a href="index.php?course='.$course->id.
710     '&amp;format=csv">'.get_string('csvdownload','completion').'</a></li>
711     <li><a href="index.php?course='.$course->id.'&amp;format=excelcsv">'.
712     get_string('excelcsvdownload','completion').'</a></li></ul>';
714 echo $OUTPUT->footer($course);