course/report/progress/index.php

   1 <?php
   2 require_once('../../../config.php');
   3 require_once($CFG->libdir . '/completionlib.php');
   4
   5 define('COMPLETION_REPORT_PAGE', 25);
   6
   7 // Get course
   8 $id = required_param('course',PARAM_INT);
   9 $course=$DB->get_record('course',array('id'=>$id));
  10 if(!$course) {
  11     print_error('invalidcourseid');
  12 }
  13
  14 // Sort (default lastname, optionally firstname)
  15 $sort = optional_param('sort','',PARAM_ALPHA);
  16 $firstnamesort = $sort == 'firstname';
  17
  18 // CSV format
  19 $format = optional_param('format','',PARAM_ALPHA);
  20 $excel = $format == 'excelcsv';
  21 $csv = $format == 'csv' || $excel;
  22
  23 // Paging
  24 $start   = optional_param('start', 0, PARAM_INT);
  25 $sifirst = optional_param('sifirst', 'all', PARAM_ALPHA);
  26 $silast  = optional_param('silast', 'all', PARAM_ALPHA);
  27 $start = optional_param('start',0,PARAM_INT);
  28
  29 // Whether to show idnumber
  30 // TODO: This should really not be using a config option 'intended' for
  31 // gradebook, but that option is also used in quiz reports as well. There ought
  32 // to be a generic option somewhere.
  33 $idnumbers = $CFG->grade_report_showuseridnumber;
  34
  35 function csv_quote($value) {
  36     global $excel;
  37     if($excel) {
  38         $tl=textlib_get_instance();
  39         return $tl->convert('"'.str_replace('"',"'",$value).'"','UTF-8','UTF-16LE');
  40     } else {
  41         return '"'.str_replace('"',"'",$value).'"';
  42     }
  43 }
  44
  45 $url = new moodle_url('/course/report/progress/index.php', array('course'=>$id));
  46 if ($sort !== '') {
  47     $url->param('sort', $sort);
  48 }
  49 if ($format !== '') {
  50     $url->param('format', $format);
  51 }
  52 if ($start !== 0) {
  53     $url->param('start', $start);
  54 }
  55 $PAGE->set_url($url);
  56 $PAGE->set_pagelayout('report');
  57
  58 require_login($course);
  59
  60 // Check basic permission
  61 $context=get_context_instance(CONTEXT_COURSE,$course->id);
  62 require_capability('coursereport/progress:view',$context);
  63
  64 // Get group mode
  65 $group=groups_get_course_group($course,true); // Supposed to verify group
  66 if($group===0 && $course->groupmode==SEPARATEGROUPS) {
  67     require_capability('moodle/site:accessallgroups',$context);
  68 }
  69
  70 // Get data on activities and progress of all users, and give error if we've
  71 // nothing to display (no users or no activities)
  72 $reportsurl=$CFG->wwwroot.'/course/report.php?id='.$course->id;
  73 $completion=new completion_info($course);
  74 $activities=$completion->get_activities();
  75
  76 // Generate where clause
  77 $where = array();
  78 $where_params = array();
  79
  80 if ($sifirst !== 'all') {
  81     $where[] = $DB->sql_like('u.firstname', ':sifirst', false);
  82     $where_params['sifirst'] = $sifirst.'%';
  83 }
  84
  85 if ($silast !== 'all') {
  86     $where[] = $DB->sql_like('u.lastname', ':silast', false);
  87     $where_params['silast'] = $silast.'%';
  88 }
  89
  90 // Get user match count
  91 $total = $completion->get_num_tracked_users(implode(' AND ', $where), $where_params, $group);
  92
  93 // Total user count
  94 $grandtotal = $completion->get_num_tracked_users('', array(), $group);
  95
  96 // Get user data
  97 $progress = array();
  98
  99 if ($total) {
 100     $progress = $completion->get_progress_all(
 101         implode(' AND ', $where),
 102         $where_params,
 103         $group,
 104         $firstnamesort ? 'u.firstname ASC' : 'u.lastname ASC',
 105         $csv ? 0 : COMPLETION_REPORT_PAGE,
 106         $csv ? 0 : $start
 107     );
 108 }
 109
 110 if($csv && $grandtotal && count($activities)>0) { // Only show CSV if there are some users/actvs
 111
 112     $shortname = format_string($course->shortname, true, array('context' => $context));
 113     $textlib = textlib_get_instance();
 114     header('Content-Disposition: attachment; filename=progress.'.
 115         preg_replace('/[^a-z0-9-]/','_',$textlib->strtolower(strip_tags($shortname))).'.csv');
 116     // Unicode byte-order mark for Excel
 117     if($excel) {
 118         header('Content-Type: text/csv; charset=UTF-16LE');
 119         print chr(0xFF).chr(0xFE);
 120         $sep="\t".chr(0);
 121         $line="\n".chr(0);
 122     } else {
 123         header('Content-Type: text/csv; charset=UTF-8');
 124         $sep=",";
 125         $line="\n";
 126     }
 127 } else {
 128     // Use SVG to draw sideways text if supported
 129     $svgcleverness = can_use_rotated_text();
 130
 131     // Navigation and header
 132     $strreports = get_string("reports");
 133     $strcompletion = get_string('activitycompletion', 'completion');
 134
 135     $PAGE->set_title($strcompletion);
 136     $PAGE->set_heading($course->fullname);
 137     echo $OUTPUT->header();
 138
 139     if($svgcleverness) {
 140         $PAGE->requires->yui2_lib('event');
 141         $PAGE->requires->js('/course/report/progress/textrotate.js');
 142     }
 143
 144     // Handle groups (if enabled)
 145     groups_print_course_menu($course,$CFG->wwwroot.'/course/report/progress/?course='.$course->id);
 146 }
 147
 148 if(count($activities)==0) {
 149     echo $OUTPUT->container(get_string('err_noactivities', 'completion'), 'errorbox errorboxcontent');
 150     echo $OUTPUT->footer();
 151     exit;
 152 }
 153
 154 // If no users in this course what-so-ever
 155 if (!$grandtotal) {
 156     echo $OUTPUT->container(get_string('err_nousers', 'completion'), 'errorbox errorboxcontent');
 157     echo $OUTPUT->footer();
 158     exit;
 159 }
 160
 161 // Build link for paging
 162 $link = $CFG->wwwroot.'/course/report/progress/?course='.$course->id;
 163 if (strlen($sort)) {
 164     $link .= '&amp;sort='.$sort;
 165 }
 166 $link .= '&amp;start=';
 167
 168 // Build the the page by Initial bar
 169 $initials = array('first', 'last');
 170 $alphabet = explode(',', get_string('alphabet', 'langconfig'));
 171
 172 $pagingbar = '';
 173 foreach ($initials as $initial) {
 174     $var = 'si'.$initial;
 175
 176     $othervar = $initial == 'first' ? 'silast' : 'sifirst';
 177     $othervar = $$othervar != 'all' ? "&amp;{$othervar}={$$othervar}" : '';
 178
 179     $pagingbar .= ' <div class="initialbar '.$initial.'initial">';
 180     $pagingbar .= get_string($initial.'name').':&nbsp;';
 181
 182     if ($$var == 'all') {
 183         $pagingbar .= '<strong>'.get_string('all').'</strong> ';
 184     }
 185     else {
 186         $pagingbar .= "<a href=\"{$link}{$othervar}\">".get_string('all').'</a> ';
 187     }
 188
 189     foreach ($alphabet as $letter) {
 190         if ($$var === $letter) {
 191             $pagingbar .= '<strong>'.$letter.'</strong> ';
 192         }
 193         else {
 194             $pagingbar .= "<a href=\"$link&amp;$var={$letter}{$othervar}\">$letter</a> ";
 195         }
 196     }
 197
 198     $pagingbar .= '</div>';
 199 }
 200
 201 // Do we need a paging bar?
 202 if($total > COMPLETION_REPORT_PAGE) {
 203
 204     // Paging bar
 205     $pagingbar .= '<div class="paging">';
 206     $pagingbar .= get_string('page').': ';
 207
 208     $sistrings = array();
 209     $sistrings[] = $sifirst != 'all' ? "sifirst={$sifirst}" : null;
 210     $sistrings[] = $silast != 'all' ? "silast={$silast}" : null;
 211     $sistring = !empty($sistrings) ? implode('&amp;', $sistrings) : '';
 212
 213     // Display previous link
 214     if ($start > 0) {
 215         $pstart = max($start - COMPLETION_REPORT_PAGE, 0);
 216         $pagingbar .= "(<a class=\"previous\" href=\"{$link}{$pstart}{$sistring}\">".get_string('previous').'</a>)&nbsp;';
 217     }
 218
 219     // Create page links
 220     $curstart = 0;
 221     $curpage = 0;
 222     while ($curstart < $total) {
 223         $curpage++;
 224
 225         if ($curstart == $start) {
 226             $pagingbar .= '&nbsp;'.$curpage.'&nbsp;';
 227         }
 228         else {
 229             $pagingbar .= "&nbsp;<a href=\"{$link}{$curstart}{$sistring}\">$curpage</a>&nbsp;";
 230         }
 231
 232         $curstart += COMPLETION_REPORT_PAGE;
 233     }
 234
 235     // Display next link
 236     $nstart = $start + COMPLETION_REPORT_PAGE;
 237     if ($nstart < $total) {
 238         $pagingbar .= "&nbsp;(<a class=\"next\" href=\"{$link}{$nstart}{$sistring}\">".get_string('next').'</a>)';
 239     }
 240
 241     $pagingbar .= '</div>';
 242 }
 243
 244 // Okay, let's draw the table of progress info,
 245
 246 // Start of table
 247 if(!$csv) {
 248     print '<br class="clearer"/>'; // ugh
 249
 250     print $pagingbar;
 251
 252     if (!$total) {
 253         echo $OUTPUT->heading(get_string('nothingtodisplay'));
 254         echo $OUTPUT->footer();
 255         exit;
 256     }
 257
 258     print '<table id="completion-progress" class="generaltable flexible boxaligncenter" style="text-align:left"><tr style="vertical-align:top">';
 259
 260     // User heading / sort option
 261     print '<th scope="col" class="completion-sortchoice">';
 262
 263     $sistring = "&amp;silast={$silast}&amp;sifirst={$sifirst}";
 264
 265     if($firstnamesort) {
 266         print
 267             get_string('firstname')." / <a href=\"./?course={$course->id}{$sistring}\">".
 268             get_string('lastname').'</a>';
 269     } else {
 270         print "<a href=\"./?course={$course->id}&amp;sort=firstname{$sistring}\">".
 271             get_string('firstname').'</a> / '.
 272             get_string('lastname');
 273     }
 274     print '</th>';
 275
 276     if($idnumbers) {
 277         print '<th>'.get_string('idnumber').'</th>';
 278     }
 279
 280 } else {
 281     if($idnumbers) {
 282         print $sep;
 283     }
 284 }
 285
 286 // Activities
 287 foreach($activities as $activity) {
 288     $activity->datepassed = $activity->completionexpected && $activity->completionexpected <= time();
 289     $activity->datepassedclass=$activity->datepassed ? 'completion-expired' : '';
 290
 291     if($activity->completionexpected) {
 292         $datetext=userdate($activity->completionexpected,get_string('strftimedate','langconfig'));
 293     } else {
 294         $datetext='';
 295     }
 296
 297     // Some names (labels) come URL-encoded and can be very long, so shorten them
 298     $activity->name = shorten_text($activity->name);
 299
 300     if($csv) {
 301         print $sep.csv_quote(strip_tags($activity->name)).$sep.csv_quote($datetext);
 302     } else {
 303         print '<th scope="col" class="'.$activity->datepassedclass.'">'.
 304             '<a href="'.$CFG->wwwroot.'/mod/'.$activity->modname.
 305             '/view.php?id='.$activity->id.'">'.
 306             '<img src="'.$OUTPUT->pix_url('icon', $activity->modname).'" alt="'.
 307             get_string('modulename',$activity->modname).'" /> <span class="completion-activityname">'.
 308             format_string($activity->name).'</span></a>';
 309         if($activity->completionexpected) {
 310             print '<div class="completion-expected"><span>'.$datetext.'</span></div>';
 311         }
 312         print '</th>';
 313     }
 314 }
 315
 316 if($csv) {
 317     print $line;
 318 } else {
 319     print '</tr>';
 320 }
 321
 322 // Row for each user
 323 foreach($progress as $user) {
 324     // User name
 325     if($csv) {
 326         print csv_quote(fullname($user));
 327         if($idnumbers) {
 328             print $sep.csv_quote($user->idnumber);
 329         }
 330     } else {
 331         print '<tr><th scope="row"><a href="'.$CFG->wwwroot.'/user/view.php?id='.
 332             $user->id.'&amp;course='.$course->id.'">'.fullname($user).'</a></th>';
 333         if($idnumbers) {
 334             print '<td>'.htmlspecialchars($user->idnumber).'</td>';
 335         }
 336     }
 337
 338     // Progress for each activity
 339     foreach($activities as $activity) {
 340
 341         // Get progress information and state
 342         if(array_key_exists($activity->id,$user->progress)) {
 343             $thisprogress=$user->progress[$activity->id];
 344             $state=$thisprogress->completionstate;
 345             $date=userdate($thisprogress->timemodified);
 346         } else {
 347             $state=COMPLETION_INCOMPLETE;
 348             $date='';
 349         }
 350
 351         // Work out how it corresponds to an icon
 352         switch($state) {
 353             case COMPLETION_INCOMPLETE : $completiontype='n'; break;
 354             case COMPLETION_COMPLETE : $completiontype='y'; break;
 355             case COMPLETION_COMPLETE_PASS : $completiontype='pass'; break;
 356             case COMPLETION_COMPLETE_FAIL : $completiontype='fail'; break;
 357         }
 358
 359         $completionicon='completion-'.
 360             ($activity->completion==COMPLETION_TRACKING_AUTOMATIC ? 'auto' : 'manual').
 361             '-'.$completiontype;
 362
 363         $describe=get_string('completion-alt-auto-'.$completiontype,'completion');
 364         $a=new StdClass;
 365         $a->state=$describe;
 366         $a->date=$date;
 367         $a->user=fullname($user);
 368         $a->activity=strip_tags($activity->name);
 369         $fulldescribe=get_string('progress-title','completion',$a);
 370
 371         if($csv) {
 372             print $sep.csv_quote($describe).$sep.csv_quote($date);
 373         } else {
 374             print '<td class="completion-progresscell '.$activity->datepassedclass.'">'.
 375                 '<img src="'.$OUTPUT->pix_url('i/'.$completionicon).
 376                 '" alt="'.$describe.'" title="'.$fulldescribe.'" /></td>';
 377         }
 378     }
 379
 380     if($csv) {
 381         print $line;
 382     } else {
 383         print '</tr>';
 384     }
 385 }
 386
 387 if($csv) {
 388     exit;
 389 }
 390 print '</table>';
 391 print $pagingbar;
 392
 393 print '<ul class="progress-actions"><li><a href="index.php?course='.$course->id.
 394     '&amp;format=csv">'.get_string('csvdownload','completion').'</a></li>
 395     <li><a href="index.php?course='.$course->id.'&amp;format=excelcsv">'.
 396     get_string('excelcsvdownload','completion').'</a></li></ul>';
 397
 398 echo $OUTPUT->footer();
 399