course/user.php

   1 <?php
   2
   3 // This file is part of Moodle - http://moodle.org/
   4 //
   5 // Moodle is free software: you can redistribute it and/or modify
   6 // it under the terms of the GNU General Public License as published by
   7 // the Free Software Foundation, either version 3 of the License, or
   8 // (at your option) any later version.
   9 //
  10 // Moodle is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 // GNU General Public License for more details.
  14 //
  15 // You should have received a copy of the GNU General Public License
  16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  17
  18 /**
  19  * Display user activity reports for a course
  20  *
  21  * @copyright 1999 Martin Dougiamas  http://dougiamas.com
  22  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23  * @package course
  24  */
  25
  26 require_once("../config.php");
  27 require_once("lib.php");
  28 require_once($CFG->libdir.'/completionlib.php');
  29
  30 $id      = required_param('id',PARAM_INT);       // course id
  31 $user    = required_param('user',PARAM_INT);     // user id
  32 $mode    = optional_param('mode', "todaylogs", PARAM_ALPHA);
  33 $page    = optional_param('page', 0, PARAM_INT);
  34 $perpage = optional_param('perpage', 100, PARAM_INT);
  35
  36 $url = new moodle_url('/course/user.php', array('id'=>$id,'user'=>$user, 'mode'=>$mode));
  37 if ($page !== 0) {
  38     $url->param('page', $page);
  39 }
  40 if ($perpage !== 100) {
  41     $url->param('perpage', $perpage);
  42 }
  43 $PAGE->set_url($url);
  44
  45 if (!$course = $DB->get_record('course', array('id'=>$id))) {
  46     print_error('invalidcourseid', 'error');
  47 }
  48
  49 if (! $user = $DB->get_record("user", array("id"=>$user))) {
  50     print_error('invaliduserid', 'error');
  51 }
  52
  53 require_login();
  54 $coursecontext   = get_context_instance(CONTEXT_COURSE, $course->id);
  55 $personalcontext = get_context_instance(CONTEXT_USER, $user->id);
  56
  57 require_login();
  58 $PAGE->set_pagelayout('admin');
  59 if (has_capability('moodle/user:viewuseractivitiesreport', $personalcontext) and !is_enrolled($coursecontext)) {
  60     // do not require parents to be enrolled in courses ;-)
  61     $PAGE->set_course($course);
  62 } else {
  63     require_login($course);
  64 }
  65
  66 if ($user->deleted) {
  67     echo $OUTPUT->header();
  68     echo $OUTPUT->heading(get_string('userdeleted'));
  69     echo $OUTPUT->footer();
  70     die;
  71 }
  72
  73 // prepare list of allowed modes
  74 $myreports  = ($course->showreports and $USER->id == $user->id);
  75 $anyreport  = has_capability('moodle/user:viewuseractivitiesreport', $personalcontext);
  76
  77 $modes = array();
  78
  79 if ($myreports or $anyreport or has_capability('coursereport/outline:view', $coursecontext)) {
  80     $modes[] = 'outline';
  81 }
  82
  83 if ($myreports or $anyreport or has_capability('coursereport/outline:view', $coursecontext)) {
  84     $modes[] = 'complete';
  85 }
  86
  87 if ($myreports or $anyreport or has_capability('coursereport/log:viewtoday', $coursecontext)) {
  88     $modes[] = 'todaylogs';
  89 }
  90
  91 if ($myreports or $anyreport or has_capability('coursereport/log:view', $coursecontext)) {
  92     $modes[] = 'alllogs';
  93 }
  94
  95 if ($myreports or $anyreport or has_capability('coursereport/stats:view', $coursecontext)) {
  96     $modes[] = 'stats';
  97 }
  98
  99 if (has_capability('moodle/grade:viewall', $coursecontext)) {
 100     //ok - can view all course grades
 101     $modes[] = 'grade';
 102
 103 } else if ($course->showgrades and $user->id == $USER->id and has_capability('moodle/grade:view', $coursecontext)) {
 104     //ok - can view own grades
 105     $modes[] = 'grade';
 106
 107 } else if ($course->showgrades and has_capability('moodle/grade:viewall', $personalcontext)) {
 108     // ok - can view grades of this user - parent most probably
 109     $modes[] = 'grade';
 110
 111 } else if ($course->showgrades and $anyreport) {
 112     // ok - can view grades of this user - parent most probably
 113     $modes[] = 'grade';
 114 }
 115
 116 // Course completion tab
 117 if (!empty($CFG->enablecompletion) && ($course->id == SITEID || !empty($course->enablecompletion)) && // completion enabled
 118     ($myreports || $anyreport || ($course->id == SITEID || has_capability('coursereport/completion:view', $coursecontext)))) { // permissions to view the report
 119
 120     // Decide if singular or plural
 121     if ($course->id == SITEID) {
 122         $modes[] = 'coursecompletions';
 123     } else {
 124         $modes[] = 'coursecompletion';
 125     }
 126 }
 127
 128
 129 if (empty($modes)) {
 130     require_capability('moodle/user:viewuseractivitiesreport', $personalcontext);
 131 }
 132
 133 if (!in_array($mode, $modes)) {
 134     // forbidden or non-existent mode
 135     $mode = reset($modes);
 136 }
 137
 138 add_to_log($course->id, "course", "user report", "user.php?id=$course->id&amp;user=$user->id&amp;mode=$mode", "$user->id");
 139
 140 $stractivityreport = get_string("activityreport");
 141 $strparticipants   = get_string("participants");
 142 $stroutline        = get_string("outline");
 143 $strcomplete       = get_string("complete");
 144 $stralllogs        = get_string("alllogs");
 145 $strtodaylogs      = get_string("todaylogs");
 146 $strmode           = get_string($mode);
 147 $fullname          = fullname($user, true);
 148
 149 $link = null;
 150 if ($course->id != SITEID && has_capability('moodle/course:viewparticipants', $coursecontext)) {
 151     $link = new moodle_url('/user/index.php', array('id'=>$course->id));
 152 }
 153
 154 $PAGE->navigation->extend_for_user($user);
 155 $PAGE->set_title("$course->shortname: $stractivityreport ($mode)");
 156 $PAGE->set_heading($course->fullname);
 157 echo $OUTPUT->header();
 158
 159 switch ($mode) {
 160     case "grade":
 161         if (empty($CFG->grade_profilereport) or !file_exists($CFG->dirroot.'/grade/report/'.$CFG->grade_profilereport.'/lib.php')) {
 162             $CFG->grade_profilereport = 'user';
 163         }
 164         require_once $CFG->libdir.'/gradelib.php';
 165         require_once $CFG->dirroot.'/grade/lib.php';
 166         require_once $CFG->dirroot.'/grade/report/'.$CFG->grade_profilereport.'/lib.php';
 167
 168         $functionname = 'grade_report_'.$CFG->grade_profilereport.'_profilereport';
 169         if (function_exists($functionname)) {
 170             $functionname($course, $user);
 171         }
 172         break;
 173
 174     case "todaylogs" :
 175         echo '<div class="graph">';
 176         print_log_graph($course, $user->id, "userday.png");
 177         echo '</div>';
 178         print_log($course, $user->id, usergetmidnight(time()), "l.time DESC", $page, $perpage,
 179                   "user.php?id=$course->id&amp;user=$user->id&amp;mode=$mode");
 180         break;
 181
 182     case "alllogs" :
 183         echo '<div class="graph">';
 184         print_log_graph($course, $user->id, "usercourse.png");
 185         echo '</div>';
 186         print_log($course, $user->id, 0, "l.time DESC", $page, $perpage,
 187                   "user.php?id=$course->id&amp;user=$user->id&amp;mode=$mode");
 188         break;
 189     case 'stats':
 190
 191         if (empty($CFG->enablestats)) {
 192             print_error('statsdisable', 'error');
 193         }
 194
 195         require_once($CFG->dirroot.'/lib/statslib.php');
 196
 197         $statsstatus = stats_check_uptodate($course->id);
 198         if ($statsstatus !== NULL) {
 199             echo $OUTPUT->notification($statsstatus);
 200         }
 201
 202         $earliestday   = $DB->get_field_sql('SELECT timeend FROM {stats_user_daily} ORDER BY timeend');
 203         $earliestweek  = $DB->get_field_sql('SELECT timeend FROM {stats_user_weekly} ORDER BY timeend');
 204         $earliestmonth = $DB->get_field_sql('SELECT timeend FROM {stats_user_monthly} ORDER BY timeend');
 205
 206         if (empty($earliestday)) $earliestday = time();
 207         if (empty($earliestweek)) $earliestweek = time();
 208         if (empty($earliestmonth)) $earliestmonth = time();
 209
 210         $now = stats_get_base_daily();
 211         $lastweekend = stats_get_base_weekly();
 212         $lastmonthend = stats_get_base_monthly();
 213
 214         $timeoptions = stats_get_time_options($now,$lastweekend,$lastmonthend,$earliestday,$earliestweek,$earliestmonth);
 215
 216         if (empty($timeoptions)) {
 217             print_error('nostatstodisplay', '', $CFG->wwwroot.'/course/user.php?id='.$course->id.'&user='.$user->id.'&mode=outline');
 218         }
 219
 220         // use the earliest.
 221         $time = array_pop(array_keys($timeoptions));
 222
 223         $param = stats_get_parameters($time,STATS_REPORT_USER_VIEW,$course->id,STATS_MODE_DETAILED);
 224         $params = $param->params;
 225
 226         $param->table = 'user_'.$param->table;
 227
 228         $sql = 'SELECT timeend,'.$param->fields.' FROM {stats_'.$param->table.'} WHERE '
 229         .(($course->id == SITEID) ? '' : ' courseid = '.$course->id.' AND ')
 230             .' userid = '.$user->id.' AND timeend >= '.$param->timeafter .$param->extras
 231             .' ORDER BY timeend DESC';
 232         $stats = $DB->get_records_sql($sql, $params); //TODO: improve these params!!
 233
 234         if (empty($stats)) {
 235             print_error('nostatstodisplay', '', $CFG->wwwroot.'/course/user.php?id='.$course->id.'&user='.$user->id.'&mode=outline');
 236         }
 237
 238         // MDL-10818, do not display broken graph when user has no permission to view graph
 239         if ($myreports or has_capability('coursereport/stats:view', $coursecontext)) {
 240             echo '<center><img src="'.$CFG->wwwroot.'/course/report/stats/graph.php?mode='.STATS_MODE_DETAILED.'&course='.$course->id.'&time='.$time.'&report='.STATS_REPORT_USER_VIEW.'&userid='.$user->id.'" alt="'.get_string('statisticsgraph').'" /></center>';
 241         }
 242
 243         // What the heck is this about?   -- MD
 244         $stats = stats_fix_zeros($stats,$param->timeafter,$param->table,(!empty($param->line2)),(!empty($param->line3)));
 245
 246         $table = new html_table();
 247         $table->align = array('left','center','center','center');
 248         $param->table = str_replace('user_','',$param->table);
 249         switch ($param->table) {
 250             case 'daily'  : $period = get_string('day'); break;
 251             case 'weekly' : $period = get_string('week'); break;
 252             case 'monthly': $period = get_string('month', 'form'); break;
 253             default : $period = '';
 254         }
 255         $table->head = array(get_string('periodending','moodle',$period),$param->line1,$param->line2,$param->line3);
 256         foreach ($stats as $stat) {
 257             if (!empty($stat->zerofixed)) {  // Don't know why this is necessary, see stats_fix_zeros above - MD
 258                 continue;
 259             }
 260             $a = array(userdate($stat->timeend,get_string('strftimedate'),$CFG->timezone),$stat->line1);
 261             $a[] = $stat->line2;
 262             $a[] = $stat->line3;
 263             $table->data[] = $a;
 264         }
 265         echo html_writer::table($table);
 266         break;
 267
 268     case "outline" :
 269     case "complete" :
 270         get_all_mods($course->id, $mods, $modnames, $modnamesplural, $modnamesused);
 271         $sections = get_all_sections($course->id);
 272
 273         for ($i=0; $i<=$course->numsections; $i++) {
 274
 275             if (isset($sections[$i])) {   // should always be true
 276
 277                 $section = $sections[$i];
 278                 $showsection = (has_capability('moodle/course:viewhiddensections', $coursecontext) or $section->visible or !$course->hiddensections);
 279
 280                 if ($showsection) { // prevent hidden sections in user activity. Thanks to Geoff Wilbert!
 281
 282                     if ($section->sequence) {
 283                         echo '<div class="section">';
 284                         echo '<h2>';
 285                         echo get_section_name($course, $section);
 286                         echo "</h2>";
 287
 288                         echo '<div class="content">';
 289
 290                         if ($mode == "outline") {
 291                             echo "<table cellpadding=\"4\" cellspacing=\"0\">";
 292                         }
 293
 294                         $sectionmods = explode(",", $section->sequence);
 295                         foreach ($sectionmods as $sectionmod) {
 296                             if (empty($mods[$sectionmod])) {
 297                                 continue;
 298                             }
 299                             $mod = $mods[$sectionmod];
 300
 301                             if (empty($mod->visible)) {
 302                                 continue;
 303                             }
 304
 305                             $instance = $DB->get_record("$mod->modname", array("id"=>$mod->instance));
 306                             $libfile = "$CFG->dirroot/mod/$mod->modname/lib.php";
 307
 308                             if (file_exists($libfile)) {
 309                                 require_once($libfile);
 310
 311                                 switch ($mode) {
 312                                     case "outline":
 313                                         $user_outline = $mod->modname."_user_outline";
 314                                         if (function_exists($user_outline)) {
 315                                             $output = $user_outline($course, $user, $mod, $instance);
 316                                             print_outline_row($mod, $instance, $output);
 317                                         }
 318                                         break;
 319                                     case "complete":
 320                                         $user_complete = $mod->modname."_user_complete";
 321                                         if (function_exists($user_complete)) {
 322                                             $image = $OUTPUT->pix_icon('icon', $mod->modfullname, 'mod_'.$mod->modname, array('class'=>'icon'));
 323                                             echo "<h4>$image $mod->modfullname: ".
 324                                                  "<a href=\"$CFG->wwwroot/mod/$mod->modname/view.php?id=$mod->id\">".
 325                                                  format_string($instance->name,true)."</a></h4>";
 326
 327                                             ob_start();
 328
 329                                             echo "<ul>";
 330                                             $user_complete($course, $user, $mod, $instance);
 331                                             echo "</ul>";
 332
 333                                             $output = ob_get_contents();
 334                                             ob_end_clean();
 335
 336                                             if (str_replace(' ', '', $output) != '<ul></ul>') {
 337                                                 echo $output;
 338                                             }
 339                                         }
 340                                         break;
 341                                     }
 342                                 }
 343                             }
 344
 345                         if ($mode == "outline") {
 346                             echo "</table>";
 347                         }
 348                         echo '</div>';  // content
 349                         echo '</div>';  // section
 350                     }
 351                 }
 352             }
 353         }
 354         break;
 355     case "coursecompletion":
 356     case "coursecompletions":
 357
 358         // Display course completion user report
 359
 360         // Grab all courses the user is enrolled in and their completion status
 361         $sql = "
 362             SELECT DISTINCT
 363                 c.id AS id
 364             FROM
 365                 {course} c
 366             INNER JOIN
 367                 {context} con
 368              ON con.instanceid = c.id
 369             INNER JOIN
 370                 {role_assignments} ra
 371              ON ra.contextid = con.id
 372             INNER JOIN
 373                 {enrol} e
 374              ON c.id = e.courseid
 375             INNER JOIN
 376                 {user_enrolments} ue
 377              ON e.id = ue.enrolid AND ra.userid = ue.userid
 378             AND ra.userid = {$user->id}
 379         ";
 380
 381         // Get roles that are tracked by course completion
 382         if ($roles = $CFG->gradebookroles) {
 383             $sql .= '
 384                 AND ra.roleid IN ('.$roles.')
 385             ';
 386         }
 387
 388         $sql .= '
 389             WHERE
 390                 con.contextlevel = '.CONTEXT_COURSE.'
 391             AND c.enablecompletion = 1
 392         ';
 393
 394
 395         // If we are looking at a specific course
 396         if ($course->id != 1) {
 397             $sql .= '
 398                 AND c.id = '.(int)$course->id.'
 399             ';
 400         }
 401
 402         // Check if result is empty
 403         $rs = $DB->get_recordset_sql($sql);
 404         if (!$rs->valid()) {
 405
 406             if ($course->id != 1) {
 407                 $error = get_string('nocompletions', 'coursereport_completion');
 408             } else {
 409                 $error = get_string('nocompletioncoursesenroled', 'coursereport_completion');
 410             }
 411
 412             echo $OUTPUT->notification($error);
 413             $rs->close(); // not going to loop (but break), close rs
 414             break;
 415         }
 416
 417         // Categorize courses by their status
 418         $courses = array(
 419             'inprogress'    => array(),
 420             'complete'      => array(),
 421             'unstarted'     => array()
 422         );
 423
 424         // Sort courses by the user's status in each
 425         foreach ($rs as $course_completion) {
 426             $c_info = new completion_info((object)$course_completion);
 427
 428             // Is course complete?
 429             $coursecomplete = $c_info->is_course_complete($user->id);
 430
 431             // Has this user completed any criteria?
 432             $criteriacomplete = $c_info->count_course_user_data($user->id);
 433
 434             if ($coursecomplete) {
 435                 $courses['complete'][] = $c_info;
 436             } else if ($criteriacomplete) {
 437                 $courses['inprogress'][] = $c_info;
 438             } else {
 439                 $courses['unstarted'][] = $c_info;
 440             }
 441         }
 442         $rs->close(); // after loop, close rs
 443
 444         // Loop through course status groups
 445         foreach ($courses as $type => $infos) {
 446
 447             // If there are courses with this status
 448             if (!empty($infos)) {
 449
 450                 echo '<h1 align="center">'.get_string($type, 'coursereport_completion').'</h1>';
 451                 echo '<table class="generalbox boxaligncenter">';
 452                 echo '<tr class="ccheader">';
 453                 echo '<th class="c0 header" scope="col">'.get_string('course').'</th>';
 454                 echo '<th class="c1 header" scope="col">'.get_string('requiredcriteria', 'completion').'</th>';
 455                 echo '<th class="c2 header" scope="col">'.get_string('status').'</th>';
 456                 echo '<th class="c3 header" scope="col" width="15%">'.get_string('info').'</th>';
 457
 458                 if ($type === 'complete') {
 459                     echo '<th class="c4 header" scope="col">'.get_string('completiondate', 'coursereport_completion').'</th>';
 460                 }
 461
 462                 echo '</tr>';
 463
 464                 // For each course
 465                 foreach ($infos as $c_info) {
 466
 467                     // Get course info
 468                     $c_course = $DB->get_record('course', array('id' => $c_info->course_id));
 469                     $course_name = $c_course->fullname;
 470
 471                     // Get completions
 472                     $completions = $c_info->get_completions($user->id);
 473
 474                     // Save row data
 475                     $rows = array();
 476
 477                     // For aggregating activity completion
 478                     $activities = array();
 479                     $activities_complete = 0;
 480
 481                     // For aggregating prerequisites
 482                     $prerequisites = array();
 483                     $prerequisites_complete = 0;
 484
 485                     // Loop through course criteria
 486                     foreach ($completions as $completion) {
 487                         $criteria = $completion->get_criteria();
 488                         $complete = $completion->is_complete();
 489
 490                         // Activities are a special case, so cache them and leave them till last
 491                         if ($criteria->criteriatype == COMPLETION_CRITERIA_TYPE_ACTIVITY) {
 492                             $activities[$criteria->moduleinstance] = $complete;
 493
 494                             if ($complete) {
 495                                 $activities_complete++;
 496                             }
 497
 498                             continue;
 499                         }
 500
 501                         // Prerequisites are also a special case, so cache them and leave them till last
 502                         if ($criteria->criteriatype == COMPLETION_CRITERIA_TYPE_COURSE) {
 503                             $prerequisites[$criteria->courseinstance] = $complete;
 504
 505                             if ($complete) {
 506                                 $prerequisites_complete++;
 507                             }
 508
 509                             continue;
 510                         }
 511
 512                         $row = array();
 513                         $row['title'] = $criteria->get_title();
 514                         $row['status'] = $completion->get_status();
 515                         $rows[] = $row;
 516                     }
 517
 518                     // Aggregate activities
 519                     if (!empty($activities)) {
 520
 521                         $row = array();
 522                         $row['title'] = get_string('activitiescomplete', 'coursereport_completion');
 523                         $row['status'] = $activities_complete.' of '.count($activities);
 524                         $rows[] = $row;
 525                     }
 526
 527                     // Aggregate prerequisites
 528                     if (!empty($prerequisites)) {
 529
 530                         $row = array();
 531                         $row['title'] = get_string('prerequisitescompleted', 'completion');
 532                         $row['status'] = $prerequisites_complete.' of '.count($prerequisites);
 533                         array_splice($rows, 0, 0, array($row));
 534                     }
 535
 536                     $first_row = true;
 537
 538                     // Print table
 539                     foreach ($rows as $row) {
 540
 541                         // Display course name on first row
 542                         if ($first_row) {
 543                             echo '<tr><td class="c0"><a href="'.$CFG->wwwroot.'/course/view.php?id='.$c_course->id.'">'.format_string($course_name).'</a></td>';
 544                         } else {
 545                             echo '<tr><td class="c0"></td>';
 546                         }
 547
 548                         echo '<td class="c1">';
 549                         echo $row['title'];
 550                         echo '</td><td class="c2">';
 551
 552                         switch ($row['status']) {
 553                             case 'Yes':
 554                                 echo get_string('complete');
 555                                 break;
 556
 557                             case 'No':
 558                                 echo get_string('incomplete', 'coursereport_completion');
 559                                 break;
 560
 561                             default:
 562                                 echo $row['status'];
 563                         }
 564
 565                         // Display link on first row
 566                         echo '</td><td class="c3">';
 567                         if ($first_row) {
 568                             echo '<a href="'.$CFG->wwwroot.'/blocks/completionstatus/details.php?course='.$c_course->id.'&user='.$user->id.'">'.get_string('detailedview', 'coursereport_completion').'</a>';
 569                         }
 570                         echo '</td>';
 571
 572                         // Display completion date for completed courses on first row
 573                         if ($type === 'complete' && $first_row) {
 574                             $params = array(
 575                                 'userid'    => $user->id,
 576                                 'course'  => $c_course->id
 577                             );
 578
 579                             $ccompletion = new completion_completion($params);
 580                             echo '<td class="c4">'.userdate($ccompletion->timecompleted, '%e %B %G').'</td>';
 581                         }
 582
 583                         $first_row = false;
 584                         echo '</tr>';
 585                     }
 586                 }
 587
 588                 echo '</table>';
 589             }
 590
 591         }
 592
 593         break;
 594     default:
 595         // can not be reached ;-)
 596 }
 597
 598
 599 echo $OUTPUT->footer();
 600
 601
 602 function print_outline_row($mod, $instance, $result) {
 603     global $OUTPUT;
 604
 605     $image = "<img src=\"" . $OUTPUT->pix_url('icon', $mod->modname) . "\" class=\"icon\" alt=\"$mod->modfullname\" />";
 606
 607     echo "<tr>";
 608     echo "<td valign=\"top\">$image</td>";
 609     echo "<td valign=\"top\" style=\"width:300\">";
 610     echo "   <a title=\"$mod->modfullname\"";
 611     echo "   href=\"../mod/$mod->modname/view.php?id=$mod->id\">".format_string($instance->name,true)."</a></td>";
 612     echo "<td>&nbsp;&nbsp;&nbsp;</td>";
 613     echo "<td valign=\"top\">";
 614     if (isset($result->info)) {
 615         echo "$result->info";
 616     } else {
 617         echo "<p style=\"text-align:center\">-</p>";
 618     }
 619     echo "</td>";
 620     echo "<td>&nbsp;&nbsp;&nbsp;</td>";
 621     if (!empty($result->time)) {
 622         $timeago = format_time(time() - $result->time);
 623         echo "<td valign=\"top\" style=\"white-space: nowrap\">".userdate($result->time)." ($timeago)</td>";
 624     }
 625     echo "</tr>";
 626 }
 627