[Summary view]

   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   * Scheduled task to revoke expired factors
  19   *
  20   * @package   factor_grace
  21   * @author    Peter Burnett <peterburnett@catalyst-au.net>
  22   * @copyright Catalyst IT
  23   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24   */
  25  
  26  namespace factor_grace\task;
  27  
  28  /**
  29   * Scheduled task to revoke expired gracemode factors
  30   */
  31  class revoke_expired_factors extends \core\task\scheduled_task {
  32  
  33      /**
  34       * Return the task's name as shown in admin screens.
  35       *
  36       * @return string
  37       */
  38      public function get_name(): string {
  39          return get_string('revokeexpiredfactors', 'factor_grace');
  40      }
  41  
  42      /**
  43       * Execute the task.
  44       *
  45       * @return void
  46       */
  47      public function execute(): void {
  48          mtrace('Starting to revoke expired Grace factors');
  49          $this->revoke_factors();
  50      }
  51  
  52      /**
  53       * Revokes all grace factors that have a valid timecreated and are outside the duration.
  54       *
  55       * @return void
  56       */
  57      private function revoke_factors(): void {
  58          global $DB;
  59  
  60          // If config is not set, pull out.
  61          $duration = get_config('factor_grace', 'graceperiod');
  62          if (!$duration) {
  63              mtrace('Gracemode duration is not set. Exiting...');
  64              return;
  65          }
  66          $revoketime = time() - $duration;
  67  
  68          // Single query implementation.
  69          $sql = "UPDATE {tool_mfa}
  70                      SET revoked = 1,
  71                          timemodified = :timemodified
  72                      WHERE timecreated < :revoketime
  73                      AND factor = :factor";
  74          $DB->execute($sql, ['timemodified' => time(), 'revoketime' => $revoketime, 'factor' => 'grace']);
  75  
  76          mtrace('Finished revoking expired Grace factors');
  77      }
  78  }