Merge branch 'MDL-26647-master' of git://github.com/sammarshallou/moodle
[moodle.git] / report / progress / index.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Activity progress reports
19  *
20  * @package    report
21  * @subpackage progress
22  * @copyright  2008 Sam Marshall
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 require('../../config.php');
27 require_once($CFG->libdir . '/completionlib.php');
29 define('COMPLETION_REPORT_PAGE', 25);
31 // Get course
32 $id = required_param('course',PARAM_INT);
33 $course = $DB->get_record('course',array('id'=>$id));
34 if (!$course) {
35     print_error('invalidcourseid');
36 }
37 $context = context_course::instance($course->id);
39 // Sort (default lastname, optionally firstname)
40 $sort = optional_param('sort','',PARAM_ALPHA);
41 $firstnamesort = $sort == 'firstname';
43 // CSV format
44 $format = optional_param('format','',PARAM_ALPHA);
45 $excel = $format == 'excelcsv';
46 $csv = $format == 'csv' || $excel;
48 // Paging
49 $start   = optional_param('start', 0, PARAM_INT);
50 $sifirst = optional_param('sifirst', 'all', PARAM_ALPHA);
51 $silast  = optional_param('silast', 'all', PARAM_ALPHA);
52 $start   = optional_param('start', 0, PARAM_INT);
54 // Whether to show extra user identity information
55 $extrafields = get_extra_user_fields($context);
56 $leftcols = 1 + count($extrafields);
58 function csv_quote($value) {
59     global $excel;
60     if ($excel) {
61         $tl = textlib_get_instance();
62         return $tl->convert('"'.str_replace('"',"'",$value).'"','UTF-8','UTF-16LE');
63     } else {
64         return '"'.str_replace('"',"'",$value).'"';
65     }
66 }
68 $url = new moodle_url('/report/progress/index.php', array('course'=>$id));
69 if ($sort !== '') {
70     $url->param('sort', $sort);
71 }
72 if ($format !== '') {
73     $url->param('format', $format);
74 }
75 if ($start !== 0) {
76     $url->param('start', $start);
77 }
78 $PAGE->set_url($url);
79 $PAGE->set_pagelayout('report');
81 require_login($course);
83 // Check basic permission
84 require_capability('report/progress:view',$context);
86 // Get group mode
87 $group = groups_get_course_group($course,true); // Supposed to verify group
88 if ($group===0 && $course->groupmode==SEPARATEGROUPS) {
89     require_capability('moodle/site:accessallgroups',$context);
90 }
92 // Get data on activities and progress of all users, and give error if we've
93 // nothing to display (no users or no activities)
94 $reportsurl = $CFG->wwwroot.'/course/report.php?id='.$course->id;
95 $completion = new completion_info($course);
96 $activities = $completion->get_activities();
98 // Generate where clause
99 $where = array();
100 $where_params = array();
102 if ($sifirst !== 'all') {
103     $where[] = $DB->sql_like('u.firstname', ':sifirst', false);
104     $where_params['sifirst'] = $sifirst.'%';
107 if ($silast !== 'all') {
108     $where[] = $DB->sql_like('u.lastname', ':silast', false);
109     $where_params['silast'] = $silast.'%';
112 // Get user match count
113 $total = $completion->get_num_tracked_users(implode(' AND ', $where), $where_params, $group);
115 // Total user count
116 $grandtotal = $completion->get_num_tracked_users('', array(), $group);
118 // Get user data
119 $progress = array();
121 if ($total) {
122     $progress = $completion->get_progress_all(
123         implode(' AND ', $where),
124         $where_params,
125         $group,
126         $firstnamesort ? 'u.firstname ASC' : 'u.lastname ASC',
127         $csv ? 0 : COMPLETION_REPORT_PAGE,
128         $csv ? 0 : $start,
129         $context
130     );
133 if ($csv && $grandtotal && count($activities)>0) { // Only show CSV if there are some users/actvs
135     $shortname = format_string($course->shortname, true, array('context' => $context));
136     $textlib = textlib_get_instance();
137     header('Content-Disposition: attachment; filename=progress.'.
138         preg_replace('/[^a-z0-9-]/','_',$textlib->strtolower(strip_tags($shortname))).'.csv');
139     // Unicode byte-order mark for Excel
140     if ($excel) {
141         header('Content-Type: text/csv; charset=UTF-16LE');
142         print chr(0xFF).chr(0xFE);
143         $sep="\t".chr(0);
144         $line="\n".chr(0);
145     } else {
146         header('Content-Type: text/csv; charset=UTF-8');
147         $sep=",";
148         $line="\n";
149     }
150 } else {
151     // Use SVG to draw sideways text if supported
152     $svgcleverness = can_use_rotated_text();
154     // Navigation and header
155     $strreports = get_string("reports");
156     $strcompletion = get_string('activitycompletion', 'completion');
158     $PAGE->set_title($strcompletion);
159     $PAGE->set_heading($course->fullname);
160     echo $OUTPUT->header();
162     if ($svgcleverness) {
163         $PAGE->requires->yui2_lib('event');
164         $PAGE->requires->js('/report/progress/textrotate.js');
165     }
167     // Handle groups (if enabled)
168     groups_print_course_menu($course,$CFG->wwwroot.'/report/progress/?course='.$course->id);
171 if (count($activities)==0) {
172     echo $OUTPUT->container(get_string('err_noactivities', 'completion'), 'errorbox errorboxcontent');
173     echo $OUTPUT->footer();
174     exit;
177 // If no users in this course what-so-ever
178 if (!$grandtotal) {
179     echo $OUTPUT->container(get_string('err_nousers', 'completion'), 'errorbox errorboxcontent');
180     echo $OUTPUT->footer();
181     exit;
184 // Build link for paging
185 $link = $CFG->wwwroot.'/report/progress/?course='.$course->id;
186 if (strlen($sort)) {
187     $link .= '&amp;sort='.$sort;
189 $link .= '&amp;start=';
191 // Build the the page by Initial bar
192 $initials = array('first', 'last');
193 $alphabet = explode(',', get_string('alphabet', 'langconfig'));
195 $pagingbar = '';
196 foreach ($initials as $initial) {
197     $var = 'si'.$initial;
199     $othervar = $initial == 'first' ? 'silast' : 'sifirst';
200     $othervar = $$othervar != 'all' ? "&amp;{$othervar}={$$othervar}" : '';
202     $pagingbar .= ' <div class="initialbar '.$initial.'initial">';
203     $pagingbar .= get_string($initial.'name').':&nbsp;';
205     if ($$var == 'all') {
206         $pagingbar .= '<strong>'.get_string('all').'</strong> ';
207     }
208     else {
209         $pagingbar .= "<a href=\"{$link}{$othervar}\">".get_string('all').'</a> ';
210     }
212     foreach ($alphabet as $letter) {
213         if ($$var === $letter) {
214             $pagingbar .= '<strong>'.$letter.'</strong> ';
215         }
216         else {
217             $pagingbar .= "<a href=\"$link&amp;$var={$letter}{$othervar}\">$letter</a> ";
218         }
219     }
221     $pagingbar .= '</div>';
224 // Do we need a paging bar?
225 if ($total > COMPLETION_REPORT_PAGE) {
227     // Paging bar
228     $pagingbar .= '<div class="paging">';
229     $pagingbar .= get_string('page').': ';
231     $sistrings = array();
232     if ($sifirst != 'all') {
233         $sistrings[] =  "sifirst={$sifirst}";
234     }
235     if ($silast != 'all') {
236         $sistrings[] =  "silast={$silast}";
237     }
238     $sistring = !empty($sistrings) ? '&amp;'.implode('&amp;', $sistrings) : '';
240     // Display previous link
241     if ($start > 0) {
242         $pstart = max($start - COMPLETION_REPORT_PAGE, 0);
243         $pagingbar .= "(<a class=\"previous\" href=\"{$link}{$pstart}{$sistring}\">".get_string('previous').'</a>)&nbsp;';
244     }
246     // Create page links
247     $curstart = 0;
248     $curpage = 0;
249     while ($curstart < $total) {
250         $curpage++;
252         if ($curstart == $start) {
253             $pagingbar .= '&nbsp;'.$curpage.'&nbsp;';
254         } else {
255             $pagingbar .= "&nbsp;<a href=\"{$link}{$curstart}{$sistring}\">$curpage</a>&nbsp;";
256         }
258         $curstart += COMPLETION_REPORT_PAGE;
259     }
261     // Display next link
262     $nstart = $start + COMPLETION_REPORT_PAGE;
263     if ($nstart < $total) {
264         $pagingbar .= "&nbsp;(<a class=\"next\" href=\"{$link}{$nstart}{$sistring}\">".get_string('next').'</a>)';
265     }
267     $pagingbar .= '</div>';
270 // Okay, let's draw the table of progress info,
272 // Start of table
273 if (!$csv) {
274     print '<br class="clearer"/>'; // ugh
276     print $pagingbar;
278     if (!$total) {
279         echo $OUTPUT->heading(get_string('nothingtodisplay'));
280         echo $OUTPUT->footer();
281         exit;
282     }
284     print '<table id="completion-progress" class="generaltable flexible boxaligncenter" style="text-align:left"><tr style="vertical-align:top">';
286     // User heading / sort option
287     print '<th scope="col" class="completion-sortchoice">';
289     $sistring = "&amp;silast={$silast}&amp;sifirst={$sifirst}";
291     if ($firstnamesort) {
292         print
293             get_string('firstname')." / <a href=\"./?course={$course->id}{$sistring}\">".
294             get_string('lastname').'</a>';
295     } else {
296         print "<a href=\"./?course={$course->id}&amp;sort=firstname{$sistring}\">".
297             get_string('firstname').'</a> / '.
298             get_string('lastname');
299     }
300     print '</th>';
302     // Print user identity columns
303     foreach ($extrafields as $field) {
304         echo '<th scope="col" class="completion-identifyfield">' .
305                 get_user_field_name($field) . '</th>';
306     }
307 } else {
308     foreach ($extrafields as $field) {
309         echo $sep . csv_quote(get_user_field_name($field));
310     }
313 // Activities
314 foreach($activities as $activity) {
315     $activity->datepassed = $activity->completionexpected && $activity->completionexpected <= time();
316     $activity->datepassedclass=$activity->datepassed ? 'completion-expired' : '';
318     if ($activity->completionexpected) {
319         $datetext=userdate($activity->completionexpected,get_string('strftimedate','langconfig'));
320     } else {
321         $datetext='';
322     }
324     // Some names (labels) come URL-encoded and can be very long, so shorten them
325     $activity->name = shorten_text($activity->name);
327     if ($csv) {
328         print $sep.csv_quote(strip_tags($activity->name)).$sep.csv_quote($datetext);
329     } else {
330         print '<th scope="col" class="'.$activity->datepassedclass.'">'.
331             '<a href="'.$CFG->wwwroot.'/mod/'.$activity->modname.
332             '/view.php?id='.$activity->id.'">'.
333             '<img src="'.$OUTPUT->pix_url('icon', $activity->modname).'" alt="'.
334             get_string('modulename',$activity->modname).'" /> <span class="completion-activityname">'.
335             format_string($activity->name).'</span></a>';
336         if ($activity->completionexpected) {
337             print '<div class="completion-expected"><span>'.$datetext.'</span></div>';
338         }
339         print '</th>';
340     }
343 if ($csv) {
344     print $line;
345 } else {
346     print '</tr>';
349 // Row for each user
350 foreach($progress as $user) {
351     // User name
352     if ($csv) {
353         print csv_quote(fullname($user));
354         foreach ($extrafields as $field) {
355             echo $sep . csv_quote($user->{$field});
356         }
357     } else {
358         print '<tr><th scope="row"><a href="'.$CFG->wwwroot.'/user/view.php?id='.
359             $user->id.'&amp;course='.$course->id.'">'.fullname($user).'</a></th>';
360         foreach ($extrafields as $field) {
361             echo '<td>' . s($user->{$field}) . '</td>';
362         }
363     }
365     // Progress for each activity
366     foreach($activities as $activity) {
368         // Get progress information and state
369         if (array_key_exists($activity->id,$user->progress)) {
370             $thisprogress=$user->progress[$activity->id];
371             $state=$thisprogress->completionstate;
372             $date=userdate($thisprogress->timemodified);
373         } else {
374             $state=COMPLETION_INCOMPLETE;
375             $date='';
376         }
378         // Work out how it corresponds to an icon
379         switch($state) {
380             case COMPLETION_INCOMPLETE : $completiontype='n'; break;
381             case COMPLETION_COMPLETE : $completiontype='y'; break;
382             case COMPLETION_COMPLETE_PASS : $completiontype='pass'; break;
383             case COMPLETION_COMPLETE_FAIL : $completiontype='fail'; break;
384         }
386         $completionicon='completion-'.
387             ($activity->completion==COMPLETION_TRACKING_AUTOMATIC ? 'auto' : 'manual').
388             '-'.$completiontype;
390         $describe=get_string('completion-alt-auto-'.$completiontype,'completion');
391         $a=new StdClass;
392         $a->state=$describe;
393         $a->date=$date;
394         $a->user=fullname($user);
395         $a->activity=strip_tags($activity->name);
396         $fulldescribe=get_string('progress-title','completion',$a);
398         if ($csv) {
399             print $sep.csv_quote($describe).$sep.csv_quote($date);
400         } else {
401             print '<td class="completion-progresscell '.$activity->datepassedclass.'">'.
402                 '<img src="'.$OUTPUT->pix_url('i/'.$completionicon).
403                 '" alt="'.$describe.'" title="'.$fulldescribe.'" /></td>';
404         }
405     }
407     if ($csv) {
408         print $line;
409     } else {
410         print '</tr>';
411     }
414 if ($csv) {
415     exit;
417 print '</table>';
418 print $pagingbar;
420 print '<ul class="progress-actions"><li><a href="index.php?course='.$course->id.
421     '&amp;format=csv">'.get_string('csvdownload','completion').'</a></li>
422     <li><a href="index.php?course='.$course->id.'&amp;format=excelcsv">'.
423     get_string('excelcsvdownload','completion').'</a></li></ul>';
425 echo $OUTPUT->footer();