Lines 90.94% 221 / 243
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.48% 86 / 94 0.00% 0 / 1 32.63
 isCommentAllowed 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
45final class CommentController extends AbstractController
46{
47    /* @mago-expect lint:excessive-parameter-list - the controller dependencies are injected explicitly */
48    public function __construct(
49        private readonly Faq $faq,
50        private readonly Comments $comments,
51        private readonly StopWords $stopWords,
52        private readonly UserSession $userSession,
53        private readonly Language $language,
54        private readonly User $user,
55        private readonly Notification $notification,
56        private readonly News $news,
57        private readonly Gravatar $gravatar,
58    ) {
59        parent::__construct();
60    }
61
62    /**
63     * @throws Exception
64     * @throws \JsonException
65     * @throws \Exception|TransportExceptionInterface
66     */
67    #[Route(path: 'comment/create', name: 'api.private.comment', methods: ['POST'])]
68    public function create(Request $request): JsonResponse
69    {
70        $this->userSession->setCurrentUser($this->currentUser);
71
72        $defaultLanguage = (string) $this->configuration->get(item: 'main.language');
73        $languageCode = $this->configuration->get(item: 'main.languageDetection')
74            ? $this->language->setLanguageWithDetection($defaultLanguage)
75            : $this->language->setLanguageFromConfiguration($defaultLanguage);
76
77        if (!$this->isCommentAllowed($this->currentUser)) {
78            return $this->json(['error' => Translation::get(key: 'ad_msg_noauth')], Response::HTTP_FORBIDDEN);
79        }
80
81        $data = json_decode($request->getContent(), associative: false, depth: 512, flags: JSON_THROW_ON_ERROR);
82        if (!$data instanceof \stdClass) {
83            throw new Exception('The request body must be a JSON object');
84        }
85
86        if (($data->{'pmf-csrf-token'} ?? null) === null) {
87            throw new Exception('Missing CSRF token');
88        }
89
90        if (!Token::getInstance($this->session)->verifyToken(
91            page: 'add-comment',
92            requestToken: (string) $data->{'pmf-csrf-token'},
93        )) {
94            throw new Exception('Invalid CSRF token');
95        }
96
97        if (($data->user ?? null) === null) {
98            throw new Exception('Missing user');
99        }
100
101        if (($data->mail ?? null) === null) {
102            throw new Exception('Missing email');
103        }
104
105        if (($data->comment_text ?? null) === null) {
106            throw new Exception('Missing or empty comment text');
107        }
108
109        $type = Filter::filterVar($data->type ?? '', FILTER_SANITIZE_SPECIAL_CHARS, '');
110
111        if ($type === 'news') {
112            throw new Exception('News comments not supported');
113        }
114
115        $faqId = Filter::filterVar($data->id ?? null, FILTER_VALIDATE_INT, default: 0);
116        $newsId = Filter::filterVar($data->newsId ?? null, FILTER_VALIDATE_INT);
117        $username = Filter::filterVar($data->user, FILTER_SANITIZE_SPECIAL_CHARS, '');
118        $email = Filter::filterEmail($data->mail);
119
120        if (!$email) {
121            throw new Exception('Invalid email address');
122        }
123
124        $email = Filter::filterVar($email, FILTER_SANITIZE_SPECIAL_CHARS, '');
125
126        if (!$this->captchaCodeIsValid($request)) {
127            return $this->json(['error' => Translation::get(key: 'msgCaptcha')], Response::HTTP_BAD_REQUEST);
128        }
129
130        // Check if user is logged in and editor is enabled
131        $enableCommentEditor = (bool) $this->configuration->get('main.enableCommentEditor');
132        $isLoggedIn = $this->currentUser->isLoggedIn();
133
134        // Sanitize comment text based on user status and configuration
135        $commentText = Filter::filterVar($data->comment_text, FILTER_SANITIZE_SPECIAL_CHARS, '');
136        if ($enableCommentEditor && $isLoggedIn) {
137            // Allow HTML for logged-in users when editor is enabled, using Symfony HtmlSanitizer
138            $commentText = Filter::removeAttributes((string) $data->comment_text);
139        }
140
141        $commentId = match ($type) {
142            'news' => (int) $newsId,
143            'faq' => (int) $faqId,
144            default => 0,
145        };
146
147        if ($commentId === 0) {
148            return $this->json(['error' => Translation::get(key: 'errSaveComment')], Response::HTTP_BAD_REQUEST);
149        }
150
151        // Check display name and e-mail address for not logged-in users
152        if (!$this->currentUser->isLoggedIn()) {
153            if ($this->user->checkDisplayName($username) && $this->user->checkMailAddress($email)) {
154                $this->configuration->getLogger()->error(message: 'Name and email already used by registered user.');
155                return $this->json(['error' => Translation::get(key: 'errSaveComment')], Response::HTTP_CONFLICT);
156            }
157        }
158
159        if (
160            $username !== ''
161            && $email !== ''
162            && $commentText !== ''
163            && $this->stopWords->checkBannedWord($commentText)
164            && $this->comments->isCommentAllowed($commentId, $languageCode, $type)
165            && $this->faq->isActive($commentId, $languageCode, $type)
166        ) {
167            $this->userSession->userTracking(action: 'save_comment', data: $commentId);
168            $commentEntity = new Comment();
169            $commentEntity
170                ->setRecordId((int) $commentId)
171                ->setType($type)
172                ->setUsername($username)
173                ->setEmail($email)
174                ->setComment(
175                    $enableCommentEditor && $isLoggedIn
176                        ? (string) $commentText
177                        : nl2br(strip_tags((string) $commentText)),
178                ) // Already sanitized with HTML support // Plain text with line breaks
179                ->setDate((string) $request->server->get(key: 'REQUEST_TIME'));
180
181            if ($this->comments->create($commentEntity)) {
182                if ('faq' === $type) {
183                    $this->faq->getFaq($commentId);
184                    $this->notification->sendFaqCommentNotification($this->faq, $commentEntity);
185                }
186
187                if ('news' === $type) {
188                    $newsData = $this->news->get($commentId);
189                    $this->notification->sendNewsCommentNotification($newsData, $commentEntity);
190                }
191
192                $gravatarUrl = $this->gravatar->getImageUrl($commentEntity->getEmail(), [
193                    'size' => '50',
194                    'default' => 'mm',
195                ]);
196
197                return $this->json([
198                    'success' => Translation::get(key: 'msgCommentThanks'),
199                    'commentData' => [
200                        'username' => $commentEntity->getUsername(),
201                        'comment' => $commentEntity->getComment(),
202                        'date' => $commentEntity->getDate(),
203                        'gravatarUrl' => $gravatarUrl,
204                    ],
205                ], Response::HTTP_OK);
206            }
207
208            $this->userSession->userTracking(action: 'error_save_comment', data: $commentId);
209            return $this->json(['error' => Translation::get(key: 'errSaveComment')], Response::HTTP_BAD_REQUEST);
210        }
211
212        return $this->json([
213            'error' => 'Please add your name, your e-mail address and a comment!',
214        ], Response::HTTP_BAD_REQUEST);
215    }
216
217    /**
218     * @throws \Exception
219     */
220    private function isCommentAllowed(CurrentUser $currentUser): bool
221    {
222        return !(
223            !$this->configuration->get(item: 'records.allowCommentsForGuests')
224            && !$currentUser->perm->hasPermission($currentUser->getUserId(), PermissionType::COMMENT_ADD->value)
225        );
226    }
227}

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    }