Lines 90.80% 237 / 261
Methods 69.23% 18 / 26
Classes 0.00% 0 / 1
Covered by tests of size
Name Lines Methods CRAP
 __construct 100.00% 1 / 1 100.00% 1 / 1 1
 create 91.07% 102 / 112 0.00% 0 / 1 37.97
 isAddingFaqsAllowed 100.00% 4 / 4 100.00% 1 / 1 2
 [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
47final class FaqController extends AbstractController
48{
49    /* @mago-expect lint:excessive-parameter-list - the controller dependencies are injected explicitly */
50    public function __construct(
51        private readonly Faq $faq,
52        private readonly FaqHelper $faqHelper,
53        private readonly Question $question,
54        private readonly StopWords $stopWords,
55        private readonly UserSession $userSession,
56        private readonly Language $language,
57        private readonly CategoryHelper $categoryHelper,
58        private readonly Notification $notification,
59    ) {
60        parent::__construct();
61    }
62
63    /**
64     * @throws Exception|\JsonException|\Exception
65     */
66    #[Route(path: 'faq/create', name: 'api.private.faq.create', methods: ['POST'])]
67    public function create(Request $request): JsonResponse
68    {
69        $this->userSession->setCurrentUser($this->currentUser);
70
71        $categoryPermission = new CategoryPermission($this->configuration);
72        $faqPermission = new FaqPermission($this->configuration);
73
74        $defaultLanguage = (string) $this->configuration->get(item: 'main.language');
75        $languageCode = $this->configuration->get(item: 'main.languageDetection')
76            ? $this->language->setLanguageWithDetection($defaultLanguage)
77            : $this->language->setLanguageFromConfiguration($defaultLanguage);
78
79        if (!$this->isAddingFaqsAllowed($this->currentUser)) {
80            return $this->json(['error' => Translation::get(key: 'ad_msg_noauth')], Response::HTTP_FORBIDDEN);
81        }
82
83        $data = json_decode($request->getContent(), associative: false, depth: 512, flags: JSON_THROW_ON_ERROR);
84        if (!$data instanceof \stdClass) {
85            throw new Exception('Invalid request payload');
86        }
87
88        if (!property_exists($data, 'name')) {
89            throw new Exception('Missing name');
90        }
91
92        if (!property_exists($data, 'question') || trim((string) $data->question) === '') {
93            throw new Exception('Missing or empty question');
94        }
95
96        if (!property_exists($data, 'answer')) {
97            throw new Exception('Missing answer');
98        }
99
100        $author = trim((string) Filter::filterVar($data->name, FILTER_SANITIZE_SPECIAL_CHARS));
101        $email = trim((string) Filter::filterEmail($data->email));
102        $email = Filter::filterVar($email, FILTER_SANITIZE_SPECIAL_CHARS);
103
104        if (!$email) {
105            throw new Exception('Invalid email address');
106        }
107
108        $questionText = Filter::filterVar($data->question, FILTER_SANITIZE_SPECIAL_CHARS);
109        $questionText = trim(strip_tags((string) $questionText));
110
111        $answer = Filter::filterVar($data->answer, FILTER_SANITIZE_SPECIAL_CHARS, '');
112        if ($this->configuration->get(item: 'main.enableWysiwygEditorFrontend')) {
113            // html_entity_decode() turns surviving HTML entities back into executable
114            // markup, so the decoded result must be passed through the HTML sanitizer
115            // before it is stored. Otherwise it is rendered unescaped in the admin
116            // FAQ editor (faq.editor.twig uses the |raw filter), enabling stored XSS.
117            $answer = $this->faqHelper->cleanUpContent(trim(html_entity_decode((string) $answer)));
118        }
119
120        if (!$this->configuration->get(item: 'main.enableWysiwygEditorFrontend')) {
121            $answer = trim(nl2br(strip_tags((string) $answer)));
122        }
123
124        $category = new Category($this->configuration);
125        $keywords = Filter::filterVar($data->keywords, FILTER_SANITIZE_SPECIAL_CHARS, '');
126        $categories = [];
127
128        if (property_exists($data, 'rubrik')) {
129            if (is_string($data->rubrik)) {
130                $data->rubrik = [$data->rubrik];
131            }
132
133            $categories = Filter::filterArray(is_array($data->rubrik) ? $data->rubrik : []);
134        }
135
136        if ($categories === []) {
137            $allCategoryIds = $category->getAllCategoryIds();
138            if (count($allCategoryIds) === 0) {
139                throw new Exception('No categories available');
140            }
141
142            $categories = [$allCategoryIds[0]];
143        }
144
145        $categories = array_values(array_filter(
146            array_map(static fn($v): ?int => Filter::filterVar($v, FILTER_VALIDATE_INT), (array) ($categories ?? [])),
147            static fn($v): bool => $v !== null,
148        ));
149
150        if (!$this->captchaCodeIsValid($request)) {
151            return $this->json(['error' => Translation::get(key: 'msgCaptcha')], Response::HTTP_BAD_REQUEST);
152        }
153
154        if (
155            $author !== ''
156            && $author !== '0'
157            && $email !== ''
158            && $email !== '0'
159            && $questionText !== ''
160            && $questionText !== '0'
161            && $this->stopWords->checkBannedWord(strip_tags($questionText))
162        ) {
163            if ($answer === '' || $answer === '0') {
164                $answer = '';
165            }
166
167            if ($answer !== '' && !$this->stopWords->checkBannedWord(strip_tags($answer))) {
168                return $this->json(['error' => Translation::get(key: 'errSaveEntries')], Response::HTTP_BAD_REQUEST);
169            }
170
171            $this->userSession->userTracking('save_new_entry', 0);
172
173            $autoActivate = $this->configuration->get(item: 'records.defaultActivation');
174
175            $faqEntity = new FaqEntity();
176            $faqEntity
177                ->setLanguage($languageCode)
178                ->setQuestion($questionText)
179                ->setActive((bool) $autoActivate)
180                ->setSticky(false)
181                ->setAnswer($answer)
182                ->setKeywords($keywords)
183                ->setAuthor($author)
184                ->setEmail($email)
185                ->setComment(true)
186                ->setNotes('');
187
188            $this->faq->create($faqEntity);
189            $recordId = $faqEntity->getId();
190
191            if ($recordId === null) {
192                return $this->json(['error' => Translation::get(key: 'errSaveEntries')], Response::HTTP_BAD_REQUEST);
193            }
194
195            $openQuestionId = property_exists($data, 'openQuestionID')
196                ? Filter::filterVar($data->openQuestionID, FILTER_VALIDATE_INT)
197                : false;
198            if ($openQuestionId) {
199                if ($this->configuration->get(item: 'records.enableDeleteQuestion')) {
200                    $this->question->delete($openQuestionId);
201                }
202
203                if (!$this->configuration->get(item: 'records.enableDeleteQuestion')) {
204                    // Adds this faq record id to the related open question.
205                    $this->question->updateQuestionAnswer((int) $openQuestionId, (int) $recordId, (int) $categories[0]);
206                }
207            }
208
209            $faqMetaData = new MetaData($this->configuration);
210            $faqMetaData
211                ->setFaqId($recordId)
212                ->setFaqLanguage($faqEntity->getLanguage())
213                ->setCategories($categories)
214                ->save();
215
216            // Let the admin and the category owners to be informed by email of this new entry
217            $this->categoryHelper->setCategory($category)->setConfiguration($this->configuration);
218
219            $moderators = $this->categoryHelper->getModerators($categories);
220
221            // Add user and group permissions
222            $permissions = $categoryPermission->getAll($categories);
223            foreach ($categories as $category) {
224                $faqPermission->add(FaqPermission::USER, $recordId, $permissions[$category]['user'] ?? []);
225                if ($this->configuration->get(item: 'security.permLevel') !== 'basic') {
226                    $faqPermission->add(FaqPermission::GROUP, $recordId, $permissions[$category]['group'] ?? []);
227                }
228            }
229
230            try {
231                $this->notification->sendNewFaqAdded($moderators, $faqEntity);
232            } catch (Exception|TransportExceptionInterface $e) {
233                $this->configuration->getLogger()->info('Notification could not be sent: ', [$e->getMessage()]);
234            }
235
236            $link = [];
237            if ($this->configuration->get(item: 'records.defaultActivation')) {
238                $link = [
239                    'link' => $this->faqHelper->createFaqUrl($faqEntity, (int) $categories[0]),
240                    'info' => Translation::get(key: 'msgRedirect'),
241                ];
242            }
243
244            return $this->json([
245                'success' => Translation::get(key: 'msgNewContentThanks'),
246                ...$link,
247            ], Response::HTTP_OK);
248        }
249
250        return $this->json(['error' => Translation::get(key: 'errSaveEntries')], Response::HTTP_BAD_REQUEST);
251    }
252
253    /**
254     * @throws \Exception
255     */
256    private function isAddingFaqsAllowed(CurrentUser $currentUser): bool
257    {
258        return !(
259            !$this->configuration->get(item: 'records.allowNewFaqsForGuests')
260            && !$currentUser->perm->hasPermission($currentUser->getUserId(), PermissionType::FAQ_ADD->value)
261        );
262    }
263}

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    }