Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | |
0.00% |
0 / 69 |
|
0.00% |
0 / 5 |
CRAP | |
0.00% |
0 / 1 |
| LtiProviderFactory | |
0.00% |
0 / 69 |
|
0.00% |
0 / 5 |
132 | |
0.00% |
0 / 1 |
| createFromResource | |
0.00% |
0 / 35 |
|
0.00% |
0 / 1 |
2 | |||
| createFromArray | |
0.00% |
0 / 20 |
|
0.00% |
0 / 1 |
2 | |||
| getLtiVersion | |
0.00% |
0 / 7 |
|
0.00% |
0 / 1 |
56 | |||
| getDeploymentIds | |
0.00% |
0 / 6 |
|
0.00% |
0 / 1 |
2 | |||
| getValidationService | |
0.00% |
0 / 1 |
|
0.00% |
0 / 1 |
2 | |||
| 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) 2020 (original work) Open Assessment Technologies SA |
| 19 | */ |
| 20 | |
| 21 | declare(strict_types=1); |
| 22 | |
| 23 | namespace oat\taoLti\models\classes\LtiProvider; |
| 24 | |
| 25 | use core_kernel_classes_Literal; |
| 26 | use core_kernel_classes_Resource; |
| 27 | use oat\oatbox\service\ConfigurableService; |
| 28 | use oat\tao\model\oauth\DataStore; |
| 29 | use oat\taoLti\models\classes\LtiProvider\Validation\LtiProviderValidator; |
| 30 | |
| 31 | class LtiProviderFactory extends ConfigurableService |
| 32 | { |
| 33 | public function createFromResource(core_kernel_classes_Resource $resource): LtiProvider |
| 34 | { |
| 35 | $propertiesValues = $resource->getPropertiesValues( |
| 36 | [ |
| 37 | DataStore::PROPERTY_OAUTH_KEY, |
| 38 | DataStore::PROPERTY_OAUTH_SECRET, |
| 39 | DataStore::PROPERTY_OAUTH_CALLBACK, |
| 40 | RdfLtiProviderRepository::LTI_VERSION, |
| 41 | RdfLtiProviderRepository::LTI_TOOL_IDENTIFIER, |
| 42 | RdfLtiProviderRepository::LTI_TOOL_NAME, |
| 43 | RdfLtiProviderRepository::LTI_TOOL_CLIENT_ID, |
| 44 | RdfLtiProviderRepository::LTI_TOOL_DEPLOYMENT_IDS, |
| 45 | RdfLtiProviderRepository::LTI_TOOL_AUDIENCE, |
| 46 | RdfLtiProviderRepository::LTI_TOOL_LAUNCH_URL, |
| 47 | RdfLtiProviderRepository::LTI_TOOL_OIDC_LOGIN_INITATION_URL, |
| 48 | RdfLtiProviderRepository::LTI_TOOL_JWKS_URL, |
| 49 | RdfLtiProviderRepository::LTI_TOOL_PUBLIC_KEY, |
| 50 | ] |
| 51 | ); |
| 52 | |
| 53 | return new LtiProvider( |
| 54 | $resource->getUri(), |
| 55 | $resource->getLabel(), |
| 56 | (string)reset($propertiesValues[DataStore::PROPERTY_OAUTH_KEY]), |
| 57 | (string)reset($propertiesValues[DataStore::PROPERTY_OAUTH_SECRET]), |
| 58 | (string)reset($propertiesValues[DataStore::PROPERTY_OAUTH_CALLBACK]), |
| 59 | [], |
| 60 | $this->getLtiVersion($propertiesValues), |
| 61 | (string)reset($propertiesValues[RdfLtiProviderRepository::LTI_TOOL_IDENTIFIER]), |
| 62 | (string)reset($propertiesValues[RdfLtiProviderRepository::LTI_TOOL_NAME]), |
| 63 | (string)reset($propertiesValues[RdfLtiProviderRepository::LTI_TOOL_CLIENT_ID]), |
| 64 | $this->getDeploymentIds($propertiesValues), |
| 65 | (string)reset($propertiesValues[RdfLtiProviderRepository::LTI_TOOL_AUDIENCE]), |
| 66 | (string)reset($propertiesValues[RdfLtiProviderRepository::LTI_TOOL_OIDC_LOGIN_INITATION_URL]), |
| 67 | (string)reset($propertiesValues[RdfLtiProviderRepository::LTI_TOOL_LAUNCH_URL]), |
| 68 | (string)reset($propertiesValues[RdfLtiProviderRepository::LTI_TOOL_PUBLIC_KEY]), |
| 69 | (string)reset($propertiesValues[RdfLtiProviderRepository::LTI_TOOL_JWKS_URL]) |
| 70 | ); |
| 71 | } |
| 72 | |
| 73 | public function createFromArray(array $provider): LtiProvider |
| 74 | { |
| 75 | $ltiVersion = $provider[ConfigurableLtiProviderRepository::LTI_VERSION] ?? '1.1'; |
| 76 | |
| 77 | $this->getValidationService()->validateArray($ltiVersion, $provider); |
| 78 | |
| 79 | return new LtiProvider( |
| 80 | $provider['uri'], |
| 81 | $provider['label'], |
| 82 | $provider['key'], |
| 83 | $provider['secret'], |
| 84 | $provider['callback_url'], |
| 85 | $provider['roles'] ?? [], |
| 86 | $ltiVersion, |
| 87 | $provider[ConfigurableLtiProviderRepository::LTI_TOOL_IDENTIFIER] ?? null, |
| 88 | $provider[ConfigurableLtiProviderRepository::LTI_TOOL_NAME] ?? null, |
| 89 | $provider[ConfigurableLtiProviderRepository::LTI_TOOL_CLIENT_ID] ?? null, |
| 90 | $provider[ConfigurableLtiProviderRepository::LTI_TOOL_DEPLOYMENT_IDS] ?? [], |
| 91 | $provider[ConfigurableLtiProviderRepository::LTI_TOOL_AUDIENCE] ?? null, |
| 92 | $provider[ConfigurableLtiProviderRepository::LTI_TOOL_OIDC_LOGIN_INITATION_URL] ?? null, |
| 93 | $provider[ConfigurableLtiProviderRepository::LTI_TOOL_LAUNCH_URL] ?? null, |
| 94 | $provider[ConfigurableLtiProviderRepository::LTI_TOOL_PUBLIC_KEY] ?? null, |
| 95 | $provider[ConfigurableLtiProviderRepository::LTI_TOOL_JWKS_URL] ?? null |
| 96 | ); |
| 97 | } |
| 98 | |
| 99 | private function getLtiVersion(array $propertiesValues): string |
| 100 | { |
| 101 | $ltiVersionResource = reset($propertiesValues[RdfLtiProviderRepository::LTI_VERSION]); |
| 102 | |
| 103 | if ($ltiVersionResource instanceof core_kernel_classes_Literal && !empty(trim($ltiVersionResource->literal))) { |
| 104 | return $ltiVersionResource->literal === RdfLtiProviderRepository::LTI_V_13 ? '1.3' : '1.1'; |
| 105 | } |
| 106 | |
| 107 | if (!$ltiVersionResource || !$ltiVersionResource instanceof core_kernel_classes_Resource) { |
| 108 | return '1.1'; |
| 109 | } |
| 110 | |
| 111 | $version = (string) $ltiVersionResource->getUri(); |
| 112 | |
| 113 | return $version === RdfLtiProviderRepository::LTI_V_13 ? '1.3' : '1.1'; |
| 114 | } |
| 115 | |
| 116 | private function getDeploymentIds(array $propertiesValues): array |
| 117 | { |
| 118 | return array_filter( |
| 119 | explode( |
| 120 | ',', |
| 121 | (string)reset($propertiesValues[RdfLtiProviderRepository::LTI_TOOL_DEPLOYMENT_IDS]) |
| 122 | ) |
| 123 | ); |
| 124 | } |
| 125 | |
| 126 | private function getValidationService(): LtiProviderValidator |
| 127 | { |
| 128 | /** @noinspection PhpIncompatibleReturnTypeInspection */ |
| 129 | return $this->getServiceLocator()->get(LtiProviderValidator::class); |
| 130 | } |
| 131 | } |