Merge branch 'MDL-31923-master-6' 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 // Get criteria for course
94 $completion = new completion_info($course);
96 if (!$completion->has_criteria()) {
97     print_error('err_nocriteria', 'completion', $CFG->wwwroot.'/course/report.php?id='.$course->id);
98 }
100 // Get criteria and put in correct order
101 $criteria = array();
103 foreach ($completion->get_criteria(COMPLETION_CRITERIA_TYPE_COURSE) as $criterion) {
104     $criteria[] = $criterion;
107 foreach ($completion->get_criteria(COMPLETION_CRITERIA_TYPE_ACTIVITY) as $criterion) {
108     $criteria[] = $criterion;
111 foreach ($completion->get_criteria() as $criterion) {
112     if (!in_array($criterion->criteriatype, array(
113             COMPLETION_CRITERIA_TYPE_COURSE, COMPLETION_CRITERIA_TYPE_ACTIVITY))) {
114         $criteria[] = $criterion;
115     }
118 // Can logged in user mark users as complete?
119 // (if the logged in user has a role defined in the role criteria)
120 $allow_marking = false;
121 $allow_marking_criteria = null;
123 if (!$csv) {
124     // Get role criteria
125     $rcriteria = $completion->get_criteria(COMPLETION_CRITERIA_TYPE_ROLE);
127     if (!empty($rcriteria)) {
129         foreach ($rcriteria as $rcriterion) {
130             $users = get_role_users($rcriterion->role, $context, true);
132             // If logged in user has this role, allow marking complete
133             if ($users && in_array($USER->id, array_keys($users))) {
134                 $allow_marking = true;
135                 $allow_marking_criteria = $rcriterion->id;
136                 break;
137             }
138         }
139     }
142 /*
143  * Setup page header
144  */
145 if ($csv) {
146     $shortname = format_string($course->shortname, true, array('context' => $context));
147     header('Content-Disposition: attachment; filename=progress.'.
148         preg_replace('/[^a-z0-9-]/','_',textlib::strtolower(strip_tags($shortname))).'.csv');
149     // Unicode byte-order mark for Excel
150     if ($excel) {
151         header('Content-Type: text/csv; charset=UTF-16LE');
152         print chr(0xFF).chr(0xFE);
153         $sep="\t".chr(0);
154         $line="\n".chr(0);
155     } else {
156         header('Content-Type: text/csv; charset=UTF-8');
157         $sep=",";
158         $line="\n";
159     }
161 } else {
162     // Navigation and header
163     $strcompletion = get_string('coursecompletion');
165     $PAGE->set_title($strcompletion);
166     $PAGE->set_heading($course->fullname);
168     echo $OUTPUT->header();
170     $PAGE->requires->yui2_lib(
171         array(
172             'yahoo',
173             'dom',
174             'element',
175             'event',
176         )
177     );
179     $PAGE->requires->js('/report/completion/textrotate.js');
181     // Handle groups (if enabled)
182     groups_print_course_menu($course, $CFG->wwwroot.'/report/completion/?course='.$course->id);
186 // Generate where clause
187 $where = array();
188 $where_params = array();
190 if ($sifirst !== 'all') {
191     $where[] = $DB->sql_like('u.firstname', ':sifirst', false);
192     $where_params['sifirst'] = $sifirst.'%';
195 if ($silast !== 'all') {
196     $where[] = $DB->sql_like('u.lastname', ':silast', false);
197     $where_params['silast'] = $silast.'%';
200 // Get user match count
201 $total = $completion->get_num_tracked_users(implode(' AND ', $where), $where_params, $group);
203 // Total user count
204 $grandtotal = $completion->get_num_tracked_users('', array(), $group);
206 // If no users in this course what-so-ever
207 if (!$grandtotal) {
208     echo $OUTPUT->container(get_string('err_nousers', 'completion'), 'errorbox errorboxcontent');
209     echo $OUTPUT->footer();
210     exit;
213 // Get user data
214 $progress = array();
216 if ($total) {
217     $progress = $completion->get_progress_all(
218         implode(' AND ', $where),
219         $where_params,
220         $group,
221         $firstnamesort ? 'u.firstname ASC' : 'u.lastname ASC',
222         $csv ? 0 : COMPLETION_REPORT_PAGE,
223         $csv ? 0 : $start,
224         $context
225     );
229 // Build link for paging
230 $link = $CFG->wwwroot.'/report/completion/?course='.$course->id;
231 if (strlen($sort)) {
232     $link .= '&amp;sort='.$sort;
234 $link .= '&amp;start=';
236 // Build the the page by Initial bar
237 $initials = array('first', 'last');
238 $alphabet = explode(',', get_string('alphabet', 'langconfig'));
240 $pagingbar = '';
241 foreach ($initials as $initial) {
242     $var = 'si'.$initial;
244     $othervar = $initial == 'first' ? 'silast' : 'sifirst';
245     $othervar = $$othervar != 'all' ? "&amp;{$othervar}={$$othervar}" : '';
247     $pagingbar .= ' <div class="initialbar '.$initial.'initial">';
248     $pagingbar .= get_string($initial.'name').':&nbsp;';
250     if ($$var == 'all') {
251         $pagingbar .= '<strong>'.get_string('all').'</strong> ';
252     }
253     else {
254         $pagingbar .= "<a href=\"{$link}{$othervar}\">".get_string('all').'</a> ';
255     }
257     foreach ($alphabet as $letter) {
258         if ($$var === $letter) {
259             $pagingbar .= '<strong>'.$letter.'</strong> ';
260         }
261         else {
262             $pagingbar .= "<a href=\"$link&amp;$var={$letter}{$othervar}\">$letter</a> ";
263         }
264     }
266     $pagingbar .= '</div>';
269 // Do we need a paging bar?
270 if ($total > COMPLETION_REPORT_PAGE) {
272     // Paging bar
273     $pagingbar .= '<div class="paging">';
274     $pagingbar .= get_string('page').': ';
276     $sistrings = array();
277     if ($sifirst != 'all') {
278         $sistrings[] =  "sifirst={$sifirst}";
279     }
280     if ($silast != 'all') {
281         $sistrings[] =  "silast={$silast}";
282     }
283     $sistring = !empty($sistrings) ? '&amp;'.implode('&amp;', $sistrings) : '';
285     // Display previous link
286     if ($start > 0) {
287         $pstart = max($start - COMPLETION_REPORT_PAGE, 0);
288         $pagingbar .= "(<a class=\"previous\" href=\"{$link}{$pstart}{$sistring}\">".get_string('previous').'</a>)&nbsp;';
289     }
291     // Create page links
292     $curstart = 0;
293     $curpage = 0;
294     while ($curstart < $total) {
295         $curpage++;
297         if ($curstart == $start) {
298             $pagingbar .= '&nbsp;'.$curpage.'&nbsp;';
299         }
300         else {
301             $pagingbar .= "&nbsp;<a href=\"{$link}{$curstart}{$sistring}\">$curpage</a>&nbsp;";
302         }
304         $curstart += COMPLETION_REPORT_PAGE;
305     }
307     // Display next link
308     $nstart = $start + COMPLETION_REPORT_PAGE;
309     if ($nstart < $total) {
310         $pagingbar .= "&nbsp;(<a class=\"next\" href=\"{$link}{$nstart}{$sistring}\">".get_string('next').'</a>)';
311     }
313     $pagingbar .= '</div>';
317 /*
318  * Draw table header
319  */
321 // Start of table
322 if (!$csv) {
323     print '<br class="clearer"/>'; // ugh
325     $total_header = ($total == $grandtotal) ? $total : "{$total}/{$grandtotal}";
326     echo $OUTPUT->heading(get_string('allparticipants').": {$total_header}", 3);
328     print $pagingbar;
330     if (!$total) {
331         echo $OUTPUT->heading(get_string('nothingtodisplay'), 2);
332         echo $OUTPUT->footer();
333         exit;
334     }
336     print '<table id="completion-progress" class="generaltable flexible boxaligncenter completionreport" style="text-align: left" cellpadding="5" border="1">';
338     // Print criteria group names
339     print PHP_EOL.'<tr style="vertical-align: top">';
340     echo '<th scope="row" class="rowheader" colspan="' . $leftcols . '">' .
341             get_string('criteriagroup', 'completion') . '</th>';
343     $current_group = false;
344     $col_count = 0;
345     for ($i = 0; $i <= count($criteria); $i++) {
347         if (isset($criteria[$i])) {
348             $criterion = $criteria[$i];
350             if ($current_group && $criterion->criteriatype === $current_group->criteriatype) {
351                 ++$col_count;
352                 continue;
353             }
354         }
356         // Print header cell
357         if ($col_count) {
358             print '<th scope="col" colspan="'.$col_count.'" class="colheader criteriagroup">'.$current_group->get_type_title().'</th>';
359         }
361         if (isset($criteria[$i])) {
362             // Move to next criteria type
363             $current_group = $criterion;
364             $col_count = 1;
365         }
366     }
368     // Overall course completion status
369     print '<th style="text-align: center;">'.get_string('course').'</th>';
371     print '</tr>';
373     // Print aggregation methods
374     print PHP_EOL.'<tr style="vertical-align: top">';
375     echo '<th scope="row" class="rowheader" colspan="' . $leftcols . '">' .
376             get_string('aggregationmethod', 'completion').'</th>';
378     $current_group = false;
379     $col_count = 0;
380     for ($i = 0; $i <= count($criteria); $i++) {
382         if (isset($criteria[$i])) {
383             $criterion = $criteria[$i];
385             if ($current_group && $criterion->criteriatype === $current_group->criteriatype) {
386                 ++$col_count;
387                 continue;
388             }
389         }
391         // Print header cell
392         if ($col_count) {
393             $has_agg = array(
394                 COMPLETION_CRITERIA_TYPE_COURSE,
395                 COMPLETION_CRITERIA_TYPE_ACTIVITY,
396                 COMPLETION_CRITERIA_TYPE_ROLE,
397             );
399             if (in_array($current_group->criteriatype, $has_agg)) {
400                 // Try load a aggregation method
401                 $method = $completion->get_aggregation_method($current_group->criteriatype);
403                 $method = $method == 1 ? get_string('all') : get_string('any');
405             } else {
406                 $method = '-';
407             }
409             print '<th scope="col" colspan="'.$col_count.'" class="colheader aggheader">'.$method.'</th>';
410         }
412         if (isset($criteria[$i])) {
413             // Move to next criteria type
414             $current_group = $criterion;
415             $col_count = 1;
416         }
417     }
419     // Overall course aggregation method
420     print '<th scope="col" class="colheader aggheader aggcriteriacourse">';
422     // Get course aggregation
423     $method = $completion->get_aggregation_method();
425     print $method == 1 ? get_string('all') : get_string('any');
426     print '</th>';
428     print '</tr>';
431     // Print criteria titles
432     if (COMPLETION_REPORT_COL_TITLES) {
434         print PHP_EOL.'<tr>';
435         echo '<th scope="row" class="rowheader" colspan="' . $leftcols . '">' .
436                 get_string('criteria', 'completion') . '</th>';
438         foreach ($criteria as $criterion) {
439             // Get criteria details
440             $details = $criterion->get_title_detailed();
441             print '<th scope="col" class="colheader criterianame">';
442             print '<span class="completion-criterianame">'.$details.'</span>';
443             print '</th>';
444         }
446         // Overall course completion status
447         print '<th scope="col" class="colheader criterianame">';
449         print '<span class="completion-criterianame">'.get_string('coursecomplete', 'completion').'</span>';
451         print '</th></tr>';
452     }
454     // Print user heading and icons
455     print '<tr>';
457     // User heading / sort option
458     print '<th scope="col" class="completion-sortchoice" style="clear: both;">';
460     $sistring = "&amp;silast={$silast}&amp;sifirst={$sifirst}";
462     if ($firstnamesort) {
463         print
464             get_string('firstname')." / <a href=\"./?course={$course->id}{$sistring}\">".
465             get_string('lastname').'</a>';
466     } else {
467         print "<a href=\"./?course={$course->id}&amp;sort=firstname{$sistring}\">".
468             get_string('firstname').'</a> / '.
469             get_string('lastname');
470     }
471     print '</th>';
474     // Print user identity columns
475     foreach ($extrafields as $field) {
476         echo '<th scope="col" class="completion-identifyfield">' .
477                 get_user_field_name($field) . '</th>';
478     }
480     ///
481     /// Print criteria icons
482     ///
483     foreach ($criteria as $criterion) {
485         // Generate icon details
486         $icon = '';
487         $iconlink = '';
488         $icontitle = ''; // Required if $iconlink set
489         $iconalt = ''; // Required
490         switch ($criterion->criteriatype) {
492             case COMPLETION_CRITERIA_TYPE_ACTIVITY:
493                 // Load activity
494                 $activity = $criterion->get_mod_instance();
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 = $activity->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             $mod = $criterion->get_mod_instance();
579             $activity = $DB->get_record('course_modules', array('id' => $criterion->moduleinstance));
580             $activity->name = $mod->name;
583             // Get progress information and state
584             if (array_key_exists($activity->id,$user->progress)) {
585                 $thisprogress=$user->progress[$activity->id];
586                 $state=$thisprogress->completionstate;
587                 $date=userdate($thisprogress->timemodified);
588             } else {
589                 $state=COMPLETION_INCOMPLETE;
590                 $date='';
591             }
593             $criteria_completion = $completion->get_user_completion($user->id, $criterion);
595             // Work out how it corresponds to an icon
596             switch($state) {
597                 case COMPLETION_INCOMPLETE : $completiontype='n'; break;
598                 case COMPLETION_COMPLETE : $completiontype='y'; break;
599                 case COMPLETION_COMPLETE_PASS : $completiontype='pass'; break;
600                 case COMPLETION_COMPLETE_FAIL : $completiontype='fail'; break;
601             }
603             $completionicon='completion-'.
604                 ($activity->completion==COMPLETION_TRACKING_AUTOMATIC ? 'auto' : 'manual').
605                 '-'.$completiontype;
607             $describe=get_string('completion-alt-auto-'.$completiontype,'completion');
608             $a=new StdClass;
609             $a->state=$describe;
610             $a->date=$date;
611             $a->user=fullname($user);
612             $a->activity=strip_tags($activity->name);
613             $fulldescribe=get_string('progress-title','completion',$a);
615             if ($csv) {
616                 print $sep.csv_quote($describe).$sep.csv_quote($date);
617             } else {
618                 print '<td class="completion-progresscell">';
620                 print '<img src="'.$OUTPUT->pix_url('i/'.$completionicon).
621                       '" alt="'.$describe.'" class="icon" title="'.$fulldescribe.'" />';
623                 print '</td>';
624             }
626             continue;
627         }
629         // Handle all other criteria
630         $criteria_completion = $completion->get_user_completion($user->id, $criterion);
631         $is_complete = $criteria_completion->is_complete();
633         $completiontype = $is_complete ? 'y' : 'n';
634         $completionicon = 'completion-auto-'.$completiontype;
636         $describe = get_string('completion-alt-auto-'.$completiontype, 'completion');
638         $a = new stdClass();
639         $a->state    = $describe;
640         $a->date     = $is_complete ? userdate($criteria_completion->timecompleted) : '';
641         $a->user     = fullname($user);
642         $a->activity = strip_tags($criterion->get_title());
643         $fulldescribe = get_string('progress-title', 'completion', $a);
645         if ($csv) {
646             print $sep.csv_quote($describe);
647         } else {
649             if ($allow_marking_criteria === $criterion->id) {
650                 $describe = get_string('completion-alt-auto-'.$completiontype,'completion');
652                 print '<td class="completion-progresscell">'.
653                     '<a href="'.$CFG->wwwroot.'/course/togglecompletion.php?user='.$user->id.'&amp;course='.$course->id.'&amp;rolec='.$allow_marking_criteria.'&amp;sesskey='.sesskey().'">'.
654                     '<img src="'.$OUTPUT->pix_url('i/completion-manual-'.($is_complete ? 'y' : 'n')).
655                     '" alt="'.$describe.'" class="icon" title="'.get_string('markcomplete', 'completion').'" /></a></td>';
656             } else {
657                 print '<td class="completion-progresscell">'.
658                     '<img src="'.$OUTPUT->pix_url('i/'.$completionicon).
659                     '" alt="'.$describe.'" class="icon" title="'.$fulldescribe.'" /></td>';
660             }
661         }
662     }
664     // Handle overall course completion
666     // Load course completion
667     $params = array(
668         'userid'    => $user->id,
669         'course'    => $course->id
670     );
672     $ccompletion = new completion_completion($params);
673     $completiontype =  $ccompletion->is_complete() ? 'y' : 'n';
675     $describe = get_string('completion-alt-auto-'.$completiontype, 'completion');
677     $a = new StdClass;
678     $a->state    = $describe;
679     $a->date     = '';
680     $a->user     = fullname($user);
681     $a->activity = strip_tags(get_string('coursecomplete', 'completion'));
682     $fulldescribe = get_string('progress-title', 'completion', $a);
684     if ($csv) {
685         print $sep.csv_quote($describe);
686     } else {
688         print '<td class="completion-progresscell">';
690         // Display course completion status icon
691         print '<img src="'.$OUTPUT->pix_url('i/completion-auto-'.$completiontype).
692                '" alt="'.$describe.'" class="icon" title="'.$fulldescribe.'" />';
694         print '</td>';
695     }
697     if ($csv) {
698         print $line;
699     } else {
700         print '</tr>';
701     }
704 if ($csv) {
705     exit;
707 print '</table>';
708 print $pagingbar;
710 print '<ul class="progress-actions"><li><a href="index.php?course='.$course->id.
711     '&amp;format=csv">'.get_string('csvdownload','completion').'</a></li>
712     <li><a href="index.php?course='.$course->id.'&amp;format=excelcsv">'.
713     get_string('excelcsvdownload','completion').'</a></li></ul>';
715 echo $OUTPUT->footer($course);