MDL-63496 tool_dataprivacy: Support for per-role retention
[moodle.git] / admin / tool / dataprivacy / classes / expiry_info.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/>.
17 /**
18  * Expiry Data.
19  *
20  * @package    tool_dataprivacy
21  * @copyright  2018 Andrew Nicols <andrew@nicols.co.uk>
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
24 namespace tool_dataprivacy;
26 use core_privacy\manager;
28 defined('MOODLE_INTERNAL') || die();
30 /**
31  * Expiry Data.
32  *
33  * @copyright  2018 Andrew Nicols <andrew@nicols.co.uk>
34  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
35  */
36 class expiry_info {
38     /** @var bool Whether this context is fully expired */
39     protected $fullyexpired = false;
41     /** @var bool Whether the default expiry value of this purpose has been reached */
42     protected $defaultexpiryreached = false;
44     /** @var int[] List of expires roles */
45     protected $expired = [];
47     /** @var int[] List of unexpires roles */
48     protected $unexpired = [];
50     /**
51      * Constructor for the expiry_info class.
52      *
53      * @param   bool    $default Whether the default expiry period for this context has been reached.
54      * @param   int[]   $expired A list of roles in this context which have explicitly expired.
55      * @param   int[]   $unexpired A list of roles in this context which have not yet expired.
56      */
57     public function __construct(bool $default, array $expired, array $unexpired) {
58         $this->defaultexpiryreached = $default;
59         $this->expired = $expired;
60         $this->unexpired = $unexpired;
61     }
63     /**
64      * Whether this context has 'fully' expired.
65      * That is to say that the default retention period has been reached, and that there are no unexpired roles.
66      *
67      * @return  bool
68      */
69     public function is_fully_expired() : bool {
70         return $this->defaultexpiryreached && empty($this->unexpired);
71     }
73     /**
74      * Whether any part of this context has expired.
75      *
76      * @return  bool
77      */
78     public function is_any_expired() : bool {
79         if ($this->is_fully_expired()) {
80             return true;
81         }
83         if (!empty($this->get_expired_roles())) {
84             return true;
85         }
87         if ($this->is_default_expired()) {
88             return true;
89         }
91         return false;
92     }
94     /**
95      * Get the list of explicitly expired role IDs.
96      * Note: This does not list roles which have been expired via the default retention policy being reached.
97      *
98      * @return  int[]
99      */
100     public function get_expired_roles() : array {
101         if ($this->is_default_expired()) {
102             return [];
103         }
104         return $this->expired;
105     }
107     /**
108      * Check whether the specified role is explicitly expired.
109      * Note: This does not list roles which have been expired via the default retention policy being reached.
110      *
111      * @param   int $roleid
112      * @return  bool
113      */
114     public function is_role_expired(int $roleid) : bool {
115         return false !== array_search($roleid, $this->expired);
116     }
118     /**
119      * Whether the default retention policy has been reached.
120      *
121      * @return  bool
122      */
123     public function is_default_expired() : bool {
124         return $this->defaultexpiryreached;
125     }
127     /**
128      * Get the list of unexpired role IDs.
129      *
130      * @return  int[]
131      */
132     public function get_unexpired_roles() : array {
133         return $this->unexpired;
134     }
136     /**
137      * Merge this expiry_info object with another belonging to a child context in order to set the 'safest' heritage.
138      *
139      * It is not possible to delete any part of a context that is not deleted by a parent.
140      * So if a course's retention policy has been reached, then only parts where the children have also expired can be
141      * deleted.
142      *
143      * @param   expiry_info $child The child record to merge with.
144      * @return  $this
145      */
146     public function merge_with_child(expiry_info $child) : expiry_info {
147         if ($child->is_fully_expired()) {
148             return $this;
149         }
151         // If the child is not fully expired, then none of the parents can be either.
152         $this->fullyexpired = false;
154         // Remove any role in this node which is not expired in the child.
155         foreach ($this->expired as $key => $roleid) {
156             if (!$child->is_role_expired($roleid)) {
157                 unset($this->expired[$key]);
158             }
159         }
161         array_merge($this->unexpired, $child->get_unexpired_roles());
163         if (!$child->is_default_expired()) {
164             $this->defaultexpiryreached = false;
165         }
167         return $this;
168     }