Merge branch 'MDL-31918-master-2' of git://git.luns.net.uk/moodle
[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->yui2_lib(
174         array(
175             'yahoo',
176             'dom',
177             'element',
178             'event',
179         )
180     );
182     $PAGE->requires->js('/report/completion/textrotate.js');
184     // Handle groups (if enabled)
185     groups_print_course_menu($course, $CFG->wwwroot.'/report/completion/?course='.$course->id);
189 // Generate where clause
190 $where = array();
191 $where_params = array();
193 if ($sifirst !== 'all') {
194     $where[] = $DB->sql_like('u.firstname', ':sifirst', false);
195     $where_params['sifirst'] = $sifirst.'%';
198 if ($silast !== 'all') {
199     $where[] = $DB->sql_like('u.lastname', ':silast', false);
200     $where_params['silast'] = $silast.'%';
203 // Get user match count
204 $total = $completion->get_num_tracked_users(implode(' AND ', $where), $where_params, $group);
206 // Total user count
207 $grandtotal = $completion->get_num_tracked_users('', array(), $group);
209 // If no users in this course what-so-ever
210 if (!$grandtotal) {
211     echo $OUTPUT->container(get_string('err_nousers', 'completion'), 'errorbox errorboxcontent');
212     echo $OUTPUT->footer();
213     exit;
216 // Get user data
217 $progress = array();
219 if ($total) {
220     $progress = $completion->get_progress_all(
221         implode(' AND ', $where),
222         $where_params,
223         $group,
224         $firstnamesort ? 'u.firstname ASC' : 'u.lastname ASC',
225         $csv ? 0 : COMPLETION_REPORT_PAGE,
226         $csv ? 0 : $start,
227         $context
228     );
232 // Build link for paging
233 $link = $CFG->wwwroot.'/report/completion/?course='.$course->id;
234 if (strlen($sort)) {
235     $link .= '&amp;sort='.$sort;
237 $link .= '&amp;start=';
239 // Build the the page by Initial bar
240 $initials = array('first', 'last');
241 $alphabet = explode(',', get_string('alphabet', 'langconfig'));
243 $pagingbar = '';
244 foreach ($initials as $initial) {
245     $var = 'si'.$initial;
247     $othervar = $initial == 'first' ? 'silast' : 'sifirst';
248     $othervar = $$othervar != 'all' ? "&amp;{$othervar}={$$othervar}" : '';
250     $pagingbar .= ' <div class="initialbar '.$initial.'initial">';
251     $pagingbar .= get_string($initial.'name').':&nbsp;';
253     if ($$var == 'all') {
254         $pagingbar .= '<strong>'.get_string('all').'</strong> ';
255     }
256     else {
257         $pagingbar .= "<a href=\"{$link}{$othervar}\">".get_string('all').'</a> ';
258     }
260     foreach ($alphabet as $letter) {
261         if ($$var === $letter) {
262             $pagingbar .= '<strong>'.$letter.'</strong> ';
263         }
264         else {
265             $pagingbar .= "<a href=\"$link&amp;$var={$letter}{$othervar}\">$letter</a> ";
266         }
267     }
269     $pagingbar .= '</div>';
272 // Do we need a paging bar?
273 if ($total > COMPLETION_REPORT_PAGE) {
275     // Paging bar
276     $pagingbar .= '<div class="paging">';
277     $pagingbar .= get_string('page').': ';
279     $sistrings = array();
280     if ($sifirst != 'all') {
281         $sistrings[] =  "sifirst={$sifirst}";
282     }
283     if ($silast != 'all') {
284         $sistrings[] =  "silast={$silast}";
285     }
286     $sistring = !empty($sistrings) ? '&amp;'.implode('&amp;', $sistrings) : '';
288     // Display previous link
289     if ($start > 0) {
290         $pstart = max($start - COMPLETION_REPORT_PAGE, 0);
291         $pagingbar .= "(<a class=\"previous\" href=\"{$link}{$pstart}{$sistring}\">".get_string('previous').'</a>)&nbsp;';
292     }
294     // Create page links
295     $curstart = 0;
296     $curpage = 0;
297     while ($curstart < $total) {
298         $curpage++;
300         if ($curstart == $start) {
301             $pagingbar .= '&nbsp;'.$curpage.'&nbsp;';
302         }
303         else {
304             $pagingbar .= "&nbsp;<a href=\"{$link}{$curstart}{$sistring}\">$curpage</a>&nbsp;";
305         }
307         $curstart += COMPLETION_REPORT_PAGE;
308     }
310     // Display next link
311     $nstart = $start + COMPLETION_REPORT_PAGE;
312     if ($nstart < $total) {
313         $pagingbar .= "&nbsp;(<a class=\"next\" href=\"{$link}{$nstart}{$sistring}\">".get_string('next').'</a>)';
314     }
316     $pagingbar .= '</div>';
320 /*
321  * Draw table header
322  */
324 // Start of table
325 if (!$csv) {
326     print '<br class="clearer"/>'; // ugh
328     $total_header = ($total == $grandtotal) ? $total : "{$total}/{$grandtotal}";
329     echo $OUTPUT->heading(get_string('allparticipants').": {$total_header}", 3);
331     print $pagingbar;
333     if (!$total) {
334         echo $OUTPUT->heading(get_string('nothingtodisplay'), 2);
335         echo $OUTPUT->footer();
336         exit;
337     }
339     print '<table id="completion-progress" class="generaltable flexible boxaligncenter completionreport" style="text-align: left" cellpadding="5" border="1">';
341     // Print criteria group names
342     print PHP_EOL.'<tr style="vertical-align: top">';
343     echo '<th scope="row" class="rowheader" colspan="' . $leftcols . '">' .
344             get_string('criteriagroup', 'completion') . '</th>';
346     $current_group = false;
347     $col_count = 0;
348     for ($i = 0; $i <= count($criteria); $i++) {
350         if (isset($criteria[$i])) {
351             $criterion = $criteria[$i];
353             if ($current_group && $criterion->criteriatype === $current_group->criteriatype) {
354                 ++$col_count;
355                 continue;
356             }
357         }
359         // Print header cell
360         if ($col_count) {
361             print '<th scope="col" colspan="'.$col_count.'" class="colheader criteriagroup">'.$current_group->get_type_title().'</th>';
362         }
364         if (isset($criteria[$i])) {
365             // Move to next criteria type
366             $current_group = $criterion;
367             $col_count = 1;
368         }
369     }
371     // Overall course completion status
372     print '<th style="text-align: center;">'.get_string('course').'</th>';
374     print '</tr>';
376     // Print aggregation methods
377     print PHP_EOL.'<tr style="vertical-align: top">';
378     echo '<th scope="row" class="rowheader" colspan="' . $leftcols . '">' .
379             get_string('aggregationmethod', 'completion').'</th>';
381     $current_group = false;
382     $col_count = 0;
383     for ($i = 0; $i <= count($criteria); $i++) {
385         if (isset($criteria[$i])) {
386             $criterion = $criteria[$i];
388             if ($current_group && $criterion->criteriatype === $current_group->criteriatype) {
389                 ++$col_count;
390                 continue;
391             }
392         }
394         // Print header cell
395         if ($col_count) {
396             $has_agg = array(
397                 COMPLETION_CRITERIA_TYPE_COURSE,
398                 COMPLETION_CRITERIA_TYPE_ACTIVITY,
399                 COMPLETION_CRITERIA_TYPE_ROLE,
400             );
402             if (in_array($current_group->criteriatype, $has_agg)) {
403                 // Try load a aggregation method
404                 $method = $completion->get_aggregation_method($current_group->criteriatype);
406                 $method = $method == 1 ? get_string('all') : get_string('any');
408             } else {
409                 $method = '-';
410             }
412             print '<th scope="col" colspan="'.$col_count.'" class="colheader aggheader">'.$method.'</th>';
413         }
415         if (isset($criteria[$i])) {
416             // Move to next criteria type
417             $current_group = $criterion;
418             $col_count = 1;
419         }
420     }
422     // Overall course aggregation method
423     print '<th scope="col" class="colheader aggheader aggcriteriacourse">';
425     // Get course aggregation
426     $method = $completion->get_aggregation_method();
428     print $method == 1 ? get_string('all') : get_string('any');
429     print '</th>';
431     print '</tr>';
434     // Print criteria titles
435     if (COMPLETION_REPORT_COL_TITLES) {
437         print PHP_EOL.'<tr>';
438         echo '<th scope="row" class="rowheader" colspan="' . $leftcols . '">' .
439                 get_string('criteria', 'completion') . '</th>';
441         foreach ($criteria as $criterion) {
442             // Get criteria details
443             $details = $criterion->get_title_detailed();
444             print '<th scope="col" class="colheader criterianame">';
445             print '<span class="completion-criterianame">'.$details.'</span>';
446             print '</th>';
447         }
449         // Overall course completion status
450         print '<th scope="col" class="colheader criterianame">';
452         print '<span class="completion-criterianame">'.get_string('coursecomplete', 'completion').'</span>';
454         print '</th></tr>';
455     }
457     // Print user heading and icons
458     print '<tr>';
460     // User heading / sort option
461     print '<th scope="col" class="completion-sortchoice" style="clear: both;">';
463     $sistring = "&amp;silast={$silast}&amp;sifirst={$sifirst}";
465     if ($firstnamesort) {
466         print
467             get_string('firstname')." / <a href=\"./?course={$course->id}{$sistring}\">".
468             get_string('lastname').'</a>';
469     } else {
470         print "<a href=\"./?course={$course->id}&amp;sort=firstname{$sistring}\">".
471             get_string('firstname').'</a> / '.
472             get_string('lastname');
473     }
474     print '</th>';
477     // Print user identity columns
478     foreach ($extrafields as $field) {
479         echo '<th scope="col" class="completion-identifyfield">' .
480                 get_user_field_name($field) . '</th>';
481     }
483     ///
484     /// Print criteria icons
485     ///
486     foreach ($criteria as $criterion) {
488         // Generate icon details
489         $icon = '';
490         $iconlink = '';
491         $icontitle = ''; // Required if $iconlink set
492         $iconalt = ''; // Required
493         switch ($criterion->criteriatype) {
495             case COMPLETION_CRITERIA_TYPE_ACTIVITY:
496                 // Display icon
497                 $icon = $OUTPUT->pix_url('icon', $criterion->module);
498                 $iconlink = $CFG->wwwroot.'/mod/'.$criterion->module.'/view.php?id='.$criterion->moduleinstance;
499                 $icontitle = $modinfo->cms[$criterion->moduleinstance]->name;
500                 $iconalt = get_string('modulename', $criterion->module);
501                 break;
503             case COMPLETION_CRITERIA_TYPE_COURSE:
504                 // Load course
505                 $crs = $DB->get_record('course', array('id' => $criterion->courseinstance));
507                 // Display icon
508                 $iconlink = $CFG->wwwroot.'/course/view.php?id='.$criterion->courseinstance;
509                 $icontitle = format_string($crs->fullname, true, array('context' => get_context_instance(CONTEXT_COURSE, $crs->id, MUST_EXIST)));
510                 $iconalt = format_string($crs->shortname, true, array('context' => get_context_instance(CONTEXT_COURSE, $crs->id)));
511                 break;
513             case COMPLETION_CRITERIA_TYPE_ROLE:
514                 // Load role
515                 $role = $DB->get_record('role', array('id' => $criterion->role));
517                 // Display icon
518                 $iconalt = $role->name;
519                 break;
520         }
522         // Print icon and cell
523         print '<th class="criteriaicon">';
525         // Create icon if not supplied
526         if (!$icon) {
527             $icon = $OUTPUT->pix_url('i/'.$COMPLETION_CRITERIA_TYPES[$criterion->criteriatype]);
528         }
530         print ($iconlink ? '<a href="'.$iconlink.'" title="'.$icontitle.'">' : '');
531         print '<img src="'.$icon.'" class="icon" alt="'.$iconalt.'" '.(!$iconlink ? 'title="'.$iconalt.'"' : '').' />';
532         print ($iconlink ? '</a>' : '');
534         print '</th>';
535     }
537     // Overall course completion status
538     print '<th class="criteriaicon">';
539     print '<img src="'.$OUTPUT->pix_url('i/course').'" class="icon" alt="'.get_string('course').'" title="'.get_string('coursecomplete', 'completion').'" />';
540     print '</th>';
542     print '</tr>';
545 } else {
546     // The CSV file does not contain any headers
550 ///
551 /// Display a row for each user
552 ///
553 foreach ($progress as $user) {
555     // User name
556     if ($csv) {
557         print csv_quote(fullname($user));
558         foreach ($extrafields as $field) {
559             echo $sep . csv_quote($user->{$field});
560         }
561     } else {
562         print PHP_EOL.'<tr id="user-'.$user->id.'">';
564         print '<th scope="row"><a href="'.$CFG->wwwroot.'/user/view.php?id='.
565             $user->id.'&amp;course='.$course->id.'">'.fullname($user).'</a></th>';
566         foreach ($extrafields as $field) {
567             echo '<td>' . s($user->{$field}) . '</td>';
568         }
569     }
571     // Progress for each course completion criteria
572     foreach ($criteria as $criterion) {
574         // Handle activity completion differently
575         if ($criterion->criteriatype == COMPLETION_CRITERIA_TYPE_ACTIVITY) {
577             // Load activity
578             $activity = $modinfo->cms[$criterion->moduleinstance];
580             // Get progress information and state
581             if (array_key_exists($activity->id,$user->progress)) {
582                 $thisprogress=$user->progress[$activity->id];
583                 $state=$thisprogress->completionstate;
584                 $date=userdate($thisprogress->timemodified);
585             } else {
586                 $state=COMPLETION_INCOMPLETE;
587                 $date='';
588             }
590             $criteria_completion = $completion->get_user_completion($user->id, $criterion);
592             // Work out how it corresponds to an icon
593             switch($state) {
594                 case COMPLETION_INCOMPLETE : $completiontype='n'; break;
595                 case COMPLETION_COMPLETE : $completiontype='y'; break;
596                 case COMPLETION_COMPLETE_PASS : $completiontype='pass'; break;
597                 case COMPLETION_COMPLETE_FAIL : $completiontype='fail'; break;
598             }
600             $completionicon='completion-'.
601                 ($activity->completion==COMPLETION_TRACKING_AUTOMATIC ? 'auto' : 'manual').
602                 '-'.$completiontype;
604             $describe=get_string('completion-alt-auto-'.$completiontype,'completion');
605             $a=new StdClass;
606             $a->state=$describe;
607             $a->date=$date;
608             $a->user=fullname($user);
609             $a->activity=strip_tags($activity->name);
610             $fulldescribe=get_string('progress-title','completion',$a);
612             if ($csv) {
613                 print $sep.csv_quote($describe).$sep.csv_quote($date);
614             } else {
615                 print '<td class="completion-progresscell">';
617                 print '<img src="'.$OUTPUT->pix_url('i/'.$completionicon).
618                       '" alt="'.$describe.'" class="icon" title="'.$fulldescribe.'" />';
620                 print '</td>';
621             }
623             continue;
624         }
626         // Handle all other criteria
627         $criteria_completion = $completion->get_user_completion($user->id, $criterion);
628         $is_complete = $criteria_completion->is_complete();
630         $completiontype = $is_complete ? 'y' : 'n';
631         $completionicon = 'completion-auto-'.$completiontype;
633         $describe = get_string('completion-alt-auto-'.$completiontype, 'completion');
635         $a = new stdClass();
636         $a->state    = $describe;
637         $a->date     = $is_complete ? userdate($criteria_completion->timecompleted) : '';
638         $a->user     = fullname($user);
639         $a->activity = strip_tags($criterion->get_title());
640         $fulldescribe = get_string('progress-title', 'completion', $a);
642         if ($csv) {
643             print $sep.csv_quote($describe);
644         } else {
646             if ($allow_marking_criteria === $criterion->id) {
647                 $describe = get_string('completion-alt-auto-'.$completiontype,'completion');
649                 print '<td class="completion-progresscell">'.
650                     '<a href="'.$CFG->wwwroot.'/course/togglecompletion.php?user='.$user->id.'&amp;course='.$course->id.'&amp;rolec='.$allow_marking_criteria.'&amp;sesskey='.sesskey().'">'.
651                     '<img src="'.$OUTPUT->pix_url('i/completion-manual-'.($is_complete ? 'y' : 'n')).
652                     '" alt="'.$describe.'" class="icon" title="'.get_string('markcomplete', 'completion').'" /></a></td>';
653             } else {
654                 print '<td class="completion-progresscell">'.
655                     '<img src="'.$OUTPUT->pix_url('i/'.$completionicon).
656                     '" alt="'.$describe.'" class="icon" title="'.$fulldescribe.'" /></td>';
657             }
658         }
659     }
661     // Handle overall course completion
663     // Load course completion
664     $params = array(
665         'userid'    => $user->id,
666         'course'    => $course->id
667     );
669     $ccompletion = new completion_completion($params);
670     $completiontype =  $ccompletion->is_complete() ? 'y' : 'n';
672     $describe = get_string('completion-alt-auto-'.$completiontype, 'completion');
674     $a = new StdClass;
675     $a->state    = $describe;
676     $a->date     = '';
677     $a->user     = fullname($user);
678     $a->activity = strip_tags(get_string('coursecomplete', 'completion'));
679     $fulldescribe = get_string('progress-title', 'completion', $a);
681     if ($csv) {
682         print $sep.csv_quote($describe);
683     } else {
685         print '<td class="completion-progresscell">';
687         // Display course completion status icon
688         print '<img src="'.$OUTPUT->pix_url('i/completion-auto-'.$completiontype).
689                '" alt="'.$describe.'" class="icon" title="'.$fulldescribe.'" />';
691         print '</td>';
692     }
694     if ($csv) {
695         print $line;
696     } else {
697         print '</tr>';
698     }
701 if ($csv) {
702     exit;
704 print '</table>';
705 print $pagingbar;
707 print '<ul class="progress-actions"><li><a href="index.php?course='.$course->id.
708     '&amp;format=csv">'.get_string('csvdownload','completion').'</a></li>
709     <li><a href="index.php?course='.$course->id.'&amp;format=excelcsv">'.
710     get_string('excelcsvdownload','completion').'</a></li></ul>';
712 echo $OUTPUT->footer($course);