[ Index ]

PHP Cross Reference of Unnamed Project

title

Body

[close]

/report/participation/ -> index.php (source)

   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/>.
  16  
  17  /**
  18   * Participation report
  19   *
  20   * @package    report
  21   * @subpackage participation
  22   * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
  23   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24   */
  25  
  26  require('../../config.php');
  27  require_once($CFG->dirroot.'/lib/tablelib.php');
  28  require_once($CFG->dirroot.'/report/participation/locallib.php');
  29  
  30  define('DEFAULT_PAGE_SIZE', 20);
  31  define('SHOW_ALL_PAGE_SIZE', 5000);
  32  
  33  $id         = required_param('id', PARAM_INT); // course id.
  34  $roleid     = optional_param('roleid', 0, PARAM_INT); // which role to show
  35  $instanceid = optional_param('instanceid', 0, PARAM_INT); // instance we're looking at.
  36  $timefrom   = optional_param('timefrom', 0, PARAM_INT); // how far back to look...
  37  $action     = optional_param('action', '', PARAM_ALPHA);
  38  $page       = optional_param('page', 0, PARAM_INT);                     // which page to show
  39  $perpage    = optional_param('perpage', DEFAULT_PAGE_SIZE, PARAM_INT);  // how many per page
  40  $currentgroup = optional_param('group', null, PARAM_INT); // Get the active group.
  41  
  42  $url = new moodle_url('/report/participation/index.php', array('id'=>$id));
  43  if ($roleid !== 0) $url->param('roleid');
  44  if ($instanceid !== 0) $url->param('instanceid');
  45  if ($timefrom !== 0) $url->param('timefrom');
  46  if ($action !== '') $url->param('action');
  47  if ($page !== 0) $url->param('page');
  48  if ($perpage !== DEFAULT_PAGE_SIZE) $url->param('perpage');
  49  $PAGE->set_url($url);
  50  $PAGE->set_pagelayout('admin');
  51  
  52  if ($action != 'view' and $action != 'post') {
  53      $action = ''; // default to all (don't restrict)
  54  }
  55  
  56  if (!$course = $DB->get_record('course', array('id'=>$id))) {
  57      print_error('invalidcourse');
  58  }
  59  
  60  if ($roleid != 0 and !$role = $DB->get_record('role', array('id'=>$roleid))) {
  61      print_error('invalidrole');
  62  }
  63  
  64  require_login($course);
  65  $context = context_course::instance($course->id);
  66  require_capability('report/participation:view', $context);
  67  
  68  $strparticipation = get_string('participationreport');
  69  $strviews         = get_string('views');
  70  $strposts         = get_string('posts');
  71  $strreports       = get_string('reports');
  72  
  73  $actionoptions = report_participation_get_action_options();
  74  if (!array_key_exists($action, $actionoptions)) {
  75      $action = '';
  76  }
  77  
  78  $PAGE->set_title($course->shortname .': '. $strparticipation);
  79  $PAGE->set_heading($course->fullname);
  80  echo $OUTPUT->header();
  81  
  82  $uselegacyreader = false; // Use legacy reader with sql_internal_table_reader to aggregate records.
  83  $onlyuselegacyreader = false; // Use only legacy log table to aggregate records.
  84  
  85  $logtable = report_participation_get_log_table_name(); // Log table to use for fetaching records.
  86  
  87  // If no log table, then use legacy records.
  88  if (empty($logtable)) {
  89      $onlyuselegacyreader = true;
  90  }
  91  
  92  // If no legacy and no logtable then don't proceed.
  93  if (!$onlyuselegacyreader && empty($logtable)) {
  94      echo $OUTPUT->box_start('generalbox', 'notice');
  95      echo get_string('nologreaderenabled', 'report_participation');
  96      echo $OUTPUT->box_end();
  97      echo $OUTPUT->footer();
  98      die();
  99  }
 100  
 101  $modinfo = get_fast_modinfo($course);
 102  
 103  $minloginternalreader = 0; // Time of first record in sql_internal_table_reader.
 104  
 105  if ($onlyuselegacyreader) {
 106      // If no sql_inrenal_reader enabled then get min. time from log table.
 107      $minlog = $DB->get_field_sql('SELECT min(time) FROM {log} WHERE course = ?', array($course->id));
 108  } else {
 109      $uselegacyreader = true;
 110      $minlog = $DB->get_field_sql('SELECT min(time) FROM {log} WHERE course = ?', array($course->id));
 111  
 112      // If legacy reader is not logging then get data from new log table.
 113      // Get minimum log time for this course from preferred log reader.
 114      $minloginternalreader = $DB->get_field_sql('SELECT min(timecreated) FROM {' . $logtable . '}
 115                                                   WHERE courseid = ?', array($course->id));
 116      // If new log store has oldest data then don't use old log table.
 117      if (empty($minlog) || ($minloginternalreader <= $minlog)) {
 118          $uselegacyreader = false;
 119          $minlog = $minloginternalreader;
 120      }
 121  
 122      // If timefrom is greater then first record in sql_internal_table_reader then get record from sql_internal_table_reader only.
 123      if (!empty($timefrom) && ($minloginternalreader < $timefrom)) {
 124          $uselegacyreader = false;
 125      }
 126  }
 127  
 128  // Print first controls.
 129  report_participation_print_filter_form($course, $timefrom, $minlog, $action, $roleid, $instanceid);
 130  
 131  $baseurl = new moodle_url('/report/participation/index.php', array(
 132      'id' => $course->id,
 133      'roleid' => $roleid,
 134      'instanceid' => $instanceid,
 135      'timefrom' => $timefrom,
 136      'action' => $action,
 137      'perpage' => $perpage,
 138      'group' => $currentgroup
 139  ));
 140  $select = groups_allgroups_course_menu($course, $baseurl, true, $currentgroup);
 141  
 142  // User cannot see any group.
 143  if (empty($select)) {
 144      echo $OUTPUT->heading(get_string("notingroup"));
 145      echo $OUTPUT->footer();
 146      exit;
 147  } else {
 148      echo $select;
 149  }
 150  
 151  // Fetch current active group.
 152  $groupmode = groups_get_course_groupmode($course);
 153  $currentgroup = $SESSION->activegroup[$course->id][$groupmode][$course->defaultgroupingid];
 154  
 155  if (!empty($instanceid) && !empty($roleid)) {
 156  
 157      // Trigger a report viewed event.
 158      $event = \report_participation\event\report_viewed::create(array('context' => $context,
 159              'other' => array('instanceid' => $instanceid, 'groupid' => $currentgroup, 'roleid' => $roleid,
 160              'timefrom' => $timefrom, 'action' => $action)));
 161      $event->trigger();
 162  
 163      // from here assume we have at least the module we're using.
 164      $cm = $modinfo->cms[$instanceid];
 165  
 166      // Group security checks.
 167      if (!groups_group_visible($currentgroup, $course, $cm)) {
 168          echo $OUTPUT->heading(get_string("notingroup"));
 169          echo $OUTPUT->footer();
 170          exit;
 171      }
 172  
 173      $table = new flexible_table('course-participation-'.$course->id.'-'.$cm->id.'-'.$roleid);
 174      $table->course = $course;
 175  
 176      $actionheader = !empty($action) ? get_string($action) : get_string('allactions');
 177  
 178      if (empty($CFG->messaging)) {
 179          $table->define_columns(array('fullname', 'count'));
 180          $table->define_headers(array(get_string('user'), $actionheader));
 181      } else {
 182          $table->define_columns(array('fullname', 'count', 'select'));
 183          $table->define_headers(array(get_string('user'), $actionheader, get_string('select')));
 184      }
 185      $table->define_baseurl($baseurl);
 186  
 187      $table->set_attribute('cellpadding','5');
 188      $table->set_attribute('class', 'generaltable generalbox reporttable');
 189  
 190      $table->sortable(true,'lastname','ASC');
 191      $table->no_sorting('select');
 192  
 193      $table->set_control_variables(array(
 194                                          TABLE_VAR_SORT    => 'ssort',
 195                                          TABLE_VAR_HIDE    => 'shide',
 196                                          TABLE_VAR_SHOW    => 'sshow',
 197                                          TABLE_VAR_IFIRST  => 'sifirst',
 198                                          TABLE_VAR_ILAST   => 'silast',
 199                                          TABLE_VAR_PAGE    => 'spage'
 200                                          ));
 201      $table->setup();
 202  
 203      // We want to query both the current context and parent contexts.
 204      list($relatedctxsql, $params) = $DB->get_in_or_equal($context->get_parent_context_ids(true), SQL_PARAMS_NAMED, 'relatedctx');
 205      $params['roleid'] = $roleid;
 206      $params['instanceid'] = $instanceid;
 207      $params['timefrom'] = $timefrom;
 208  
 209      $groupsql = "";
 210      if (!empty($currentgroup)) {
 211          $groupsql = "JOIN {groups_members} gm ON (gm.userid = u.id AND gm.groupid = :groupid)";
 212          $params['groupid'] = $currentgroup;
 213      }
 214  
 215      $countsql = "SELECT COUNT(DISTINCT(ra.userid))
 216                     FROM {role_assignments} ra
 217                     JOIN {user} u ON u.id = ra.userid
 218                     $groupsql
 219                    WHERE ra.contextid $relatedctxsql AND ra.roleid = :roleid";
 220  
 221      $totalcount = $DB->count_records_sql($countsql, $params);
 222  
 223      list($twhere, $tparams) = $table->get_sql_where();
 224      if ($twhere) {
 225          $params = array_merge($params, $tparams);
 226          $matchcount = $DB->count_records_sql($countsql.' AND '.$twhere, $params);
 227      } else {
 228          $matchcount = $totalcount;
 229      }
 230  
 231      $modulename = get_string('modulename', $cm->modname);
 232      echo '<div id="participationreport">' . "\n";
 233      echo '<p class="modulename">' . $modulename . ' ' . $strviews . '<br />'."\n"
 234          . $modulename . ' ' . $strposts . '</p>'."\n";
 235  
 236      $table->initialbars($totalcount > $perpage);
 237      $table->pagesize($perpage, $matchcount);
 238  
 239      if ($uselegacyreader || $onlyuselegacyreader) {
 240          list($actionsql, $actionparams) = report_participation_get_action_sql($action, $cm->modname);
 241          $params = array_merge($params, $actionparams);
 242      }
 243  
 244      if (!$onlyuselegacyreader) {
 245          list($crudsql, $crudparams) = report_participation_get_crud_sql($action);
 246          $params = array_merge($params, $crudparams);
 247      }
 248  
 249      $usernamefields = get_all_user_name_fields(true, 'u');
 250      $users = array();
 251      // If using legacy log then get users from old table.
 252      if ($uselegacyreader || $onlyuselegacyreader) {
 253          $limittime = '';
 254          if ($uselegacyreader && !empty($minloginternalreader)) {
 255              $limittime = ' AND time < :tilltime ';
 256              $params['tilltime'] = $minloginternalreader;
 257          }
 258          $sql = "SELECT ra.userid, $usernamefields, u.idnumber, l.actioncount AS count
 259                    FROM (SELECT DISTINCT userid FROM {role_assignments} WHERE contextid $relatedctxsql AND roleid = :roleid ) ra
 260                    JOIN {user} u ON u.id = ra.userid
 261               $groupsql
 262               LEFT JOIN (
 263                      SELECT userid, COUNT(action) AS actioncount
 264                        FROM {log}
 265                       WHERE cmid = :instanceid
 266                             AND time > :timefrom " . $limittime . $actionsql .
 267                  " GROUP BY userid) l ON (l.userid = ra.userid)";
 268          if ($twhere) {
 269              $sql .= ' WHERE '.$twhere; // Initial bar.
 270          }
 271  
 272          if ($table->get_sql_sort()) {
 273              $sql .= ' ORDER BY '.$table->get_sql_sort();
 274          }
 275          if (!$users = $DB->get_records_sql($sql, $params, $table->get_page_start(), $table->get_page_size())) {
 276              $users = array(); // Tablelib will handle saying 'Nothing to display' for us.
 277          }
 278      }
 279  
 280      // Get record from sql_internal_table_reader and merge with records got from legacy log (if needed).
 281      if (!$onlyuselegacyreader) {
 282          $sql = "SELECT ra.userid, $usernamefields, u.idnumber, COUNT(DISTINCT l.timecreated) AS count
 283                    FROM {user} u
 284                    JOIN {role_assignments} ra ON u.id = ra.userid AND ra.contextid $relatedctxsql AND ra.roleid = :roleid
 285               $groupsql
 286                    LEFT JOIN {" . $logtable . "} l
 287                       ON l.contextinstanceid = :instanceid
 288                         AND l.timecreated > :timefrom" . $crudsql ."
 289                         AND l.edulevel = :edulevel
 290                         AND l.anonymous = 0
 291                         AND l.contextlevel = :contextlevel
 292                         AND (l.origin = 'web' OR l.origin = 'ws')
 293                         AND l.userid = ra.userid";
 294          // We add this after the WHERE statement that may come below.
 295          $groupbysql = " GROUP BY ra.userid, $usernamefields, u.idnumber";
 296  
 297          $params['edulevel'] = core\event\base::LEVEL_PARTICIPATING;
 298          $params['contextlevel'] = CONTEXT_MODULE;
 299  
 300          if ($twhere) {
 301              $sql .= ' WHERE '.$twhere; // Initial bar.
 302          }
 303          $sql .= $groupbysql;
 304          if ($table->get_sql_sort()) {
 305              $sql .= ' ORDER BY '.$table->get_sql_sort();
 306          }
 307          if ($u = $DB->get_records_sql($sql, $params, $table->get_page_start(), $table->get_page_size())) {
 308              if (empty($users)) {
 309                  $users = $u;
 310              } else {
 311                  // Merge two users array.
 312                  foreach ($u as $key => $value) {
 313                      if (isset($users[$key]) && !empty($users[$key]->count)) {
 314                          if ($value->count) {
 315                              $users[$key]->count += $value->count;
 316                          }
 317                      } else {
 318                          $users[$key] = $value;
 319                      }
 320                  }
 321              }
 322              unset($u);
 323              $u = null;
 324          }
 325      }
 326  
 327      $data = array();
 328  
 329      $a = new stdClass();
 330      $a->count = $totalcount;
 331      $a->items = $role->name;
 332  
 333      if ($matchcount != $totalcount) {
 334          $a->count = $matchcount.'/'.$a->count;
 335      }
 336  
 337      echo '<h2>'.get_string('counteditems', '', $a).'</h2>'."\n";
 338  
 339      echo '<form action="'.$CFG->wwwroot.'/user/action_redir.php" method="post" id="studentsform">'."\n";
 340      echo '<div>'."\n";
 341      echo '<input type="hidden" name="id" value="'.$id.'" />'."\n";
 342      echo '<input type="hidden" name="returnto" value="'. s($PAGE->url) .'" />'."\n";
 343      echo '<input type="hidden" name="sesskey" value="'.sesskey().'" />'."\n";
 344  
 345      foreach ($users as $u) {
 346          $data = array();
 347          $data[] = html_writer::link(new moodle_url('/user/view.php', array('id' => $u->userid, 'course' => $course->id)),
 348              fullname($u, true));
 349          $data[] = !empty($u->count) ? get_string('yes').' ('.$u->count.') ' : get_string('no');
 350  
 351          if (!empty($CFG->messaging)) {
 352              $data[] = '<input type="checkbox" class="usercheckbox" name="user'.$u->userid.'" value="'.$u->count.'" />';
 353          }
 354          $table->add_data($data);
 355      }
 356  
 357      $table->print_html();
 358  
 359      if ($perpage == SHOW_ALL_PAGE_SIZE) {
 360          $perpageurl = new moodle_url($baseurl, array('perpage' => DEFAULT_PAGE_SIZE));
 361          echo html_writer::start_div('', array('id' => 'showall'));
 362          echo html_writer::link($perpageurl, get_string('showperpage', '', DEFAULT_PAGE_SIZE));
 363          echo html_writer::end_div();
 364      } else if ($matchcount > 0 && $perpage < $matchcount) {
 365          $perpageurl = new moodle_url($baseurl, array('perpage' => SHOW_ALL_PAGE_SIZE));
 366          echo html_writer::start_div('', array('id' => 'showall'));
 367          echo html_writer::link($perpageurl, get_string('showall', '', $matchcount));
 368          echo html_writer::end_div();
 369      }
 370  
 371      if (!empty($CFG->messaging)) {
 372          echo '<div class="selectbuttons">';
 373          echo '<input type="button" id="checkall" value="'.get_string('selectall').'" /> '."\n";
 374          echo '<input type="button" id="checknone" value="'.get_string('deselectall').'" /> '."\n";
 375          if ($perpage >= $matchcount) {
 376              echo '<input type="button" id="checknos" value="'.get_string('selectnos').'" />'."\n";
 377          }
 378          echo '</div>';
 379          echo '<div>';
 380          echo html_writer::label(get_string('withselectedusers'), 'formactionselect');
 381          $displaylist['messageselect.php'] = get_string('messageselectadd');
 382          echo html_writer::select($displaylist, 'formaction', '', array('' => 'choosedots'), array('id' => 'formactionselect'));
 383          echo $OUTPUT->help_icon('withselectedusers');
 384          echo '<input type="submit" value="' . get_string('ok') . '" />'."\n";
 385          echo '</div>';
 386          echo '</div>'."\n";
 387          echo '</form>'."\n";
 388          echo '</div>'."\n";
 389  
 390          $PAGE->requires->js_init_call('M.report_participation.init');
 391      }
 392  }
 393  
 394  echo $OUTPUT->footer();


Generated: Thu Aug 11 10:00:09 2016 Cross-referenced by PHPXref 0.7.1