[Summary view]

Differences Between: [Versions 310 and 402] [Versions 311 and 402] [Versions 39 and 402] [Versions 400 and 402] [Versions 401 and 402]

   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   * Any access indicator.
  19   *
  20   * @package   core
  21   * @copyright 2019 David Monllao {@link http://www.davidmonllao.com}
  22   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace core\analytics\indicator;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * Any access indicator.
  31   *
  32   * @package   core
  33   * @copyright 2019 David Monllao {@link http://www.davidmonllao.com}
  34   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  35   */
  36  class any_course_access extends \core_analytics\local\indicator\binary {
  37  
  38      /** @var array user last access. */
  39      protected $lastaccesses = [];
  40  
  41      /**
  42       * Returns the name.
  43       *
  44       * If there is a corresponding '_help' string this will be shown as well.
  45       *
  46       * @return \lang_string
  47       */
  48      public static function get_name() : \lang_string {
  49          return new \lang_string('indicator:anycourseaccess');
  50      }
  51  
  52      /**
  53       * required_sample_data
  54       *
  55       * @return string[]
  56       */
  57      public static function required_sample_data() {
  58          return array('course', 'user');
  59      }
  60  
  61      /**
  62       * Store userid => timeaccess relation if the provided analysable is a course.
  63       *
  64       * @param  \core_analytics\analysable $analysable
  65       * @return null
  66       */
  67      public function fill_per_analysable_caches(\core_analytics\analysable $analysable) {
  68          global $DB;
  69  
  70          if ($analysable instanceof \core_analytics\course) {
  71              // Indexed by userid (there is a UNIQUE KEY at DB level).
  72              $this->lastaccesses = $DB->get_records('user_lastaccess', ['courseid' => $analysable->get_id()],
  73                  '', 'userid, timeaccess');
  74          }
  75      }
  76  
  77      /**
  78       * calculate_sample
  79       *
  80       * @param int $sampleid
  81       * @param string $sampleorigin
  82       * @param int $starttime
  83       * @param int $endtime
  84       * @return float
  85       */
  86      protected function calculate_sample($sampleid, $sampleorigin, $starttime = false, $endtime = false) {
  87  
  88          $course = $this->retrieve('course', $sampleid);
  89          $user = $this->retrieve('user', $sampleid);
  90  
  91          // We first try using user_lastaccess as it is much faster than the log table.
  92          if (empty($this->lastaccesses[$user->id]->timeaccess)) {
  93              // The user never accessed.
  94              return self::get_min_value();
  95          } else if (!$starttime && !$endtime) {
  96              // No time restrictions, so all good as long as there is a record.
  97              return self::get_max_value();
  98          } else if ($starttime && $this->lastaccesses[$user->id]->timeaccess < $starttime) {
  99              // The last access is prior to $starttime.
 100              return self::get_min_value();
 101          } else if ($endtime && $this->lastaccesses[$user->id]->timeaccess < $endtime) {
 102              // The last access is before the $endtime.
 103              return self::get_max_value();
 104          } else if ($starttime && !$endtime && $starttime <= $this->lastaccesses[$user->id]->timeaccess) {
 105              // No end time, so max value as long as the last access is after $starttime.
 106              return self::get_max_value();
 107          }
 108  
 109          // If the last access is after $endtime we can not know for sure if the user accessed or not
 110          // between $starttime and $endtime, we need to check the logs table in this case. Note that
 111          // it is unlikely that we will reach this point as this indicator will be used in models whose
 112          // dates are in the past.
 113  
 114          if (!$logstore = \core_analytics\manager::get_analytics_logstore()) {
 115              throw new \coding_exception('No available log stores');
 116          }
 117  
 118          // Filter by context to use the logstore_standard_log db table index.
 119          $select = "userid = :userid AND courseid = :courseid";
 120          $params = ['courseid' => $course->id, 'userid' => $user->id];
 121  
 122          if ($starttime) {
 123              $select .= " AND timecreated > :starttime";
 124              $params['starttime'] = $starttime;
 125          }
 126          if ($endtime) {
 127              $select .= " AND timecreated <= :endtime";
 128              $params['endtime'] = $endtime;
 129          }
 130  
 131          $nlogs = $logstore->get_events_select_count($select, $params);
 132          if ($nlogs) {
 133              return self::get_max_value();
 134          } else {
 135              return self::get_min_value();
 136          }
 137      }
 138  }