Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | |
76.47% |
13 / 17 |
|
71.43% |
5 / 7 |
CRAP | |
0.00% |
0 / 1 |
| ActionBlackList | |
76.47% |
13 / 17 |
|
71.43% |
5 / 7 |
15.20 | |
0.00% |
0 / 1 |
| isDisabled | |
100.00% |
3 / 3 |
|
100.00% |
1 / 1 |
4 | |||
| isDisabledByDefault | |
100.00% |
1 / 1 |
|
100.00% |
1 / 1 |
1 | |||
| isDisabledByFeatureFlag | |
100.00% |
3 / 3 |
|
100.00% |
1 / 1 |
2 | |||
| isEnabledByFeatureFlag | |
100.00% |
3 / 3 |
|
100.00% |
1 / 1 |
2 | |||
| getFeatureFlagChecker | |
100.00% |
1 / 1 |
|
100.00% |
1 / 1 |
1 | |||
| getUserSettingsService | |
0.00% |
0 / 1 |
|
0.00% |
0 / 1 |
2 | |||
| isDisabledByInterfaceMode | |
40.00% |
2 / 5 |
|
0.00% |
0 / 1 |
2.86 | |||
| 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-2024 (original work) Open Assessment Technologies SA; |
| 19 | */ |
| 20 | |
| 21 | declare(strict_types=1); |
| 22 | |
| 23 | namespace oat\tao\model\action; |
| 24 | |
| 25 | use Laminas\ServiceManager\ServiceLocatorAwareTrait; |
| 26 | use oat\generis\model\GenerisRdf; |
| 27 | use oat\oatbox\service\ConfigurableService; |
| 28 | use oat\tao\model\featureFlag\FeatureFlagChecker; |
| 29 | use oat\tao\model\featureFlag\FeatureFlagCheckerInterface; |
| 30 | use oat\tao\model\user\implementation\UserSettingsService; |
| 31 | use oat\tao\model\user\UserSettingsInterface; |
| 32 | use oat\tao\model\user\UserSettingsServiceInterface; |
| 33 | |
| 34 | class ActionBlackList extends ConfigurableService |
| 35 | { |
| 36 | use ServiceLocatorAwareTrait; |
| 37 | |
| 38 | public const SERVICE_ID = 'tao/ActionBlackList'; |
| 39 | public const OPTION_DISABLED_ACTIONS = 'disabledActions'; |
| 40 | public const OPTION_DISABLED_ACTIONS_FLAG_MAP = 'disabledActionsMap'; |
| 41 | public const OPTION_ENABLED_ACTIONS_BY_FEATURE_FLAG_MAP = 'enabledActionsByFeatureFlagMap'; |
| 42 | |
| 43 | private const SIMPLE_INTERFACE_MODE_DISABLED_ACTION = [ |
| 44 | 'test-xml-editor' |
| 45 | ]; |
| 46 | |
| 47 | public function isDisabled(string $action): bool |
| 48 | { |
| 49 | return $this->isDisabledByInterfaceMode($action) |
| 50 | || ($this->isDisabledByDefault($action) && !$this->isEnabledByFeatureFlag($action)) |
| 51 | || $this->isDisabledByFeatureFlag($action); |
| 52 | } |
| 53 | |
| 54 | private function isDisabledByDefault(string $action): bool |
| 55 | { |
| 56 | return array_search($action, (array) $this->getOption(self::OPTION_DISABLED_ACTIONS, [])) !== false; |
| 57 | } |
| 58 | |
| 59 | private function isDisabledByFeatureFlag(string $action): bool |
| 60 | { |
| 61 | $disabledActionsMap = $this->getOption(self::OPTION_DISABLED_ACTIONS_FLAG_MAP, []); |
| 62 | return isset($disabledActionsMap[$action]) |
| 63 | && $this->getFeatureFlagChecker()->isEnabled($disabledActionsMap[$action]); |
| 64 | } |
| 65 | |
| 66 | private function isEnabledByFeatureFlag(string $action): bool |
| 67 | { |
| 68 | $enabledActionsByFeatureFlagMap = $this->getOption(self::OPTION_ENABLED_ACTIONS_BY_FEATURE_FLAG_MAP, []); |
| 69 | return isset($enabledActionsByFeatureFlagMap[$action]) |
| 70 | && $this->getFeatureFlagChecker()->isEnabled($enabledActionsByFeatureFlagMap[$action]); |
| 71 | } |
| 72 | |
| 73 | private function getFeatureFlagChecker(): FeatureFlagChecker |
| 74 | { |
| 75 | return $this->getServiceLocator()->get(FeatureFlagChecker::class); |
| 76 | } |
| 77 | |
| 78 | private function getUserSettingsService(): UserSettingsServiceInterface |
| 79 | { |
| 80 | return $this->getServiceManager()->getContainer()->get(UserSettingsService::class); |
| 81 | } |
| 82 | |
| 83 | private function isDisabledByInterfaceMode(string $action): bool |
| 84 | { |
| 85 | if (!in_array($action, self::SIMPLE_INTERFACE_MODE_DISABLED_ACTION)) { |
| 86 | return false; |
| 87 | } |
| 88 | |
| 89 | return $this->getUserSettingsService() |
| 90 | ->getCurrentUserSettings() |
| 91 | ->getSetting(UserSettingsInterface::INTERFACE_MODE) === GenerisRdf::PROPERTY_USER_INTERFACE_MODE_SIMPLE; |
| 92 | } |
| 93 | } |