457560eb883e0154e0a22c4421ae51dc21622e69
[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         return textlib::convert('"'.str_replace('"',"'",$value).'"','UTF-8','UTF-16LE');
72     } else {
73         return '"'.str_replace('"',"'",$value).'"';
74     }
75 }
78 // Check permissions
79 require_login($course);
81 require_capability('report/completion:view', $context);
83 // Get group mode
84 $group = groups_get_course_group($course, true); // Supposed to verify group
85 if ($group === 0 && $course->groupmode == SEPARATEGROUPS) {
86     require_capability('moodle/site:accessallgroups',$context);
87 }
89 /**
90  * Load data
91  */
93 // Retrieve course_module data for all modules in the course
94 $modinfo = get_fast_modinfo($course);
96 // Get criteria for course
97 $completion = new completion_info($course);
99 if (!$completion->has_criteria()) {
100     print_error('err_nocriteria', 'completion', $CFG->wwwroot.'/course/report.php?id='.$course->id);
103 // Get criteria and put in correct order
104 $criteria = array();
106 foreach ($completion->get_criteria(COMPLETION_CRITERIA_TYPE_COURSE) as $criterion) {
107     $criteria[] = $criterion;
110 foreach ($completion->get_criteria(COMPLETION_CRITERIA_TYPE_ACTIVITY) as $criterion) {
111     $criteria[] = $criterion;
114 foreach ($completion->get_criteria() as $criterion) {
115     if (!in_array($criterion->criteriatype, array(
116             COMPLETION_CRITERIA_TYPE_COURSE, COMPLETION_CRITERIA_TYPE_ACTIVITY))) {
117         $criteria[] = $criterion;
118     }
121 // Can logged in user mark users as complete?
122 // (if the logged in user has a role defined in the role criteria)
123 $allow_marking = false;
124 $allow_marking_criteria = null;
126 if (!$csv) {
127     // Get role criteria
128     $rcriteria = $completion->get_criteria(COMPLETION_CRITERIA_TYPE_ROLE);
130     if (!empty($rcriteria)) {
132         foreach ($rcriteria as $rcriterion) {
133             $users = get_role_users($rcriterion->role, $context, true);
135             // If logged in user has this role, allow marking complete
136             if ($users && in_array($USER->id, array_keys($users))) {
137                 $allow_marking = true;
138                 $allow_marking_criteria = $rcriterion->id;
139                 break;
140             }
141         }
142     }
145 /*
146  * Setup page header
147  */
148 if ($csv) {
149     $shortname = format_string($course->shortname, true, array('context' => $context));
150     header('Content-Disposition: attachment; filename=progress.'.
151         preg_replace('/[^a-z0-9-]/','_',textlib::strtolower(strip_tags($shortname))).'.csv');
152     // Unicode byte-order mark for Excel
153     if ($excel) {
154         header('Content-Type: text/csv; charset=UTF-16LE');
155         print chr(0xFF).chr(0xFE);
156         $sep="\t".chr(0);
157         $line="\n".chr(0);
158     } else {
159         header('Content-Type: text/csv; charset=UTF-8');
160         $sep=",";
161         $line="\n";
162     }
164 } else {
165     // Navigation and header
166     $strcompletion = get_string('coursecompletion');
168     $PAGE->set_title($strcompletion);
169     $PAGE->set_heading($course->fullname);
171     echo $OUTPUT->header();
173     $PAGE->requires->js('/report/completion/textrotate.js');
174     $PAGE->requires->js_function_call('textrotate_init', null, true);
176     // Handle groups (if enabled)
177     groups_print_course_menu($course, $CFG->wwwroot.'/report/completion/?course='.$course->id);
181 // Generate where clause
182 $where = array();
183 $where_params = array();
185 if ($sifirst !== 'all') {
186     $where[] = $DB->sql_like('u.firstname', ':sifirst', false);
187     $where_params['sifirst'] = $sifirst.'%';
190 if ($silast !== 'all') {
191     $where[] = $DB->sql_like('u.lastname', ':silast', false);
192     $where_params['silast'] = $silast.'%';
195 // Get user match count
196 $total = $completion->get_num_tracked_users(implode(' AND ', $where), $where_params, $group);
198 // Total user count
199 $grandtotal = $completion->get_num_tracked_users('', array(), $group);
201 // If no users in this course what-so-ever
202 if (!$grandtotal) {
203     echo $OUTPUT->container(get_string('err_nousers', 'completion'), 'errorbox errorboxcontent');
204     echo $OUTPUT->footer();
205     exit;
208 // Get user data
209 $progress = array();
211 if ($total) {
212     $progress = $completion->get_progress_all(
213         implode(' AND ', $where),
214         $where_params,
215         $group,
216         $firstnamesort ? 'u.firstname ASC' : 'u.lastname ASC',
217         $csv ? 0 : COMPLETION_REPORT_PAGE,
218         $csv ? 0 : $start,
219         $context
220     );
224 // Build link for paging
225 $link = $CFG->wwwroot.'/report/completion/?course='.$course->id;
226 if (strlen($sort)) {
227     $link .= '&amp;sort='.$sort;
229 $link .= '&amp;start=';
231 // Build the the page by Initial bar
232 $initials = array('first', 'last');
233 $alphabet = explode(',', get_string('alphabet', 'langconfig'));
235 $pagingbar = '';
236 foreach ($initials as $initial) {
237     $var = 'si'.$initial;
239     $othervar = $initial == 'first' ? 'silast' : 'sifirst';
240     $othervar = $$othervar != 'all' ? "&amp;{$othervar}={$$othervar}" : '';
242     $pagingbar .= ' <div class="initialbar '.$initial.'initial">';
243     $pagingbar .= get_string($initial.'name').':&nbsp;';
245     if ($$var == 'all') {
246         $pagingbar .= '<strong>'.get_string('all').'</strong> ';
247     }
248     else {
249         $pagingbar .= "<a href=\"{$link}{$othervar}\">".get_string('all').'</a> ';
250     }
252     foreach ($alphabet as $letter) {
253         if ($$var === $letter) {
254             $pagingbar .= '<strong>'.$letter.'</strong> ';
255         }
256         else {
257             $pagingbar .= "<a href=\"$link&amp;$var={$letter}{$othervar}\">$letter</a> ";
258         }
259     }
261     $pagingbar .= '</div>';
264 // Do we need a paging bar?
265 if ($total > COMPLETION_REPORT_PAGE) {
267     // Paging bar
268     $pagingbar .= '<div class="paging">';
269     $pagingbar .= get_string('page').': ';
271     $sistrings = array();
272     if ($sifirst != 'all') {
273         $sistrings[] =  "sifirst={$sifirst}";
274     }
275     if ($silast != 'all') {
276         $sistrings[] =  "silast={$silast}";
277     }
278     $sistring = !empty($sistrings) ? '&amp;'.implode('&amp;', $sistrings) : '';
280     // Display previous link
281     if ($start > 0) {
282         $pstart = max($start - COMPLETION_REPORT_PAGE, 0);
283         $pagingbar .= "(<a class=\"previous\" href=\"{$link}{$pstart}{$sistring}\">".get_string('previous').'</a>)&nbsp;';
284     }
286     // Create page links
287     $curstart = 0;
288     $curpage = 0;
289     while ($curstart < $total) {
290         $curpage++;
292         if ($curstart == $start) {
293             $pagingbar .= '&nbsp;'.$curpage.'&nbsp;';
294         }
295         else {
296             $pagingbar .= "&nbsp;<a href=\"{$link}{$curstart}{$sistring}\">$curpage</a>&nbsp;";
297         }
299         $curstart += COMPLETION_REPORT_PAGE;
300     }
302     // Display next link
303     $nstart = $start + COMPLETION_REPORT_PAGE;
304     if ($nstart < $total) {
305         $pagingbar .= "&nbsp;(<a class=\"next\" href=\"{$link}{$nstart}{$sistring}\">".get_string('next').'</a>)';
306     }
308     $pagingbar .= '</div>';
312 /*
313  * Draw table header
314  */
316 // Start of table
317 if (!$csv) {
318     print '<br class="clearer"/>'; // ugh
320     $total_header = ($total == $grandtotal) ? $total : "{$total}/{$grandtotal}";
321     echo $OUTPUT->heading(get_string('allparticipants').": {$total_header}", 3);
323     print $pagingbar;
325     if (!$total) {
326         echo $OUTPUT->heading(get_string('nothingtodisplay'), 2);
327         echo $OUTPUT->footer();
328         exit;
329     }
331     print '<div id="completion-progress-wrapper" class="no-overflow">';
332     print '<table id="completion-progress" class="generaltable flexible boxaligncenter completionreport" style="text-align: left" cellpadding="5" border="1">';
334     // Print criteria group names
335     print PHP_EOL.'<tr style="vertical-align: top">';
336     echo '<th scope="row" class="rowheader" colspan="' . $leftcols . '">' .
337             get_string('criteriagroup', 'completion') . '</th>';
339     $current_group = false;
340     $col_count = 0;
341     for ($i = 0; $i <= count($criteria); $i++) {
343         if (isset($criteria[$i])) {
344             $criterion = $criteria[$i];
346             if ($current_group && $criterion->criteriatype === $current_group->criteriatype) {
347                 ++$col_count;
348                 continue;
349             }
350         }
352         // Print header cell
353         if ($col_count) {
354             print '<th scope="col" colspan="'.$col_count.'" class="colheader criteriagroup">'.$current_group->get_type_title().'</th>';
355         }
357         if (isset($criteria[$i])) {
358             // Move to next criteria type
359             $current_group = $criterion;
360             $col_count = 1;
361         }
362     }
364     // Overall course completion status
365     print '<th style="text-align: center;">'.get_string('course').'</th>';
367     print '</tr>';
369     // Print aggregation methods
370     print PHP_EOL.'<tr style="vertical-align: top">';
371     echo '<th scope="row" class="rowheader" colspan="' . $leftcols . '">' .
372             get_string('aggregationmethod', 'completion').'</th>';
374     $current_group = false;
375     $col_count = 0;
376     for ($i = 0; $i <= count($criteria); $i++) {
378         if (isset($criteria[$i])) {
379             $criterion = $criteria[$i];
381             if ($current_group && $criterion->criteriatype === $current_group->criteriatype) {
382                 ++$col_count;
383                 continue;
384             }
385         }
387         // Print header cell
388         if ($col_count) {
389             $has_agg = array(
390                 COMPLETION_CRITERIA_TYPE_COURSE,
391                 COMPLETION_CRITERIA_TYPE_ACTIVITY,
392                 COMPLETION_CRITERIA_TYPE_ROLE,
393             );
395             if (in_array($current_group->criteriatype, $has_agg)) {
396                 // Try load a aggregation method
397                 $method = $completion->get_aggregation_method($current_group->criteriatype);
399                 $method = $method == 1 ? get_string('all') : get_string('any');
401             } else {
402                 $method = '-';
403             }
405             print '<th scope="col" colspan="'.$col_count.'" class="colheader aggheader">'.$method.'</th>';
406         }
408         if (isset($criteria[$i])) {
409             // Move to next criteria type
410             $current_group = $criterion;
411             $col_count = 1;
412         }
413     }
415     // Overall course aggregation method
416     print '<th scope="col" class="colheader aggheader aggcriteriacourse">';
418     // Get course aggregation
419     $method = $completion->get_aggregation_method();
421     print $method == 1 ? get_string('all') : get_string('any');
422     print '</th>';
424     print '</tr>';
427     // Print criteria titles
428     if (COMPLETION_REPORT_COL_TITLES) {
430         print PHP_EOL.'<tr>';
431         echo '<th scope="row" class="rowheader" colspan="' . $leftcols . '">' .
432                 get_string('criteria', 'completion') . '</th>';
434         foreach ($criteria as $criterion) {
435             // Get criteria details
436             $details = $criterion->get_title_detailed();
437             print '<th scope="col" class="colheader criterianame">';
438             print '<span class="completion-criterianame">'.$details.'</span>';
439             print '</th>';
440         }
442         // Overall course completion status
443         print '<th scope="col" class="colheader criterianame">';
445         print '<span class="completion-criterianame">'.get_string('coursecomplete', 'completion').'</span>';
447         print '</th></tr>';
448     }
450     // Print user heading and icons
451     print '<tr>';
453     // User heading / sort option
454     print '<th scope="col" class="completion-sortchoice" style="clear: both;">';
456     $sistring = "&amp;silast={$silast}&amp;sifirst={$sifirst}";
458     if ($firstnamesort) {
459         print
460             get_string('firstname')." / <a href=\"./?course={$course->id}{$sistring}\">".
461             get_string('lastname').'</a>';
462     } else {
463         print "<a href=\"./?course={$course->id}&amp;sort=firstname{$sistring}\">".
464             get_string('firstname').'</a> / '.
465             get_string('lastname');
466     }
467     print '</th>';
470     // Print user identity columns
471     foreach ($extrafields as $field) {
472         echo '<th scope="col" class="completion-identifyfield">' .
473                 get_user_field_name($field) . '</th>';
474     }
476     ///
477     /// Print criteria icons
478     ///
479     foreach ($criteria as $criterion) {
481         // Generate icon details
482         $icon = '';
483         $iconlink = '';
484         $icontitle = ''; // Required if $iconlink set
485         $iconalt = ''; // Required
486         switch ($criterion->criteriatype) {
488             case COMPLETION_CRITERIA_TYPE_ACTIVITY:
489                 // Display icon
490                 $icon = $OUTPUT->pix_url('icon', $criterion->module);
491                 $iconlink = $CFG->wwwroot.'/mod/'.$criterion->module.'/view.php?id='.$criterion->moduleinstance;
492                 $icontitle = $modinfo->cms[$criterion->moduleinstance]->name;
493                 $iconalt = get_string('modulename', $criterion->module);
494                 break;
496             case COMPLETION_CRITERIA_TYPE_COURSE:
497                 // Load course
498                 $crs = $DB->get_record('course', array('id' => $criterion->courseinstance));
500                 // Display icon
501                 $iconlink = $CFG->wwwroot.'/course/view.php?id='.$criterion->courseinstance;
502                 $icontitle = format_string($crs->fullname, true, array('context' => context_course::instance($crs->id, MUST_EXIST)));
503                 $iconalt = format_string($crs->shortname, true, array('context' => context_course::instance($crs->id)));
504                 break;
506             case COMPLETION_CRITERIA_TYPE_ROLE:
507                 // Load role
508                 $role = $DB->get_record('role', array('id' => $criterion->role));
510                 // Display icon
511                 $iconalt = $role->name;
512                 break;
513         }
515         // Print icon and cell
516         print '<th class="criteriaicon">';
518         // Create icon if not supplied
519         if (!$icon) {
520             $icon = $OUTPUT->pix_url('i/'.$COMPLETION_CRITERIA_TYPES[$criterion->criteriatype]);
521         }
523         print ($iconlink ? '<a href="'.$iconlink.'" title="'.$icontitle.'">' : '');
524         print '<img src="'.$icon.'" class="icon" alt="'.$iconalt.'" '.(!$iconlink ? 'title="'.$iconalt.'"' : '').' />';
525         print ($iconlink ? '</a>' : '');
527         print '</th>';
528     }
530     // Overall course completion status
531     print '<th class="criteriaicon">';
532     print '<img src="'.$OUTPUT->pix_url('i/course').'" class="icon" alt="'.get_string('course').'" title="'.get_string('coursecomplete', 'completion').'" />';
533     print '</th>';
535     print '</tr>';
538 } else {
539     // The CSV file does not contain any headers
543 ///
544 /// Display a row for each user
545 ///
546 foreach ($progress as $user) {
548     // User name
549     if ($csv) {
550         print csv_quote(fullname($user));
551         foreach ($extrafields as $field) {
552             echo $sep . csv_quote($user->{$field});
553         }
554     } else {
555         print PHP_EOL.'<tr id="user-'.$user->id.'">';
557         print '<th scope="row"><a href="'.$CFG->wwwroot.'/user/view.php?id='.
558             $user->id.'&amp;course='.$course->id.'">'.fullname($user).'</a></th>';
559         foreach ($extrafields as $field) {
560             echo '<td>' . s($user->{$field}) . '</td>';
561         }
562     }
564     // Progress for each course completion criteria
565     foreach ($criteria as $criterion) {
567         // Handle activity completion differently
568         if ($criterion->criteriatype == COMPLETION_CRITERIA_TYPE_ACTIVITY) {
570             // Load activity
571             $activity = $modinfo->cms[$criterion->moduleinstance];
573             // Get progress information and state
574             if (array_key_exists($activity->id,$user->progress)) {
575                 $thisprogress=$user->progress[$activity->id];
576                 $state=$thisprogress->completionstate;
577                 $date=userdate($thisprogress->timemodified);
578             } else {
579                 $state=COMPLETION_INCOMPLETE;
580                 $date='';
581             }
583             $criteria_completion = $completion->get_user_completion($user->id, $criterion);
585             // Work out how it corresponds to an icon
586             switch($state) {
587                 case COMPLETION_INCOMPLETE : $completiontype='n'; break;
588                 case COMPLETION_COMPLETE : $completiontype='y'; break;
589                 case COMPLETION_COMPLETE_PASS : $completiontype='pass'; break;
590                 case COMPLETION_COMPLETE_FAIL : $completiontype='fail'; break;
591             }
593             $completionicon='completion-'.
594                 ($activity->completion==COMPLETION_TRACKING_AUTOMATIC ? 'auto' : 'manual').
595                 '-'.$completiontype;
597             $describe = get_string('completion-' . $completiontype, 'completion');
598             $a=new StdClass;
599             $a->state=$describe;
600             $a->date=$date;
601             $a->user=fullname($user);
602             $a->activity=strip_tags($activity->name);
603             $fulldescribe=get_string('progress-title','completion',$a);
605             if ($csv) {
606                 print $sep.csv_quote($describe).$sep.csv_quote($date);
607             } else {
608                 print '<td class="completion-progresscell">';
610                 print '<img src="'.$OUTPUT->pix_url('i/'.$completionicon).
611                       '" alt="'.$describe.'" class="icon" title="'.$fulldescribe.'" />';
613                 print '</td>';
614             }
616             continue;
617         }
619         // Handle all other criteria
620         $criteria_completion = $completion->get_user_completion($user->id, $criterion);
621         $is_complete = $criteria_completion->is_complete();
623         $completiontype = $is_complete ? 'y' : 'n';
624         $completionicon = 'completion-auto-'.$completiontype;
626         $describe = get_string('completion-' . $completiontype, 'completion');
628         $a = new stdClass();
629         $a->state    = $describe;
630         $a->date     = $is_complete ? userdate($criteria_completion->timecompleted) : '';
631         $a->user     = fullname($user);
632         $a->activity = strip_tags($criterion->get_title());
633         $fulldescribe = get_string('progress-title', 'completion', $a);
635         if ($csv) {
636             print $sep.csv_quote($describe);
637         } else {
639             if ($allow_marking_criteria === $criterion->id) {
640                 $describe = get_string('completion-' . $completiontype, 'completion');
642                 print '<td class="completion-progresscell">'.
643                     '<a href="'.$CFG->wwwroot.'/course/togglecompletion.php?user='.$user->id.'&amp;course='.$course->id.'&amp;rolec='.$allow_marking_criteria.'&amp;sesskey='.sesskey().'">'.
644                     '<img src="'.$OUTPUT->pix_url('i/completion-manual-'.($is_complete ? 'y' : 'n')).
645                     '" alt="'.$describe.'" class="icon" title="'.get_string('markcomplete', 'completion').'" /></a></td>';
646             } else {
647                 print '<td class="completion-progresscell">'.
648                     '<img src="'.$OUTPUT->pix_url('i/'.$completionicon).
649                     '" alt="'.$describe.'" class="icon" title="'.$fulldescribe.'" /></td>';
650             }
651         }
652     }
654     // Handle overall course completion
656     // Load course completion
657     $params = array(
658         'userid'    => $user->id,
659         'course'    => $course->id
660     );
662     $ccompletion = new completion_completion($params);
663     $completiontype =  $ccompletion->is_complete() ? 'y' : 'n';
665     $describe = get_string('completion-' . $completiontype, 'completion');
667     $a = new StdClass;
668     $a->state    = $describe;
669     $a->date     = '';
670     $a->user     = fullname($user);
671     $a->activity = strip_tags(get_string('coursecomplete', 'completion'));
672     $fulldescribe = get_string('progress-title', 'completion', $a);
674     if ($csv) {
675         print $sep.csv_quote($describe);
676     } else {
678         print '<td class="completion-progresscell">';
680         // Display course completion status icon
681         print '<img src="'.$OUTPUT->pix_url('i/completion-auto-'.$completiontype).
682                '" alt="'.$describe.'" class="icon" title="'.$fulldescribe.'" />';
684         print '</td>';
685     }
687     if ($csv) {
688         print $line;
689     } else {
690         print '</tr>';
691     }
694 if ($csv) {
695     exit;
697 print '</table>';
698 print '</div>';
699 print $pagingbar;
701 print '<ul class="progress-actions"><li><a href="index.php?course='.$course->id.
702     '&amp;format=csv">'.get_string('csvdownload','completion').'</a></li>
703     <li><a href="index.php?course='.$course->id.'&amp;format=excelcsv">'.
704     get_string('excelcsvdownload','completion').'</a></li></ul>';
706 echo $OUTPUT->footer($course);