[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 unusable factors that will never pass.
  19   *
  20   * @package   factor_nosetup
  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_nosetup\task;
  27  
  28  /**
  29   * Scheduled task to add log events into DB table.
  30   */
  31  class delete_unusable_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('deleteunusablefactors', 'factor_nosetup');
  40      }
  41  
  42      /**
  43       * Execute the task.
  44       *
  45       * @return void
  46       */
  47      public function execute(): void {
  48          mtrace('Starting to revoke unusable Nosetup factors');
  49          $this->revoke_factors();
  50      }
  51  
  52      /**
  53       * Revokes all nosetup factors that will now always fail.
  54       *
  55       * @return void
  56       */
  57      private function revoke_factors(): void {
  58          global $DB;
  59  
  60          $factorobject = \tool_mfa\plugininfo\factor::get_factor('nosetup');
  61          // We need to get all nosetup factors, and check that for ones that no longer have a pass state.
  62          $allfactorssql = "SELECT DISTINCT tm.userid
  63                              FROM {tool_mfa} tm
  64                              JOIN {user} u ON u.id = tm.userid
  65                             WHERE tm.factor = :factor
  66                               AND u.suspended = 0
  67                               AND u.deleted = 0
  68                               AND (
  69                                   SELECT COUNT(id) as count
  70                                     FROM {tool_mfa}
  71                                    WHERE userid = tm.userid
  72                                      AND factor <> :notfactor
  73                                   ) > 0";
  74          $useridrecordset = $DB->get_recordset_sql($allfactorssql, ['factor' => 'nosetup', 'notfactor' => 'nosetup']);
  75  
  76          foreach ($useridrecordset as $userid) {
  77              // If pass state is no longer possible, add delete user factor.
  78              $user = \core_user::get_user($userid->userid);
  79              if (!in_array(\tool_mfa\plugininfo\factor::STATE_PASS, $factorobject->possible_states($user))) {
  80                  $factorobject->delete_factor_for_user($user);
  81              }
  82          }
  83          $useridrecordset->close();
  84          mtrace('Finished revoking unusable Nosetup factors');
  85      }
  86  }