Lines
86.97%
167 / 192
Methods
72.41%
21 / 29
Classes
0.00%
0 / 1
| Name | Lines | Methods | CRAP | ||||
|---|---|---|---|---|---|---|---|
| __construct | 100.00% | 1 / 1 | 100.00% | 1 / 1 | 1 | ||
| create | 100.00% | 7 / 7 | 100.00% | 1 / 1 | 2 | ||
| drop | 100.00% | 7 / 7 | 100.00% | 1 / 1 | 2 | ||
| import | 100.00% | 12 / 12 | 100.00% | 1 / 1 | 3 | ||
| statistics | 8.33% | 1 / 12 | 0.00% | 0 / 1 | 9.93 | ||
| healthcheck | 100.00% | 9 / 9 | 100.00% | 1 / 1 | 3 | ||
| [phpMyFAQ\Controller\AbstractController] setContainer | 100.00% | 2 / 2 | 100.00% | 1 / 1 | 1 | ||
| [phpMyFAQ\Controller\AbstractController] initializeFromContainer | 78.57% | 11 / 14 | 0.00% | 0 / 1 | 4.16 | ||
| [phpMyFAQ\Controller\AbstractController] render | 100.00% | 5 / 5 | 100.00% | 1 / 1 | 1 | ||
| [phpMyFAQ\Controller\AbstractController] renderView | 0.00% | 0 / 3 | 0.00% | 0 / 1 | 2 | ||
| [phpMyFAQ\Controller\AbstractController] json | 100.00% | 1 / 1 | 100.00% | 1 / 1 | 1 | ||
| [phpMyFAQ\Controller\AbstractController] getJsonObject | 75.00% | 3 / 4 | 0.00% | 0 / 1 | 2.06 | ||
| [phpMyFAQ\Controller\AbstractController] getTwigWrapper | 100.00% | 10 / 10 | 100.00% | 1 / 1 | 3 | ||
| [phpMyFAQ\Controller\AbstractController] hasValidToken | 85.71% | 6 / 7 | 0.00% | 0 / 1 | 5.07 | ||
| [phpMyFAQ\Controller\AbstractController] isSecured | 100.00% | 10 / 10 | 100.00% | 1 / 1 | 5 | ||
| [phpMyFAQ\Controller\AbstractController] isPublicAuthenticationPath | 100.00% | 23 / 23 | 100.00% | 1 / 1 | 1 | ||
| [phpMyFAQ\Controller\AbstractController] userIsAuthenticated | 100.00% | 2 / 2 | 100.00% | 1 / 1 | 2 | ||
| [phpMyFAQ\Controller\AbstractController] userIsSuperAdmin | 100.00% | 2 / 2 | 100.00% | 1 / 1 | 2 | ||
| [phpMyFAQ\Controller\AbstractController] userHasGroupPermission | 100.00% | 8 / 8 | 100.00% | 1 / 1 | 6 | ||
| [phpMyFAQ\Controller\AbstractController] userHasUserPermission | 100.00% | 7 / 7 | 100.00% | 1 / 1 | 5 | ||
| [phpMyFAQ\Controller\AbstractController] userHasPermission | 100.00% | 5 / 5 | 100.00% | 1 / 1 | 3 | ||
| [phpMyFAQ\Controller\AbstractController] userHasAnyPermission | 100.00% | 10 / 10 | 100.00% | 1 / 1 | 4 | ||
| [phpMyFAQ\Controller\AbstractController] verifySessionCsrfToken | 70.00% | 7 / 10 | 0.00% | 0 / 1 | 4.43 | ||
| [phpMyFAQ\Controller\AbstractController] captchaCodeIsValid | 85.71% | 6 / 7 | 0.00% | 0 / 1 | 2.01 | ||
| [phpMyFAQ\Controller\AbstractController] isApiEnabled | 100.00% | 1 / 1 | 100.00% | 1 / 1 | 1 | ||
| [phpMyFAQ\Controller\AbstractController] addExtension | 100.00% | 1 / 1 | 100.00% | 1 / 1 | 1 | ||
| [phpMyFAQ\Controller\AbstractController] addFilter | 100.00% | 1 / 1 | 100.00% | 1 / 1 | 1 | ||
| [phpMyFAQ\Controller\AbstractController] getRateLimiter | 100.00% | 4 / 4 | 100.00% | 1 / 1 | 3 | ||
| [phpMyFAQ\Controller\AbstractController] createFallbackContainer | 71.42% | 5 / 7 | 0.00% | 0 / 1 | 2.09 | ||
| 36 | final class ElasticsearchController extends AbstractController | |
| 37 | { | |
| 38 | public function __construct( | |
| 39 | private readonly Elasticsearch $elasticsearch, | |
| 40 | private readonly Faq $faq, | |
| 41 | private readonly CustomPage $customPage, | |
| 42 | ) { | |
| 43 | parent::__construct(); | |
| 44 | } | |
| 45 | ||
| 46 | /** | |
| 47 | * @throws \Exception | |
| 48 | */ | |
| 49 | #[Route(path: 'elasticsearch/create', name: 'admin.api.elasticsearch.create', methods: ['POST'])] | |
| 50 | public function create(): JsonResponse | |
| 51 | { | |
| 52 | $this->userHasPermission(PermissionType::CONFIGURATION_EDIT); | |
| 53 | ||
| 54 | try { | |
| 55 | $this->elasticsearch->createIndex(); | |
| 56 | return $this->json([ | |
| 57 | 'success' => Translation::get('msgAdminElasticsearchCreateIndex_success'), | |
| 58 | ], Response::HTTP_OK); | |
| 59 | } catch (Exception $exception) { | |
| 60 | return $this->json(['error' => $exception->getMessage()], Response::HTTP_CONFLICT); | |
| 61 | } | |
| 62 | } | |
| 63 | ||
| 64 | /** | |
| 65 | * @throws \Exception | |
| 66 | */ | |
| 67 | #[Route(path: 'elasticsearch/drop', name: 'admin.api.elasticsearch.drop', methods: ['DELETE'])] | |
| 68 | public function drop(): JsonResponse | |
| 69 | { | |
| 70 | $this->userHasPermission(PermissionType::CONFIGURATION_EDIT); | |
| 71 | ||
| 72 | try { | |
| 73 | $this->elasticsearch->dropIndex(); | |
| 74 | return $this->json([ | |
| 75 | 'success' => Translation::get('msgAdminElasticsearchDropIndex_success'), | |
| 76 | ], Response::HTTP_OK); | |
| 77 | } catch (Exception $exception) { | |
| 78 | return $this->json(['error' => $exception->getMessage()], Response::HTTP_CONFLICT); | |
| 79 | } | |
| 80 | } | |
| 81 | ||
| 82 | /** | |
| 83 | * @throws \Exception | |
| 84 | */ | |
| 85 | #[Route(path: 'elasticsearch/import', name: 'admin.api.elasticsearch.import', methods: ['POST'])] | |
| 86 | public function import(): JsonResponse | |
| 87 | { | |
| 88 | $this->userHasPermission(PermissionType::CONFIGURATION_EDIT); | |
| 89 | ||
| 90 | $this->faq->getAllFaqs(); | |
| 91 | ||
| 92 | // Index FAQs | |
| 93 | $bulkIndexResult = $this->elasticsearch->bulkIndex($this->faq->faqRecords); | |
| 94 | if (!array_key_exists('success', $bulkIndexResult)) { | |
| 95 | return $this->json(['error' => $bulkIndexResult], Response::HTTP_BAD_REQUEST); | |
| 96 | } | |
| 97 | ||
| 98 | // Index custom pages | |
| 99 | $pages = $this->customPage->getAllPages(); | |
| 100 | ||
| 101 | $bulkIndexPagesResult = $this->elasticsearch->bulkIndexCustomPages($pages); | |
| 102 | if (!array_key_exists('success', $bulkIndexPagesResult)) { | |
| 103 | return $this->json([ | |
| 104 | 'error' => 'FAQs indexed but custom pages failed: ' . (string) json_encode($bulkIndexPagesResult), | |
| 105 | ], Response::HTTP_BAD_REQUEST); | |
| 106 | } | |
| 107 | ||
| 108 | return $this->json(['success' => Translation::get(key: 'ad_es_create_import_success')], Response::HTTP_OK); | |
| 109 | } | |
| 110 | ||
| 111 | /** | |
| 112 | * @throws Exception | |
| 113 | */ | |
| 114 | #[Route(path: 'elasticsearch/statistics', name: 'admin.api.elasticsearch.statistics', methods: ['GET'])] | |
| 115 | public function statistics(): JsonResponse | |
| 116 | { | |
| 117 | $this->userHasPermission(PermissionType::CONFIGURATION_EDIT); | |
| 118 | ||
| 119 | $elasticsearchConfiguration = $this->configuration->getElasticsearchConfig(); | |
| 120 | ||
| 121 | $indexName = $elasticsearchConfiguration->getIndex(); | |
| 122 | try { | |
| 123 | $statsResponse = $this->configuration->getElasticsearch()->indices()->stats(['index' => $indexName]); | |
| 124 | if (!$statsResponse instanceof ElasticsearchResponse) { | |
| 125 | throw new \RuntimeException('Unexpected asynchronous Elasticsearch response.'); | |
| 126 | } | |
| 127 | ||
| 128 | return $this->json([ | |
| 129 | 'index' => $indexName, | |
| 130 | 'stats' => $statsResponse->asArray(), | |
| 131 | ], Response::HTTP_OK); | |
| 132 | } catch (ClientResponseException|ServerResponseException $e) { | |
| 133 | return $this->json(['error' => $e->getMessage()], Response::HTTP_BAD_REQUEST); | |
| 134 | } | |
| 135 | } | |
| 136 | ||
| 137 | #[Route(path: 'elasticsearch/healthcheck', name: 'admin.api.elasticsearch.healthcheck', methods: ['GET'])] | |
| 138 | public function healthcheck(): JsonResponse | |
| 139 | { | |
| 140 | $this->userHasPermission(PermissionType::CONFIGURATION_EDIT); | |
| 141 | ||
| 142 | $isAvailable = $this->elasticsearch->isAvailable(); | |
| 143 | ||
| 144 | return $this->json( | |
| 145 | [ | |
| 146 | 'available' => $isAvailable, | |
| 147 | 'status' => $isAvailable ? 'healthy' : 'unavailable', | |
| 148 | ], | |
| 149 | $isAvailable ? Response::HTTP_OK : Response::HTTP_SERVICE_UNAVAILABLE, | |
| 150 | ); | |
| 151 | } | |
| 152 | } |
Inherited from phpMyFAQ\Controller\AbstractController
| 93 | public function setContainer(ContainerInterface $container): void | |
| 94 | { | |
| 95 | $this->container = $container; | |
| 96 | $this->initializeFromContainer(); | |
| 97 | } |
| 104 | protected function initializeFromContainer(): void | |
| 105 | { | |
| 106 | $configuration = $this->container->get(id: 'phpmyfaq.configuration'); | |
| 107 | if (!$configuration instanceof Configuration) { | |
| 108 | throw new LogicException('Configuration service not found in container.'); | |
| 109 | } | |
| 110 | ||
| 111 | $this->configuration = $configuration; | |
| 112 | ||
| 113 | $currentUser = $this->container->get(id: 'phpmyfaq.user.current_user'); | |
| 114 | if (!$currentUser instanceof CurrentUser) { | |
| 115 | throw new LogicException('CurrentUser service not found in container.'); | |
| 116 | } | |
| 117 | ||
| 118 | $this->currentUser = $currentUser; | |
| 119 | ||
| 120 | $session = $this->container->get(id: 'session'); | |
| 121 | if (!$session instanceof FlashBagAwareSessionInterface) { | |
| 122 | throw new LogicException('Session service not found in container.'); | |
| 123 | } | |
| 124 | ||
| 125 | $this->session = $session; | |
| 126 | ||
| 127 | TwigWrapper::setTemplateSetName($this->configuration->getTemplateSet()); | |
| 128 | $this->isSecured(); | |
| 129 | } |
| 137 | public function render(string $file, array $context = [], ?Response $response = null): Response | |
| 138 | { | |
| 139 | $response ??= new Response(); | |
| 140 | $twigWrapper = $this->getTwigWrapper(); | |
| 141 | $templateWrapper = $twigWrapper->loadTemplate($file); | |
| 142 | ||
| 143 | $response->setContent($templateWrapper->render($context)); | |
| 144 | ||
| 145 | return $response; | |
| 146 | } |
| 154 | public function renderView(string $pathToTwigFile, array $templateVars = []): string | |
| 155 | { | |
| 156 | $twigWrapper = $this->getTwigWrapper(); | |
| 157 | $templateWrapper = $twigWrapper->loadTemplate($pathToTwigFile); | |
| 158 | ||
| 159 | return $templateWrapper->render($templateVars); | |
| 160 | } |
| 167 | public function json(mixed $data, int $status = 200, array $headers = []): JsonResponse | |
| 168 | { | |
| 169 | return new JsonResponse($data, $status, $headers); | |
| 170 | } |
| 182 | protected function getJsonObject(Request $request): \stdClass | |
| 183 | { | |
| 184 | /* @mago-expect analysis:mixed-assignment - json_decode() is mixed by nature; validated to stdClass below */ | |
| 185 | $data = json_decode($request->getContent(), associative: false, depth: 512, flags: JSON_THROW_ON_ERROR); | |
| 186 | ||
| 187 | if (!$data instanceof \stdClass) { | |
| 188 | throw new JsonException('The request body must be a JSON object.'); | |
| 189 | } | |
| 190 | ||
| 191 | return $data; | |
| 192 | } |
| 197 | public function getTwigWrapper(): TwigWrapper | |
| 198 | { | |
| 199 | $twigWrapper = new TwigWrapper( | |
| 200 | (string) PMF_ROOT_DIR . '/assets/templates', | |
| 201 | false, | |
| 202 | $this->configuration->getTemplateSet(), | |
| 203 | ); | |
| 204 | ||
| 205 | foreach ($this->twigExtensions as $twigExtension) { | |
| 206 | $twigWrapper->addExtension($twigExtension); | |
| 207 | } | |
| 208 | ||
| 209 | foreach ($this->twigFilters as $twigFilter) { | |
| 210 | $twigWrapper->addFilter($twigFilter); | |
| 211 | } | |
| 212 | ||
| 213 | return $twigWrapper; | |
| 214 | } |
| 219 | protected function hasValidToken(): void | |
| 220 | { | |
| 221 | $configuredToken = $this->configuration->get(item: 'api.apiClientToken'); | |
| 222 | if (!is_string($configuredToken) || $configuredToken === '') { | |
| 223 | throw new UnauthorizedHttpException(challenge: '"x-pmf-token" is not valid.'); | |
| 224 | } | |
| 225 | ||
| 226 | $request = Request::createFromGlobals(); | |
| 227 | $requestToken = $request->headers->get(key: 'x-pmf-token'); | |
| 228 | if (!is_string($requestToken) || !hash_equals($configuredToken, $requestToken)) { | |
| 229 | throw new UnauthorizedHttpException(challenge: '"x-pmf-token" is not valid.'); | |
| 230 | } | |
| 231 | } |
| 236 | protected function isSecured(): void | |
| 237 | { | |
| 238 | if ($this->currentUser->isLoggedIn()) { | |
| 239 | return; | |
| 240 | } | |
| 241 | ||
| 242 | if (!$this->configuration->get(item: 'security.enableLoginOnly')) { | |
| 243 | return; | |
| 244 | } | |
| 245 | ||
| 246 | $request = Request::createFromGlobals(); | |
| 247 | $pathInfo = rtrim($request->getPathInfo(), characters: '/'); | |
| 248 | $pathInfo = $pathInfo === '' ? '/' : $pathInfo; | |
| 249 | ||
| 250 | if ($this->isPublicAuthenticationPath($pathInfo)) { | |
| 251 | return; | |
| 252 | } | |
| 253 | ||
| 254 | throw new UnauthorizedHttpException(challenge: 'You are not allowed to view this content.'); | |
| 255 | } |
| 257 | private function isPublicAuthenticationPath(string $pathInfo): bool | |
| 258 | { | |
| 259 | $publicAuthenticationPaths = [ | |
| 260 | '/login', | |
| 261 | '/authenticate', | |
| 262 | '/forgot-password', | |
| 263 | '/token', | |
| 264 | '/check', | |
| 265 | '/contact.html', | |
| 266 | '/imprint.html', | |
| 267 | '/privacy.html', | |
| 268 | '/terms.html', | |
| 269 | '/accessibility.html', | |
| 270 | '/auth/azure/authorize', | |
| 271 | '/auth/azure/callback', | |
| 272 | '/auth/azure/callback.php', | |
| 273 | '/auth/keycloak/authorize', | |
| 274 | '/auth/keycloak/callback', | |
| 275 | '/auth/keycloak/logout', | |
| 276 | '/services/azure/callback', | |
| 277 | '/services/azure/callback.php', | |
| 278 | '/api/webauthn/prepare-login', | |
| 279 | '/api/webauthn/login', | |
| 280 | ]; | |
| 281 | ||
| 282 | return in_array($pathInfo, $publicAuthenticationPaths, strict: true); | |
| 283 | } |
| 288 | public function userIsAuthenticated(): void | |
| 289 | { | |
| 290 | if (!$this->currentUser->isLoggedIn()) { | |
| 291 | throw new UnauthorizedHttpException(challenge: 'User is not authenticated.'); | |
| 292 | } | |
| 293 | } |
| 298 | protected function userIsSuperAdmin(): void | |
| 299 | { | |
| 300 | if (!$this->currentUser->isSuperAdmin()) { | |
| 301 | throw new UnauthorizedHttpException(challenge: 'User is not super admin.'); | |
| 302 | } | |
| 303 | } |
| 308 | protected function userHasGroupPermission(): void | |
| 309 | { | |
| 310 | if (!$this->currentUser->isLoggedIn()) { | |
| 311 | throw new UnauthorizedHttpException(challenge: 'User is not authenticated.'); | |
| 312 | } | |
| 313 | ||
| 314 | $currentUser = $this->currentUser; | |
| 315 | if ( | |
| 316 | !$currentUser->perm->hasPermission($currentUser->getUserId(), PermissionType::USER_ADD->value) | |
| 317 | || !$currentUser->perm->hasPermission($currentUser->getUserId(), PermissionType::USER_EDIT->value) | |
| 318 | || !$currentUser->perm->hasPermission($currentUser->getUserId(), PermissionType::USER_DELETE->value) | |
| 319 | || !$currentUser->perm->hasPermission($currentUser->getUserId(), PermissionType::GROUP_EDIT->value) | |
| 320 | ) { | |
| 321 | throw new ForbiddenException(message: 'User has no group permission.'); | |
| 322 | } | |
| 323 | } |
| 328 | protected function userHasUserPermission(): void | |
| 329 | { | |
| 330 | if (!$this->currentUser->isLoggedIn()) { | |
| 331 | throw new UnauthorizedHttpException(challenge: 'User is not authenticated.'); | |
| 332 | } | |
| 333 | ||
| 334 | $currentUser = $this->currentUser; | |
| 335 | if ( | |
| 336 | !$currentUser->perm->hasPermission($currentUser->getUserId(), PermissionType::USER_ADD->value) | |
| 337 | || !$currentUser->perm->hasPermission($currentUser->getUserId(), PermissionType::USER_EDIT->value) | |
| 338 | || !$currentUser->perm->hasPermission($currentUser->getUserId(), PermissionType::USER_DELETE->value) | |
| 339 | ) { | |
| 340 | throw new ForbiddenException(message: 'User has no user permission.'); | |
| 341 | } | |
| 342 | } |
| 347 | protected function userHasPermission(PermissionType $permissionType): void | |
| 348 | { | |
| 349 | if (!$this->currentUser->isLoggedIn()) { | |
| 350 | throw new UnauthorizedHttpException(challenge: 'User is not authenticated.'); | |
| 351 | } | |
| 352 | ||
| 353 | $currentUser = $this->currentUser; | |
| 354 | if (!$currentUser?->perm->hasPermission($currentUser->getUserId(), $permissionType->value)) { | |
| 355 | throw new ForbiddenException(message: sprintf('User has no "%s" permission.', $permissionType->name)); | |
| 356 | } | |
| 357 | } |
| 364 | protected function userHasAnyPermission(PermissionType ...$permissionTypes): void | |
| 365 | { | |
| 366 | if (!$this->currentUser->isLoggedIn()) { | |
| 367 | throw new UnauthorizedHttpException(challenge: 'User is not authenticated.'); | |
| 368 | } | |
| 369 | ||
| 370 | $currentUser = $this->currentUser; | |
| 371 | foreach ($permissionTypes as $permissionType) { | |
| 372 | if ($currentUser->perm->hasPermission($currentUser->getUserId(), $permissionType->value)) { | |
| 373 | return; | |
| 374 | } | |
| 375 | } | |
| 376 | ||
| 377 | throw new ForbiddenException(message: sprintf('User has none of the required permissions: %s.', implode(', ', array_map( | |
| 378 | static fn(PermissionType $type): string => $type->name, | |
| 379 | $permissionTypes, | |
| 380 | )))); | |
| 381 | } |
| 389 | protected function verifySessionCsrfToken(string $page, #[\SensitiveParameter] string $requestToken): bool | |
| 390 | { | |
| 391 | if ($requestToken === '') { | |
| 392 | return false; | |
| 393 | } | |
| 394 | ||
| 395 | $sessionKey = sprintf('pmf-csrf-token.%s', $page); | |
| 396 | $storedToken = $this->session->get($sessionKey); | |
| 397 | ||
| 398 | if (!$storedToken instanceof Token) { | |
| 399 | return false; | |
| 400 | } | |
| 401 | ||
| 402 | if (time() > $storedToken->getExpiry()) { | |
| 403 | $this->session->remove($sessionKey); | |
| 404 | return false; | |
| 405 | } | |
| 406 | ||
| 407 | return hash_equals($storedToken->getSessionToken(), $requestToken); | |
| 408 | } |
| 414 | protected function captchaCodeIsValid(Request $request): bool | |
| 415 | { | |
| 416 | $captcha = Captcha::getInstance($this->configuration); | |
| 417 | $captcha->setUserIsLoggedIn($this->currentUser->isLoggedIn()); | |
| 418 | ||
| 419 | $data = json_decode($request->getContent(), associative: false, depth: 512, flags: JSON_THROW_ON_ERROR); | |
| 420 | ||
| 421 | $code = Filter::filterVar($data->captcha ?? '', FILTER_SANITIZE_SPECIAL_CHARS); | |
| 422 | if ($this->configuration->get(item: 'security.enableGoogleReCaptchaV2')) { | |
| 423 | $code = Filter::filterVar($data->{'g-recaptcha-response'} ?? '', FILTER_SANITIZE_SPECIAL_CHARS); | |
| 424 | } | |
| 425 | ||
| 426 | return $captcha->checkCaptchaCode((string) $code); | |
| 427 | } |
| 429 | public function isApiEnabled(): bool | |
| 430 | { | |
| 431 | return (bool) $this->configuration->get(item: 'api.enableAccess'); | |
| 432 | } |
| 434 | public function addExtension(ExtensionInterface $extension): void | |
| 435 | { | |
| 436 | $this->twigExtensions[] = $extension; | |
| 437 | } |
| 439 | public function addFilter(TwigFilter $twigFilter): void | |
| 440 | { | |
| 441 | $this->twigFilters[] = $twigFilter; | |
| 442 | } |
| 444 | protected function getRateLimiter(): ?RateLimiter | |
| 445 | { | |
| 446 | if (!$this->container->has('phpmyfaq.http.rate-limiter')) { | |
| 447 | return null; | |
| 448 | } | |
| 449 | ||
| 450 | $rateLimiter = $this->container->get('phpmyfaq.http.rate-limiter'); | |
| 451 | ||
| 452 | return $rateLimiter instanceof RateLimiter ? $rateLimiter : null; | |
| 453 | } |
| 455 | private function createFallbackContainer(): ContainerBuilder | |
| 456 | { | |
| 457 | $containerBuilder = new ContainerBuilder(); | |
| 458 | $phpFileLoader = new PhpFileLoader($containerBuilder, new FileLocator(__DIR__)); | |
| 459 | try { | |
| 460 | $phpFileLoader->load(resource: '../../services.php'); | |
| 461 | } catch (\Exception $exception) { | |
| 462 | error_log($exception->getMessage()); | |
| 463 | } | |
| 464 | ||
| 465 | // Register Forms services | |
| 466 | FormsServiceProvider::register($containerBuilder); | |
| 467 | ||
| 468 | return $containerBuilder; | |
| 469 | } |