admin/tool/dataprivacy/classes/expired_contexts_manager.php

   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  * Expired contexts manager.
  19  *
  20  * @package    tool_dataprivacy
  21  * @copyright  2018 David Monllao
  22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23  */
  24 namespace tool_dataprivacy;
  25
  26 use tool_dataprivacy\api;
  27 use tool_dataprivacy\purpose;
  28 use tool_dataprivacy\context_instance;
  29 use tool_dataprivacy\data_registry;
  30 use tool_dataprivacy\expired_context;
  31
  32 defined('MOODLE_INTERNAL') || die();
  33
  34 /**
  35  * Expired contexts manager.
  36  *
  37  * @copyright  2018 David Monllao
  38  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  39  */
  40 abstract class expired_contexts_manager {
  41
  42     /**
  43      * Number of deleted contexts for each scheduled task run.
  44      */
  45     const DELETE_LIMIT = 200;
  46
  47     /**
  48      * Returns the list of expired context instances.
  49      *
  50      * @return \stdClass[]
  51      */
  52     abstract protected function get_expired_contexts();
  53
  54     /**
  55      * Flag expired contexts as expired.
  56      *
  57      * @return int The number of contexts flagged as expired.
  58      */
  59     public function flag_expired() {
  60
  61         if (!$this->check_requirements()) {
  62             return 0;
  63         }
  64
  65         $contexts = $this->get_expired_contexts();
  66         foreach ($contexts as $context) {
  67             api::create_expired_context($context->id);
  68         }
  69
  70         return count($contexts);
  71     }
  72
  73     /**
  74      * Deletes the expired contexts.
  75      *
  76      * @return int The number of deleted contexts.
  77      */
  78     public function delete() {
  79
  80         $numprocessed = 0;
  81
  82         if (!$this->check_requirements()) {
  83             return $numprocessed;
  84         }
  85
  86         $privacymanager = new \core_privacy\manager();
  87
  88         $levels = [CONTEXT_USER, CONTEXT_MODULE, CONTEXT_BLOCK, CONTEXT_COURSE];
  89         foreach ($levels as $level) {
  90
  91             $expiredcontexts = expired_context::get_records_by_contextlevel($level, expired_context::STATUS_APPROVED);
  92
  93             foreach ($expiredcontexts as $expiredctx) {
  94
  95                 $context = \context::instance_by_id($expiredctx->get('contextid'), IGNORE_MISSING);
  96                 if (!$context) {
  97                     api::delete_expired_context($expiredctx->get('contextid'));
  98                     continue;
  99                 }
 100
 101                 if (!PHPUNIT_TEST) {
 102                     mtrace('Deleting context ' . $context->id . ' - ' .
 103                         shorten_text($context->get_context_name(true, true)));
 104                 }
 105
 106                 $privacymanager->delete_data_for_all_users_in_context($context);
 107
 108                 api::set_expired_context_status($expiredctx, expired_context::STATUS_CLEANED);
 109
 110                 $numprocessed += 1;
 111                 if ($numprocessed == self::DELETE_LIMIT) {
 112                     // Close the recordset.
 113                     $expiredcontexts->close();
 114                     break 2;
 115                 }
 116             }
 117         }
 118
 119         return $numprocessed;
 120     }
 121
 122     /**
 123      * Check that the requirements to start deleting contexts are satisified.
 124      *
 125      * @return bool
 126      */
 127     protected function check_requirements() {
 128         api::check_can_manage_data_registry(\context_system::instance()->id);
 129
 130         if (!data_registry::defaults_set()) {
 131             return false;
 132         }
 133         return true;
 134     }
 135 }