Lines 89.11% 262 / 294
Methods 76.92% 30 / 39
Classes 0.00% 0 / 1
Covered by tests of size
Name Lines Methods CRAP
 __construct 100.00% 1 / 1 100.00% 1 / 1 1
 setCategoryFactory 100.00% 1 / 1 100.00% 1 / 1 1
 setCategoryPermissionFactory 100.00% 1 / 1 100.00% 1 / 1 1
 setOrderFactory 100.00% 1 / 1 100.00% 1 / 1 1
 list 100.00% 30 / 30 100.00% 1 / 1 1
 create 75.64% 59 / 78 0.00% 0 / 1 18.25
 createCategory 100.00% 5 / 5 100.00% 1 / 1 3
 createCategoryPermission 80.00% 4 / 5 0.00% 0 / 1 3.07
 createOrder 80.00% 4 / 5 0.00% 0 / 1 3.07
 [phpMyFAQ\Controller\Api\AbstractApiController] initializeFromContainer 100.00% 3 / 3 100.00% 1 / 1 2
 [phpMyFAQ\Controller\Api\AbstractApiController] getPaginationRequest 100.00% 2 / 2 100.00% 1 / 1 1
 [phpMyFAQ\Controller\Api\AbstractApiController] getSortRequest 100.00% 1 / 1 100.00% 1 / 1 1
 [phpMyFAQ\Controller\Api\AbstractApiController] getFilterRequest 100.00% 1 / 1 100.00% 1 / 1 1
 [phpMyFAQ\Controller\Api\AbstractApiController] paginatedResponse 100.00% 25 / 25 100.00% 1 / 1 3
 [phpMyFAQ\Controller\Api\AbstractApiController] apiResponse 100.00% 2 / 2 100.00% 1 / 1 1
 [phpMyFAQ\Controller\Api\AbstractApiController] errorResponse 100.00% 2 / 2 100.00% 1 / 1 1
 [phpMyFAQ\Controller\Api\AbstractApiController] createResponseEtag 100.00% 1 / 1 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
37final class CategoryController extends AbstractApiController
38{
39    /** @var null|callable */
40    private $categoryFactory = null;
41
42    /** @var null|callable */
43    private $categoryPermissionFactory = null;
44
45    /** @var null|callable */
46    private $orderFactory = null;
47
48    public function __construct(
49        private readonly Language $language,
50    ) {
51        parent::__construct();
52    }
53
54    public function setCategoryFactory(callable $categoryFactory): void
55    {
56        $this->categoryFactory = $categoryFactory;
57    }
58
59    public function setCategoryPermissionFactory(callable $categoryPermissionFactory): void
60    {
61        $this->categoryPermissionFactory = $categoryPermissionFactory;
62    }
63
64    public function setOrderFactory(callable $orderFactory): void
65    {
66        $this->orderFactory = $orderFactory;
67    }
68
69    /**
70     * @throws \Exception
71     */
72    #[OA\Get(path: '/api/v4.0/categories', operationId: 'getCategories', tags: ['Public Endpoints'])]
73    #[OA\Header(
74        header: 'Accept-Language',
75        description: 'The language code for the categories.',
76        schema: new OA\Schema(type: 'string'),
77    )]
78    #[OA\Parameter(
79        name: 'page',
80        description: 'Page number for pagination (page-based)',
81        in: 'query',
82        required: false,
83        schema: new OA\Schema(type: 'integer', default: 1),
84    )]
85    #[OA\Parameter(
86        name: 'per_page',
87        description: 'Items per page (page-based, max 100)',
88        in: 'query',
89        required: false,
90        schema: new OA\Schema(type: 'integer', default: 25),
91    )]
92    #[OA\Parameter(
93        name: 'limit',
94        description: 'Number of items to return (offset-based, max 100)',
95        in: 'query',
96        required: false,
97        schema: new OA\Schema(type: 'integer', default: 25),
98    )]
99    #[OA\Parameter(
100        name: 'offset',
101        description: 'Starting offset (offset-based)',
102        in: 'query',
103        required: false,
104        schema: new OA\Schema(type: 'integer', default: 0),
105    )]
106    #[OA\Parameter(name: 'sort', description: 'Field to sort by', in: 'query', required: false, schema: new OA\Schema(
107        type: 'string',
108        default: 'id',
109        enum: ['id', 'name', 'parent_id', 'active'],
110    ))]
111    #[OA\Parameter(
112        name: 'order',
113        description: 'Sort direction',
114        in: 'query',
115        required: false,
116        schema: new OA\Schema(type: 'string', default: 'asc', enum: ['asc', 'desc']),
117    )]
118    #[OA\Response(
119        response: 200,
120        description: 'Returns paginated categories for the given language provided by "Accept-Language".',
121        content: new OA\JsonContent(example: [
122            'success' => true,
123            'data' => [[
124                'id' => 1,
125                'lang' => 'en',
126                'parent_id' => 0,
127                'name' => 'Test',
128                'description' => 'Hello, World! Hello, Tests!',
129                'user_id' => 1,
130                'group_id' => 1,
131                'active' => 1,
132                'show_home' => 1,
133                'image' => 'category-1-en.png',
134                'level' => 1,
135            ]],
136            'meta' => [
137                'pagination' => [
138                    'total' => 50,
139                    'count' => 25,
140                    'per_page' => 25,
141                    'current_page' => 1,
142                    'total_pages' => 2,
143                    'links' => [
144                        'first' => '/api/v4.0/categories?page=1&per_page=25',
145                        'last' => '/api/v4.0/categories?page=2&per_page=25',
146                        'prev' => null,
147                        'next' => '/api/v4.0/categories?page=2&per_page=25',
148                    ],
149                ],
150                'sorting' => [
151                    'field' => 'id',
152                    'order' => 'asc',
153                ],
154            ],
155        ]),
156    )]
157    #[Route(path: 'v4.0/categories', name: 'api.categories.list', methods: ['GET'])]
158    public function list(?Request $request = null): JsonResponse
159    {
160        $request ??= Request::createFromGlobals();
161        $currentLanguage = $this->language->setLanguageByAcceptLanguage();
162
163        [$currentUser, $currentGroups] = CurrentUser::getCurrentUserGroupId($this->currentUser);
164
165        $category = $this->createCategory($currentGroups);
166        $category->setUser($currentUser);
167        $category->setGroups($currentGroups);
168        $category->setLanguage($currentLanguage);
169
170        $onlyActive = (bool) $this->configuration->get('api.onlyActiveCategories');
171
172        // Get pagination and sorting parameters
173        $pagination = $this->getPaginationRequest($request);
174        $sort = $this->getSortRequest(
175            $request,
176            allowedFields: ['id', 'name', 'parent_id', 'active'],
177            defaultField: 'id',
178            defaultOrder: 'asc',
179        );
180
181        // Get paginated categories
182        $categories = $category->getCategoriesPaginated(
183            limit: $pagination->limit,
184            offset: $pagination->offset,
185            sortField: $sort->getField() ?? 'id',
186            sortOrder: $sort->getOrderSql(),
187            activeOnly: $onlyActive,
188        );
189
190        // Get total count
191        $total = $category->countCategories(activeOnly: $onlyActive);
192
193        return $this->paginatedResponse(
194            $request,
195            data: array_values($categories),
196            total: $total,
197            pagination: $pagination,
198            options: new PaginatedResponseOptions(sort: $sort),
199        );
200    }
201
202    /**
203     * @throws JsonException
204     * @throws \Exception
205     */
206    #[OA\Post(path: '/api/v4.0/category', operationId: 'createCategory', tags: ['Endpoints with Authentication'])]
207    #[OA\Header(
208        header: 'Accept-Language',
209        description: 'The language code for the login.',
210        schema: new OA\Schema(type: 'string'),
211    )]
212    #[OA\Header(
213        header: 'x-pmf-token',
214        description: 'phpMyFAQ client API Token, generated in admin backend',
215        schema: new OA\Schema(type: 'string'),
216    )]
217    #[OA\RequestBody(
218        description: 'The parent category ID is a required value, the parent category name is optional. '
219        . 'If the parent category name is present and the ID can be mapped, the parent category ID from the name '
220        . 'will be used. If the parent category name cannot be mapped, a 409 error is thrown',
221        required: true,
222        content: new OA\MediaType(
223            mediaType: 'application/json',
224            schema: new OA\Schema(
225                required: [
226                    'language',
227                    'parent-id',
228                    'parent-category-name',
229                    'category-name',
230                    'description',
231                    'user-id',
232                    'group-id',
233                    'is-active',
234                    'show-on-homepage',
235                ],
236                properties: [
237                    new OA\Property(property: 'language', type: 'string'),
238                    new OA\Property(property: 'parent-id', type: 'integer'),
239                    new OA\Property(property: 'parent-category-name', type: 'string'),
240                    new OA\Property(property: 'category-name', type: 'string'),
241                    new OA\Property(property: 'description', type: 'string'),
242                    new OA\Property(property: 'user-id', type: 'integer'),
243                    new OA\Property(property: 'group-id', type: 'integer'),
244                    new OA\Property(property: 'is-active', type: 'boolean'),
245                    new OA\Property(property: 'show-on-homepage', type: 'boolean'),
246                ],
247                type: 'object',
248            ),
249            example: '{
250                "language": "en",
251                "parent-id": 1,
252                "parent-category-name": "Test",
253                "category-name": "Test 2",
254                "description": "Hello, World! Hello, Tests!",
255                "user-id": 1,
256                "group-id": 1,
257                "is-active": true,
258                "show-on-homepage": true
259            }',
260        ),
261    )]
262    #[OA\Response(response: 201, description: 'If all posted data is correct.', content: new OA\JsonContent(example: [
263        'stored' => true,
264    ]))]
265    #[OA\Response(response: 400, description: "If something didn't worked out.", content: new OA\JsonContent(example: [
266        'stored' => false,
267        'error' => 'Cannot add category',
268    ]))]
269    #[OA\Response(
270        response: 409,
271        description: 'If the parent category name cannot be mapped.',
272        content: new OA\JsonContent(example: [
273            'stored' => false,
274            'error' => 'The given parent category name was not found.',
275        ]),
276    )]
277    #[OA\Response(response: 401, description: 'If the user is not authenticated.')]
278    #[Route(path: 'v4.0/category', name: 'api.category.create', methods: ['POST'])]
279    public function create(Request $request): JsonResponse
280    {
281        $this->hasValidToken();
282        $this->userHasPermission(PermissionType::CATEGORY_ADD);
283
284        [$currentUser, $currentGroups] = CurrentUser::getCurrentUserGroupId($this->currentUser);
285
286        $data = json_decode(json: $request->getContent(), associative: false, depth: 512, flags: JSON_THROW_ON_ERROR);
287        if (!$data instanceof \stdClass) {
288            return $this->json([
289                'stored' => false,
290                'error' => 'The request body must be a JSON object.',
291            ], Response::HTTP_BAD_REQUEST);
292        }
293
294        $currentLanguage = $this->configuration->getLanguage()->getLanguage();
295
296        $category = $this->createCategory($currentGroups);
297        $category->setUser($currentUser);
298        $category->setGroups($currentGroups);
299        $category->setLanguage($currentLanguage);
300
301        $categoryPermission = $this->createCategoryPermission();
302
303        $languageCode = Filter::filterVar($data->language ?? '', FILTER_SANITIZE_SPECIAL_CHARS, '');
304        $parentId = Filter::filterVar($data->{'parent-id'} ?? null, FILTER_VALIDATE_INT);
305        $parentCategoryName = null;
306
307        if (property_exists($data, 'parent-category-name') && $data->{'parent-category-name'} !== null) {
308            $parentCategoryName = Filter::filterVar($data->{'parent-category-name'}, FILTER_SANITIZE_SPECIAL_CHARS);
309        }
310
311        $name = Filter::filterVar($data->{'category-name'} ?? '', FILTER_SANITIZE_SPECIAL_CHARS, '');
312        $description = Filter::filterVar($data->{'description'} ?? null, FILTER_SANITIZE_SPECIAL_CHARS);
313        $userId = property_exists($data, 'user-id') && $data->{'user-id'} !== null
314            ? Filter::filterVar($data->{'user-id'}, FILTER_VALIDATE_INT)
315            : 1;
316        $groupId = property_exists($data, 'group-id') && $data->{'group-id'} !== null
317            ? Filter::filterVar($data->{'group-id'}, FILTER_VALIDATE_INT)
318            : -1;
319        $active = Filter::filterVar($data->{'is-active'} ?? false, FILTER_VALIDATE_BOOLEAN);
320        $showOnHome = Filter::filterVar($data->{'show-on-homepage'} ?? false, FILTER_VALIDATE_BOOLEAN);
321
322        // Check if the parent category name can be mapped
323        if (!is_null($parentCategoryName)) {
324            $parentCategoryIdFound = $category->getCategoryIdFromName($parentCategoryName);
325            if ($parentCategoryIdFound === false) {
326                $result = [
327                    'stored' => false,
328                    'error' => 'The given parent category name was not found.',
329                ];
330                return $this->json($result, Response::HTTP_CONFLICT);
331            }
332
333            $parentId = $parentCategoryIdFound;
334        }
335
336        if ($parentId === null || $userId === null || $groupId === null) {
337            $result = [
338                'stored' => false,
339                'error' => 'Cannot add category',
340            ];
341            return $this->json($result, Response::HTTP_BAD_REQUEST);
342        }
343
344        $parentId = (int) $parentId;
345
346        $categoryEntity = new CategoryEntity();
347        $categoryEntity
348            ->setLang($languageCode)
349            ->setParentId($parentId)
350            ->setName($name)
351            ->setDescription($description)
352            ->setUserId((int) $userId)
353            ->setGroupId((int) $groupId)
354            ->setActive((bool) $active)
355            ->setImage(image: '')
356            ->setShowHome((bool) $showOnHome);
357
358        $categoryId = $category->create($categoryEntity);
359
360        if ($categoryId === null) {
361            $result = [
362                'stored' => false,
363                'error' => 'Cannot add category',
364            ];
365            return $this->json($result, Response::HTTP_BAD_REQUEST);
366        }
367
368        // Category Order entry
369        $categoryOrder = $this->createOrder();
370        $categoryOrder->add($categoryId, $parentId);
371
372        if ($categoryId) {
373            $categoryPermission->add(CategoryPermission::USER, [$categoryId], [-1]);
374            $categoryPermission->add(CategoryPermission::GROUP, [$categoryId], [-1]);
375
376            $result = [
377                'stored' => true,
378            ];
379            return $this->json($result, Response::HTTP_CREATED);
380        }
381
382        $result = [
383            'stored' => false,
384            'error' => 'Cannot add category',
385        ];
386        return $this->json($result, Response::HTTP_BAD_REQUEST);
387    }
388
389    private function createCategory(array $currentGroups): Category
390    {
391        if (is_callable($this->categoryFactory)) {
392            $category = ($this->categoryFactory)($currentGroups);
393            if ($category instanceof Category) {
394                return $category;
395            }
396        }
397
398        return new Category($this->configuration, $currentGroups, withPermission: true);
399    }
400
401    private function createCategoryPermission(): CategoryPermission
402    {
403        if (is_callable($this->categoryPermissionFactory)) {
404            $categoryPermission = ($this->categoryPermissionFactory)();
405            if ($categoryPermission instanceof CategoryPermission) {
406                return $categoryPermission;
407            }
408        }
409
410        return new CategoryPermission($this->configuration);
411    }
412
413    private function createOrder(): Order
414    {
415        if (is_callable($this->orderFactory)) {
416            $categoryOrder = ($this->orderFactory)();
417            if ($categoryOrder instanceof Order) {
418                return $categoryOrder;
419            }
420        }
421
422        return new Order($this->configuration);
423    }
424}

Inherited from phpMyFAQ\Controller\Api\AbstractApiController

52    protected function initializeFromContainer(): void
53    {
54        parent::initializeFromContainer();
55
56        if (!$this->isApiEnabled()) {
57            throw new UnauthorizedHttpException(challenge: 'API is not enabled');
58        }
59    }
70    protected function getPaginationRequest(
71        Request $request,
72        int $defaultPerPage = self::DEFAULT_PER_PAGE,
73        ?int $maxPerPage = null,
74    ): PaginationRequest {
75        $maxPerPage ??= self::MAX_PER_PAGE;
76
77        return PaginationRequest::fromRequest($request, $defaultPerPage, $maxPerPage);
78    }
90    protected function getSortRequest(
91        Request $request,
92        array $allowedFields,
93        ?string $defaultField = null,
94        string $defaultOrder = 'asc',
95    ): SortRequest {
96        return SortRequest::fromRequest($request, $allowedFields, $defaultField, $defaultOrder);
97    }
115    protected function getFilterRequest(Request $request, array $allowedFilters): FilterRequest
116    {
117        return FilterRequest::fromRequest($request, $allowedFilters);
118    }
130    protected function paginatedResponse(
131        Request $request,
132        array $data,
133        int $total,
134        PaginationRequest $pagination,
135        ?PaginatedResponseOptions $options = null,
136    ): JsonResponse {
137        $options ??= new PaginatedResponseOptions();
138
139        // Build base URL for pagination links
140        $baseUrl = $request->getPathInfo();
141        $queryString = $request->getQueryString();
142        if ($queryString !== null && $queryString !== '') {
143            $baseUrl .= '?' . $queryString;
144        }
145
146        // Generate pagination metadata
147        $paginationMetadata = new PaginationMetadata(
148            total: $total,
149            request: $pagination,
150            baseUrl: $baseUrl,
151            actualCount: count($data),
152        );
153
154        // Build response with envelope
155        $responseData = ApiResponse::success(
156            data: $data,
157            pagination: $paginationMetadata,
158            sort: $options->sort,
159            filters: $options->filters,
160        );
161
162        $response = new JsonResponse($responseData, $options->status);
163        $response->setPublic();
164        $response->setMaxAge(0);
165        $response->headers->addCacheControlDirective('must-revalidate');
166        $response->setVary(['Accept-Language'], false);
167        $response->setEtag($this->createResponseEtag($responseData));
168        $response->isNotModified($request);
169
170        return $response;
171    }
182    protected function apiResponse(array|object $data, int $status = Response::HTTP_OK): JsonResponse
183    {
184        $responseData = ApiResponse::success(data: $data);
185
186        return new JsonResponse($responseData, $status);
187    }
198    protected function errorResponse(
199        string $message,
200        string $code = 'ERROR',
201        int $status = Response::HTTP_BAD_REQUEST,
202        ?array $details = null,
203    ): JsonResponse {
204        $responseData = ApiResponse::error(message: $message, code: $code, details: $details);
205
206        return new JsonResponse($responseData, $status);
207    }
215    private function createResponseEtag(array $responseData): string
216    {
217        return hash('sha256', json_encode($responseData, JSON_THROW_ON_ERROR));
218    }

Inherited from phpMyFAQ\Controller\AbstractController

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    }