Lines 80.95% 187 / 231
Methods 62.96% 17 / 27
Classes 0.00% 0 / 1
Covered by tests of size
Name Lines Methods CRAP
 delete 68.75% 11 / 16 0.00% 0 / 1 5.76
 refresh 70.00% 14 / 20 0.00% 0 / 1 5.68
 upload 63.79% 37 / 58 0.00% 0 / 1 25.68
 [phpMyFAQ\Controller\Administration\Api\AbstractAdministrationApiController] initializeFromContainer 80.00% 4 / 5 0.00% 0 / 1 2.03
 [phpMyFAQ\Controller\AbstractController] __construct 100.00% 2 / 2 100.00% 1 / 1 1
 [phpMyFAQ\Controller\AbstractController] setContainer 100.00% 2 / 2 100.00% 1 / 1 1
 [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
38final class AttachmentController extends AbstractAdministrationApiController
39{
40    /**
41     * @throws \Exception
42     */
43    #[Route(path: 'content/attachments', name: 'admin.api.content.attachments', methods: ['DELETE'])]
44    public function delete(Request $request): JsonResponse
45    {
46        $this->userHasPermission(PermissionType::ATTACHMENT_DELETE);
47
48        $deleteData = $this->getJsonObject($request);
49        try {
50            if (!$this->verifySessionCsrfToken('delete-attachment', (string) ($deleteData->csrf ?? ''))) {
51                return $this->json(['error' => Translation::get(key: 'msgNoPermission')], Response::HTTP_UNAUTHORIZED);
52            }
53
54            $attId = Filter::filterVar($deleteData->attId ?? null, FILTER_VALIDATE_INT);
55            if (!$attId) {
56                return $this->json(['error' => 'Invalid attachment ID'], Response::HTTP_BAD_REQUEST);
57            }
58
59            $attId = (int) $attId;
60            $attachment = AttachmentFactory::create($attId);
61            if ($attachment->delete()) {
62                $this->adminLog->log($this->currentUser, AdminLogType::ATTACHMENT_DELETE->value . ':' . $attId);
63
64                return $this->json(['success' => Translation::get(key: 'msgAttachmentsDeleted')], Response::HTTP_OK);
65            }
66
67            return $this->json(['error' => Translation::get(key: 'ad_att_delfail')], Response::HTTP_BAD_REQUEST);
68        } catch (AttachmentException $attachmentException) {
69            $result = ['error' => $attachmentException->getMessage()];
70            return $this->json($result, Response::HTTP_INTERNAL_SERVER_ERROR);
71        }
72    }
73
74    /**
75     * @throws \Exception
76     */
77    #[Route(path: 'content/attachments/refresh', name: 'admin.api.content.attachments.refresh', methods: ['POST'])]
78    public function refresh(Request $request): JsonResponse
79    {
80        $this->userHasPermission(PermissionType::ATTACHMENT_DELETE);
81
82        $dataToCheck = $this->getJsonObject($request);
83        try {
84            if (!$this->verifySessionCsrfToken('refresh-attachment', (string) ($dataToCheck->csrf ?? ''))) {
85                return $this->json(['error' => Translation::get(key: 'msgNoPermission')], Response::HTTP_UNAUTHORIZED);
86            }
87
88            $attId = Filter::filterVar($dataToCheck->attId ?? null, FILTER_VALIDATE_INT);
89            if (!$attId) {
90                return $this->json(['error' => 'Invalid attachment ID'], Response::HTTP_BAD_REQUEST);
91            }
92
93            $attId = (int) $attId;
94            $attachment = AttachmentFactory::create($attId);
95            $result = [
96                'success' => Translation::get(key: 'msgAdminAttachmentRefreshed'),
97                'delete' => false,
98            ];
99            if (!$attachment->isStorageOk()) {
100                $attachment->deleteMeta();
101                $result = ['success' => Translation::get(key: 'ad_att_delsuc'), 'delete' => true];
102            }
103
104            return $this->json($result, Response::HTTP_OK);
105        } catch (AttachmentException $attachmentException) {
106            $result = ['error' => $attachmentException->getMessage()];
107            return $this->json($result, Response::HTTP_INTERNAL_SERVER_ERROR);
108        }
109    }
110
111    /**
112     * @throws AttachmentException
113     * @throws FileException
114     * @throws Exception
115     * @throws \Exception
116     */
117    #[Route(path: 'content/attachments/upload', name: 'admin.api.content.attachments.upload', methods: ['POST'])]
118    public function upload(Request $request): JsonResponse
119    {
120        $this->userHasPermission(PermissionType::ATTACHMENT_ADD);
121
122        $csrfToken = (string) Filter::filterVar(
123            $request->request->get('pmf-csrf-token'),
124            FILTER_SANITIZE_SPECIAL_CHARS,
125        );
126        if (!$this->verifySessionCsrfToken('upload-attachment', $csrfToken)) {
127            return $this->json(['error' => Translation::get(key: 'msgNoPermission')], Response::HTTP_UNAUTHORIZED);
128        }
129
130        $files = $request->files->get('filesToUpload');
131
132        if (!$files) {
133            return $this->json(['error' => Translation::get(key: 'msgNoImagesForUpload')], Response::HTTP_BAD_REQUEST);
134        }
135
136        $files = is_array($files) ? $files : [$files];
137        $uploadedFiles = [];
138        $customFileNames = $request->request->all('customFileNames');
139
140        foreach ($files as $index => $file) {
141            if (!$file instanceof UploadedFile) {
142                return $this->json([
143                    'error' => Translation::get(key: 'msgNoImagesForUpload'),
144                ], Response::HTTP_BAD_REQUEST);
145            }
146
147            if (
148                !$file->isValid()
149                || (int) $file->getSize() > (int) $this->configuration->get(item: 'records.maxAttachmentSize')
150                || $file->getMimeType() === 'text/html'
151            ) {
152                return $this->json(['error' => Translation::get(key: 'msgImageTooLarge')], Response::HTTP_BAD_REQUEST);
153            }
154
155            $recordId = Filter::filterVar($request->request->get('record_id'), FILTER_VALIDATE_INT);
156
157            if ($recordId === null) {
158                return $this->json([
159                    'error' => Translation::get(key: 'msgNoImagesForUpload'),
160                ], Response::HTTP_BAD_REQUEST);
161            }
162
163            $attachment = AttachmentFactory::create();
164            $attachment->setRecordId((int) $recordId);
165            $attachment->setRecordLang((string) Filter::filterVar(
166                $request->request->get('record_lang'),
167                FILTER_SANITIZE_SPECIAL_CHARS,
168                '',
169            ));
170            try {
171                $customFileName = array_key_exists($index, $customFileNames) ? $customFileNames[$index] : null;
172                $filename = Filename::compose(
173                    $file->getClientOriginalName(),
174                    is_string($customFileName) ? $customFileName : null,
175                );
176                if (!$attachment->save($file->getPathname(), $filename)) {
177                    return $this->json([
178                        'error' => Translation::get('msgImageCouldNotBeUploaded'),
179                    ], Response::HTTP_INTERNAL_SERVER_ERROR);
180                }
181            } catch (AttachmentException|FileNotFoundException $exception) {
182                return $this->json(['error' => $exception->getMessage()], Response::HTTP_INTERNAL_SERVER_ERROR);
183            }
184
185            $uploadedFiles[] = [
186                'attachmentId' => $attachment->getId(),
187                'fileName' => $attachment->getFilename(),
188                'faqId' => $request->request->get('record_id'),
189                'faqLanguage' => $request->request->get('record_lang'),
190            ];
191        }
192
193        if ($uploadedFiles !== []) {
194            $attachmentIds = array_column($uploadedFiles, 'attachmentId');
195            $this->adminLog->log(
196                $this->currentUser,
197                AdminLogType::ATTACHMENT_ADD->value . ':' . implode(',', $attachmentIds),
198            );
199        }
200
201        return $this->json($uploadedFiles, Response::HTTP_OK);
202    }
203}

Inherited from phpMyFAQ\Controller\Administration\Api\AbstractAdministrationApiController

31    protected function initializeFromContainer(): void
32    {
33        parent::initializeFromContainer();
34
35        $adminLog = $this->container->get(id: 'phpmyfaq.admin.admin-log');
36        if (!$adminLog instanceof AdminLog) {
37            throw new \LogicException('AdminLog service not found in container.');
38        }
39
40        $this->adminLog = $adminLog;
41    }

Inherited from phpMyFAQ\Controller\AbstractController

83    public function __construct()
84    {
85        $this->container = ContainerRegistry::get() ?? $this->createFallbackContainer();
86        $this->initializeFromContainer();
87    }
93    public function setContainer(ContainerInterface $container): void
94    {
95        $this->container = $container;
96        $this->initializeFromContainer();
97    }
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    }