Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | |
83.91% |
73 / 87 |
|
62.50% |
5 / 8 |
CRAP | |
0.00% |
0 / 1 |
| ClassDeleter | |
83.91% |
73 / 87 |
|
62.50% |
5 / 8 |
28.82 | |
0.00% |
0 / 1 |
| __construct | |
100.00% |
6 / 6 |
|
100.00% |
1 / 1 |
1 | |||
| delete | |
58.33% |
14 / 24 |
|
0.00% |
0 / 1 |
5.16 | |||
| deleteClassRecursively | |
100.00% |
6 / 6 |
|
100.00% |
1 / 1 |
4 | |||
| deleteClass | |
100.00% |
11 / 11 |
|
100.00% |
1 / 1 |
2 | |||
| deleteClassContent | |
100.00% |
4 / 4 |
|
100.00% |
1 / 1 |
4 | |||
| deleteInstances | |
84.21% |
16 / 19 |
|
0.00% |
0 / 1 |
5.10 | |||
| deleteProperties | |
100.00% |
4 / 4 |
|
100.00% |
1 / 1 |
3 | |||
| deleteProperty | |
92.31% |
12 / 13 |
|
0.00% |
0 / 1 |
3.00 | |||
| 1 | <?php |
| 2 | |
| 3 | /** |
| 4 | * This program is free software; you can redistribute it and/or |
| 5 | * modify it under the terms of the GNU General Public License |
| 6 | * as published by the Free Software Foundation; under version 2 |
| 7 | * of the License (non-upgradable). |
| 8 | * |
| 9 | * This program 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 this program; if not, write to the Free Software |
| 16 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
| 17 | * |
| 18 | * Copyright (c) 2021 (original work) Open Assessment Technologies SA; |
| 19 | */ |
| 20 | |
| 21 | declare(strict_types=1); |
| 22 | |
| 23 | namespace oat\tao\model\resources\Service; |
| 24 | |
| 25 | use Throwable; |
| 26 | use core_kernel_classes_Class; |
| 27 | use core_kernel_classes_Property; |
| 28 | use oat\generis\model\data\Ontology; |
| 29 | use oat\tao\model\search\index\OntologyIndex; |
| 30 | use oat\tao\model\accessControl\PermissionCheckerInterface; |
| 31 | use oat\tao\model\resources\Contract\ClassDeleterInterface; |
| 32 | use oat\tao\model\Specification\ClassSpecificationInterface; |
| 33 | use oat\tao\model\resources\Exception\ClassDeletionException; |
| 34 | use oat\generis\model\resource\Context\ResourceRepositoryContext; |
| 35 | use oat\generis\model\resource\Contract\ResourceRepositoryInterface; |
| 36 | use oat\tao\model\resources\Exception\PartialClassDeletionException; |
| 37 | |
| 38 | class ClassDeleter implements ClassDeleterInterface |
| 39 | { |
| 40 | private const PROPERTY_INDEX = OntologyIndex::PROPERTY_INDEX; |
| 41 | |
| 42 | /** @var ClassSpecificationInterface */ |
| 43 | private $rootClassSpecification; |
| 44 | |
| 45 | /** @var PermissionCheckerInterface */ |
| 46 | private $permissionChecker; |
| 47 | |
| 48 | /** @var Ontology */ |
| 49 | private $ontology; |
| 50 | |
| 51 | /** @var ResourceRepositoryInterface */ |
| 52 | private $resourceRepository; |
| 53 | |
| 54 | /** @var ResourceRepositoryInterface */ |
| 55 | private $classRepository; |
| 56 | |
| 57 | /** @var core_kernel_classes_Property */ |
| 58 | private $propertyIndex; |
| 59 | |
| 60 | /** @var core_kernel_classes_Class|null */ |
| 61 | private $selectedClass; |
| 62 | |
| 63 | public function __construct( |
| 64 | ClassSpecificationInterface $rootClassSpecification, |
| 65 | PermissionCheckerInterface $permissionChecker, |
| 66 | Ontology $ontology, |
| 67 | ResourceRepositoryInterface $resourceRepository, |
| 68 | ResourceRepositoryInterface $classRepository |
| 69 | ) { |
| 70 | $this->rootClassSpecification = $rootClassSpecification; |
| 71 | $this->permissionChecker = $permissionChecker; |
| 72 | $this->ontology = $ontology; |
| 73 | $this->resourceRepository = $resourceRepository; |
| 74 | $this->classRepository = $classRepository; |
| 75 | |
| 76 | $this->propertyIndex = $ontology->getProperty(self::PROPERTY_INDEX); |
| 77 | } |
| 78 | |
| 79 | public function delete(core_kernel_classes_Class $class): void |
| 80 | { |
| 81 | if ($this->rootClassSpecification->isSatisfiedBy($class)) { |
| 82 | throw new ClassDeletionException( |
| 83 | 'The class provided for deletion cannot be the root class.', |
| 84 | __('You cannot delete the root node') |
| 85 | ); |
| 86 | } |
| 87 | |
| 88 | try { |
| 89 | $this->selectedClass = $class; |
| 90 | $this->deleteClassRecursively($class); |
| 91 | } catch (Throwable $exception) { |
| 92 | throw new PartialClassDeletionException( |
| 93 | sprintf( |
| 94 | 'Unable to delete class "%s::%s" (%s).', |
| 95 | $class->getLabel(), |
| 96 | $class->getUri(), |
| 97 | $exception->getMessage() |
| 98 | ), |
| 99 | __('Unable to delete the selected resource') |
| 100 | ); |
| 101 | } |
| 102 | |
| 103 | if ($class->exists()) { |
| 104 | throw new PartialClassDeletionException( |
| 105 | 'Unable to delete the selected resource because you do not have the required rights to delete ' |
| 106 | . 'part of its content.', |
| 107 | // phpcs:disable Generic.Files.LineLength |
| 108 | __('Unable to delete the selected resource because you do not have the required rights to delete part of its content.') |
| 109 | // phpcs:enable Generic.Files.LineLength |
| 110 | ); |
| 111 | } |
| 112 | } |
| 113 | |
| 114 | private function deleteClassRecursively(core_kernel_classes_Class $class): bool |
| 115 | { |
| 116 | if (!$this->permissionChecker->hasReadAccess($class->getUri())) { |
| 117 | return false; |
| 118 | } |
| 119 | |
| 120 | $isClassDeletable = true; |
| 121 | |
| 122 | foreach ($class->getSubClasses() as $subClass) { |
| 123 | $isClassDeletable = $this->deleteClassRecursively($subClass) && $isClassDeletable; |
| 124 | } |
| 125 | |
| 126 | return $this->deleteClass($class, $isClassDeletable); |
| 127 | } |
| 128 | |
| 129 | /** |
| 130 | * @param bool $isClassDeletable Class is not deletable if it contains at least one protected subclass, |
| 131 | * instance or property |
| 132 | */ |
| 133 | private function deleteClass(core_kernel_classes_Class $class, bool $isClassDeletable): bool |
| 134 | { |
| 135 | if ($this->deleteClassContent($class, $isClassDeletable)) { |
| 136 | $this->classRepository->delete( |
| 137 | new ResourceRepositoryContext( |
| 138 | [ |
| 139 | ResourceRepositoryContext::PARAM_CLASS => $class, |
| 140 | ResourceRepositoryContext::PARAM_SELECTED_CLASS => $this->selectedClass, |
| 141 | ] |
| 142 | ) |
| 143 | ); |
| 144 | |
| 145 | return true; |
| 146 | } |
| 147 | |
| 148 | return false; |
| 149 | } |
| 150 | |
| 151 | private function deleteClassContent(core_kernel_classes_Class $class, bool $isClassDeletable): bool |
| 152 | { |
| 153 | return $this->deleteInstances($class) |
| 154 | && $isClassDeletable |
| 155 | && $this->permissionChecker->hasWriteAccess($class->getUri()) |
| 156 | && $this->deleteProperties($class->getProperties()); |
| 157 | } |
| 158 | |
| 159 | private function deleteInstances(core_kernel_classes_Class $class): bool |
| 160 | { |
| 161 | $status = true; |
| 162 | |
| 163 | foreach ($class->getInstances() as $instance) { |
| 164 | if (!$instance->exists()) { |
| 165 | continue; |
| 166 | } |
| 167 | |
| 168 | if (!$this->permissionChecker->hasWriteAccess($instance->getUri())) { |
| 169 | $status = false; |
| 170 | |
| 171 | continue; |
| 172 | } |
| 173 | |
| 174 | try { |
| 175 | $this->resourceRepository->delete( |
| 176 | new ResourceRepositoryContext( |
| 177 | [ |
| 178 | ResourceRepositoryContext::PARAM_RESOURCE => $instance, |
| 179 | ResourceRepositoryContext::PARAM_SELECTED_CLASS => $this->selectedClass, |
| 180 | ResourceRepositoryContext::PARAM_PARENT_CLASS => $class, |
| 181 | ] |
| 182 | ) |
| 183 | ); |
| 184 | } catch (Throwable $exception) { |
| 185 | $status = false; |
| 186 | } |
| 187 | } |
| 188 | |
| 189 | return $status; |
| 190 | } |
| 191 | |
| 192 | /** |
| 193 | * @param core_kernel_classes_Property[] $properties |
| 194 | */ |
| 195 | private function deleteProperties(array $properties): bool |
| 196 | { |
| 197 | $status = true; |
| 198 | |
| 199 | foreach ($properties as $property) { |
| 200 | $status = $this->deleteProperty($property) && $status; |
| 201 | } |
| 202 | |
| 203 | return $status; |
| 204 | } |
| 205 | |
| 206 | private function deleteProperty(core_kernel_classes_Property $property): bool |
| 207 | { |
| 208 | $indexes = $property->getPropertyValues($this->propertyIndex); |
| 209 | |
| 210 | if (!$property->delete(true)) { |
| 211 | return false; |
| 212 | } |
| 213 | |
| 214 | foreach ($indexes as $indexUri) { |
| 215 | $this->resourceRepository->delete( |
| 216 | new ResourceRepositoryContext( |
| 217 | [ |
| 218 | ResourceRepositoryContext::PARAM_RESOURCE => $this->ontology->getResource($indexUri), |
| 219 | ResourceRepositoryContext::PARAM_DELETE_REFERENCE => true, |
| 220 | ] |
| 221 | ) |
| 222 | ); |
| 223 | } |
| 224 | |
| 225 | return true; |
| 226 | } |
| 227 | } |