Lines
89.47%
391 / 437
Methods
70.58%
24 / 34
Classes
0.00%
0 / 1
| Name | Lines | Methods | CRAP | ||||
|---|---|---|---|---|---|---|---|
| __construct | 100.00% | 1 / 1 | 100.00% | 1 / 1 | 1 | ||
| requestRemoval | 100.00% | 16 / 16 | 100.00% | 1 / 1 | 5 | ||
| bookmarks | 100.00% | 16 / 16 | 100.00% | 1 / 1 | 2 | ||
| register | 100.00% | 21 / 21 | 100.00% | 1 / 1 | 2 | ||
| resetPassword | 0.00% | 0 / 19 | 0.00% | 0 / 1 | 90 | ||
| ucp | 86.15% | 56 / 65 | 0.00% | 0 / 1 | 10.27 | ||
| [phpMyFAQ\Controller\Frontend\AbstractFrontController] initializeFromContainer | 90.90% | 10 / 11 | 0.00% | 0 / 1 | 4.01 | ||
| [phpMyFAQ\Controller\Frontend\AbstractFrontController] getHeader | 100.00% | 78 / 78 | 100.00% | 1 / 1 | 9 | ||
| [phpMyFAQ\Controller\Frontend\AbstractFrontController] getTopNavigation | 100.00% | 23 / 23 | 100.00% | 1 / 1 | 5 | ||
| [phpMyFAQ\Controller\Frontend\AbstractFrontController] getUserDropdown | 100.00% | 21 / 21 | 100.00% | 1 / 1 | 5 | ||
| [phpMyFAQ\Controller\Frontend\AbstractFrontController] getFooterNavigation | 100.00% | 23 / 23 | 100.00% | 1 / 1 | 5 | ||
| [phpMyFAQ\Controller\Frontend\AbstractFrontController] handleStaticPageRedirect | 53.84% | 7 / 13 | 0.00% | 0 / 1 | 7.46 | ||
| [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 | ||
| 41 | final class UserController extends AbstractFrontController | |
| 42 | { | |
| 43 | public function __construct( | |
| 44 | private readonly UserSession $faqSession, | |
| 45 | private readonly CaptchaInterface $captcha, | |
| 46 | private readonly CaptchaHelperInterface $captchaHelper, | |
| 47 | private readonly Gravatar $gravatar, | |
| 48 | ) { | |
| 49 | parent::__construct(); | |
| 50 | } | |
| 51 | ||
| 52 | /** | |
| 53 | * Displays the request removal page. | |
| 54 | * | |
| 55 | * @throws Exception | |
| 56 | * @throws \Exception | |
| 57 | */ | |
| 58 | #[Route(path: '/user/request-removal', name: 'public.user.request-removal', methods: ['GET'])] | |
| 59 | public function requestRemoval(Request $request): Response | |
| 60 | { | |
| 61 | if (!$this->currentUser->isLoggedIn()) { | |
| 62 | return new RedirectResponse($this->configuration->getDefaultUrl()); | |
| 63 | } | |
| 64 | ||
| 65 | $this->faqSession->setCurrentUser($this->currentUser); | |
| 66 | $this->faqSession->userTracking('request_removal', 0); | |
| 67 | ||
| 68 | return $this->render('request-removal.twig', [ | |
| 69 | ...$this->getHeader($request), | |
| 70 | 'privacyURL' => $this->configuration->get('main.privacyURL'), | |
| 71 | 'csrf' => Token::getInstance($this->session)->getTokenInput('request-removal'), | |
| 72 | 'lang' => $this->configuration->getLanguage()->getLanguage(), | |
| 73 | 'userId' => $this->currentUser->getUserId(), | |
| 74 | 'defaultContentMail' => $this->currentUser->getUserId() > 0 ? $this->currentUser->getUserData('email') : '', | |
| 75 | 'defaultContentName' => $this->currentUser->getUserId() > 0 | |
| 76 | ? $this->currentUser->getUserData('display_name') | |
| 77 | : '', | |
| 78 | 'defaultLoginName' => $this->currentUser->getUserId() > 0 ? $this->currentUser->getLogin() : '', | |
| 79 | ]); | |
| 80 | } | |
| 81 | ||
| 82 | /** | |
| 83 | * Displays the user's bookmarks page. | |
| 84 | * | |
| 85 | * @throws Exception | |
| 86 | * @throws \Exception | |
| 87 | */ | |
| 88 | #[Route(path: '/user/bookmarks', name: 'public.user.bookmarks', methods: ['GET'])] | |
| 89 | public function bookmarks(Request $request): Response | |
| 90 | { | |
| 91 | if (!$this->currentUser->isLoggedIn()) { | |
| 92 | return new RedirectResponse($this->configuration->getDefaultUrl()); | |
| 93 | } | |
| 94 | ||
| 95 | $this->faqSession->setCurrentUser($this->currentUser); | |
| 96 | $this->faqSession->userTracking('bookmarks', 0); | |
| 97 | ||
| 98 | $bookmark = new Bookmark($this->configuration, $this->currentUser); | |
| 99 | ||
| 100 | return $this->render('bookmarks.twig', [ | |
| 101 | ...$this->getHeader($request), | |
| 102 | 'title' => sprintf( | |
| 103 | '%s - %s', | |
| 104 | Translation::getString(key: 'msgBookmarks'), | |
| 105 | $this->configuration->getTitle(), | |
| 106 | ), | |
| 107 | 'bookmarksList' => $bookmark->getBookmarkList(), | |
| 108 | 'csrfTokenDeleteBookmark' => Token::getInstance($this->session)->getTokenString('delete-bookmark'), | |
| 109 | 'csrfTokenDeleteAllBookmarks' => Token::getInstance($this->session)->getTokenString('delete-all-bookmarks'), | |
| 110 | ]); | |
| 111 | } | |
| 112 | ||
| 113 | /** | |
| 114 | * Displays the user registration page. | |
| 115 | * | |
| 116 | * @throws Exception | |
| 117 | * @throws \Exception | |
| 118 | */ | |
| 119 | #[Route(path: '/user/register', name: 'public.user.register', methods: ['GET'])] | |
| 120 | public function register(Request $request): Response | |
| 121 | { | |
| 122 | if (!$this->configuration->get('security.enableRegistration')) { | |
| 123 | return new RedirectResponse($this->configuration->getDefaultUrl()); | |
| 124 | } | |
| 125 | ||
| 126 | $this->faqSession->setCurrentUser($this->currentUser); | |
| 127 | $this->faqSession->userTracking('registration', 0); | |
| 128 | ||
| 129 | return $this->render('register.twig', [ | |
| 130 | ...$this->getHeader($request), | |
| 131 | 'title' => sprintf( | |
| 132 | '%s - %s', | |
| 133 | Translation::getString(key: 'msgRegistration'), | |
| 134 | $this->configuration->getTitle(), | |
| 135 | ), | |
| 136 | 'lang' => $this->configuration->getLanguage()->getLanguage(), | |
| 137 | 'isWebAuthnEnabled' => $this->configuration->get('security.enableWebAuthnSupport'), | |
| 138 | 'csrfTokenWebAuthn' => Token::getInstance($this->session)->getTokenString('webauthn'), | |
| 139 | 'captchaFieldset' => $this->captchaHelper->renderCaptcha( | |
| 140 | $this->captcha, | |
| 141 | 'register', | |
| 142 | Translation::getString(key: 'msgCaptcha'), | |
| 143 | $this->currentUser->isLoggedIn(), | |
| 144 | ), | |
| 145 | ]); | |
| 146 | } | |
| 147 | ||
| 148 | /** | |
| 149 | * Displays the password reset form for a signed reset link. The signature | |
| 150 | * is verified server-side before rendering the form so that an invalid or | |
| 151 | * expired link cannot be used to attempt a reset. | |
| 152 | * | |
| 153 | * @throws Exception | |
| 154 | * @throws \Exception | |
| 155 | */ | |
| 156 | #[Route(path: '/user/reset-password', name: 'public.user.reset-password', methods: ['GET'])] | |
| 157 | public function resetPassword(Request $request): Response | |
| 158 | { | |
| 159 | $this->faqSession->userTracking('reset_password', 0); | |
| 160 | ||
| 161 | $userId = (int) Filter::filterVar($request->query->get('u'), FILTER_VALIDATE_INT); | |
| 162 | $expires = (int) Filter::filterVar($request->query->get('exp'), FILTER_VALIDATE_INT); | |
| 163 | $signature = (string) Filter::filterVar($request->query->get('sig'), FILTER_SANITIZE_SPECIAL_CHARS); | |
| 164 | ||
| 165 | $valid = false; | |
| 166 | if ($userId > 0 && $expires > 0 && $signature !== '') { | |
| 167 | $candidate = CurrentUser::getCurrentUser($this->configuration); | |
| 168 | if ($candidate->getUserById($userId, true)) { | |
| 169 | $passwordKey = $candidate->getEncryptedPassword(); | |
| 170 | if ($passwordKey !== '') { | |
| 171 | $valid = new PasswordResetTokenService()->verify($userId, $expires, $signature, $passwordKey); | |
| 172 | } | |
| 173 | } | |
| 174 | } | |
| 175 | ||
| 176 | return $this->render('resetpw.twig', [ | |
| 177 | ...$this->getHeader($request), | |
| 178 | 'lang' => $this->configuration->getLanguage()->getLanguage(), | |
| 179 | 'resetUserId' => $valid ? $userId : 0, | |
| 180 | 'resetExpires' => $valid ? $expires : 0, | |
| 181 | 'resetSignature' => $valid ? $signature : '', | |
| 182 | 'resetTokenValid' => $valid, | |
| 183 | ]); | |
| 184 | } | |
| 185 | ||
| 186 | /** | |
| 187 | * Displays the User Control Panel. | |
| 188 | * | |
| 189 | * @throws Exception | |
| 190 | * @throws \Exception | |
| 191 | */ | |
| 192 | #[Route(path: '/user/ucp', name: 'public.user.ucp', methods: ['GET'])] | |
| 193 | public function ucp(Request $request): Response | |
| 194 | { | |
| 195 | if (!$this->currentUser->isLoggedIn()) { | |
| 196 | return new RedirectResponse($this->configuration->getDefaultUrl()); | |
| 197 | } | |
| 198 | ||
| 199 | $this->faqSession->setCurrentUser($this->currentUser); | |
| 200 | $this->faqSession->userTracking('user_control_panel', $this->currentUser->getUserId()); | |
| 201 | ||
| 202 | $gravatarImg = ''; | |
| 203 | if ($this->configuration->get('main.enableGravatarSupport')) { | |
| 204 | $email = $this->currentUser->getUserData('email'); | |
| 205 | $gravatarImg = sprintf('<a target="_blank" href="https://www.gravatar.com">%s</a>', $this->gravatar->getImage( | |
| 206 | is_string($email) ? $email : '', | |
| 207 | ['class' => 'img-responsive rounded-circle', 'size' => '125'], | |
| 208 | )); | |
| 209 | } | |
| 210 | ||
| 211 | $qrCode = ''; | |
| 212 | $secret = ''; | |
| 213 | try { | |
| 214 | $twoFactor = new TwoFactor($this->configuration, $this->currentUser); | |
| 215 | $secret = $twoFactor->getSecret($this->currentUser); | |
| 216 | if ('' === $secret || is_null($secret)) { | |
| 217 | try { | |
| 218 | $secret = $twoFactor->generateSecret(); | |
| 219 | } catch (TwoFactorAuthException $exception) { | |
| 220 | $this->configuration->getLogger()->error('Cannot generate 2FA secret: ' . $exception->getMessage()); | |
| 221 | } | |
| 222 | ||
| 223 | $twoFactor->saveSecret($secret ?? ''); | |
| 224 | } | |
| 225 | ||
| 226 | $qrCode = $twoFactor->getQrCode($secret ?? ''); | |
| 227 | } catch (TwoFactorAuthException|\Exception $exception) { | |
| 228 | $this->configuration->getLogger()->error('2FA error: ' . $exception->getMessage()); | |
| 229 | } | |
| 230 | ||
| 231 | return $this->render('ucp.twig', [ | |
| 232 | ...$this->getHeader($request), | |
| 233 | 'headerUserControlPanel' => Translation::get(key: 'headerUserControlPanel'), | |
| 234 | 'ucpGravatarImage' => $gravatarImg, | |
| 235 | 'msgHeaderUserData' => Translation::get(key: 'headerUserControlPanel'), | |
| 236 | 'userid' => $this->currentUser->getUserId(), | |
| 237 | 'csrf' => Token::getInstance($this->session)->getTokenInput('ucp'), | |
| 238 | 'lang' => $this->configuration->getLanguage()->getLanguage(), | |
| 239 | 'readonly' => $this->currentUser->isLocalUser() ? '' : 'readonly disabled', | |
| 240 | 'msgRealName' => Translation::get(key: 'ad_user_name'), | |
| 241 | 'realname' => $this->currentUser->getUserData('display_name'), | |
| 242 | 'msgEmail' => Translation::get(key: 'msgNewContentMail'), | |
| 243 | 'email' => $this->currentUser->getUserData('email'), | |
| 244 | 'msgIsVisible' => Translation::get(key: 'msgUserDataVisible'), | |
| 245 | 'checked' => (int) $this->currentUser->getUserData('is_visible') === 1 ? 'checked' : '', | |
| 246 | 'msgPassword' => Translation::get(key: 'ad_auth_passwd'), | |
| 247 | 'msgConfirm' => Translation::get(key: 'ad_user_confirm'), | |
| 248 | 'msgSave' => Translation::get(key: 'msgSave'), | |
| 249 | 'msgCancel' => Translation::get(key: 'msgCancel'), | |
| 250 | 'twofactor_enabled' => (bool) $this->currentUser->getUserData('twofactor_enabled'), | |
| 251 | 'msgTwofactorEnabled' => Translation::get(key: 'msgTwofactorEnabled'), | |
| 252 | 'msgTwofactorConfig' => Translation::get(key: 'msgTwofactorConfig'), | |
| 253 | 'msgTwofactorConfigModelTitle' => Translation::get(key: 'msgTwofactorConfigModelTitle'), | |
| 254 | 'twofactor_secret' => $secret, | |
| 255 | 'qr_code_secret' => $qrCode, | |
| 256 | 'qr_code_secret_alt' => Translation::get(key: 'qr_code_secret_alt'), | |
| 257 | 'msgTwofactorNewSecret' => Translation::get(key: 'msgTwofactorNewSecret'), | |
| 258 | 'msgWarning' => Translation::get(key: 'msgWarning'), | |
| 259 | 'ad_gen_yes' => Translation::get(key: 'ad_gen_yes'), | |
| 260 | 'ad_gen_no' => Translation::get(key: 'ad_gen_no'), | |
| 261 | 'msgConfirmTwofactorConfig' => Translation::get(key: 'msgConfirmTwofactorConfig'), | |
| 262 | 'csrfTokenRemoveTwofactor' => Token::getInstance($this->session)->getTokenString('remove-twofactor'), | |
| 263 | 'msgGravatarNotConnected' => Translation::get(key: 'msgGravatarNotConnected'), | |
| 264 | 'webauthnSupportEnabled' => $this->configuration->get('security.enableWebAuthnSupport'), | |
| 265 | 'csrfTokenWebAuthn' => Token::getInstance($this->session)->getTokenString('webauthn'), | |
| 266 | 'loginName' => $this->currentUser->getLogin(), | |
| 267 | 'csrfExportUserData' => Token::getInstance($this->session)->getTokenInput('export-userdata'), | |
| 268 | 'exportUserDataUrl' => 'api/user/data/export', | |
| 269 | 'msgDownloadYourData' => Translation::get(key: 'msgDownloadYourData'), | |
| 270 | 'msgDataExportDescription' => Translation::get(key: 'msgDataExportDescription'), | |
| 271 | 'msgDownload' => Translation::get(key: 'msgDownload'), | |
| 272 | ]); | |
| 273 | } | |
| 274 | } |
Inherited from phpMyFAQ\Controller\Frontend\AbstractFrontController
| 46 | protected function initializeFromContainer(): void | |
| 47 | { | |
| 48 | parent::initializeFromContainer(); | |
| 49 | ||
| 50 | /* @mago-expect lint:no-isset - typed property may be uninitialized */ | |
| 51 | if (!isset($this->container)) { | |
| 52 | throw new LogicException('Container is not initialized.'); | |
| 53 | } | |
| 54 | ||
| 55 | $faqSystem = $this->container->get(id: 'phpmyfaq.system'); | |
| 56 | if (!$faqSystem instanceof System) { | |
| 57 | throw new LogicException('System service not found in container.'); | |
| 58 | } | |
| 59 | ||
| 60 | $this->faqSystem = $faqSystem; | |
| 61 | ||
| 62 | $seo = $this->container->get(id: 'phpmyfaq.seo'); | |
| 63 | if (!$seo instanceof Seo) { | |
| 64 | throw new LogicException('Seo service not found in container.'); | |
| 65 | } | |
| 66 | ||
| 67 | $this->seo = $seo; | |
| 68 | } |
| 74 | protected function getHeader(Request $request): array | |
| 75 | { | |
| 76 | $action = $request->query->get(key: 'action', default: 'index'); | |
| 77 | ||
| 78 | $isUserHasAdminRights = $this->currentUser->perm->hasPermission( | |
| 79 | $this->currentUser->getUserId(), | |
| 80 | PermissionType::VIEW_ADMIN_LINK->value, | |
| 81 | ); | |
| 82 | ||
| 83 | // Get flash messages | |
| 84 | $successMessages = $this->session->getFlashBag()->get('success'); | |
| 85 | $errorMessages = $this->session->getFlashBag()->get('error'); | |
| 86 | ||
| 87 | return [ | |
| 88 | ...$this->getUserDropdown(), | |
| 89 | 'successMessage' => count($successMessages) > 0 ? $successMessages[0] : null, | |
| 90 | 'errorMessage' => count($errorMessages) > 0 ? $errorMessages[0] : null, | |
| 91 | 'isMaintenanceMode' => $this->configuration->get('main.maintenanceMode'), | |
| 92 | 'isCompletelySecured' => $this->configuration->get('security.enableLoginOnly'), | |
| 93 | 'isDebugEnabled' => Environment::isDebugMode(), | |
| 94 | 'richSnippetsEnabled' => $this->configuration->get('seo.enableRichSnippets'), | |
| 95 | 'tplSetName' => TwigWrapper::getTemplateSetName(), | |
| 96 | 'msgLoginUser' => $this->currentUser->isLoggedIn() | |
| 97 | ? $this->currentUser->getUserData('display_name') | |
| 98 | : Translation::get(key: 'msgLoginUser'), | |
| 99 | 'isUserLoggedIn' => $this->currentUser->isLoggedIn(), | |
| 100 | 'isUserHasAdminRights' => $isUserHasAdminRights || $this->currentUser->isSuperAdmin(), | |
| 101 | 'baseHref' => $this->faqSystem->getSystemUri($this->configuration), | |
| 102 | 'customCss' => $this->configuration->getCustomCss(), | |
| 103 | 'defaultLayoutMode' => (string) ($this->configuration->get('layout.defaultLayoutMode') ?? 'auto'), | |
| 104 | 'allowUserLayoutMode' => | |
| 105 | $this->configuration->get('layout.allowUserLayoutMode') === true | |
| 106 | || $this->configuration->get('layout.allowUserLayoutMode') === 'true', | |
| 107 | 'version' => $this->configuration->getVersion(), | |
| 108 | 'header' => str_replace(search: '"', replace: '', subject: $this->configuration->getTitle()), | |
| 109 | 'metaDescription' => $this->configuration->get('seo.description'), | |
| 110 | 'metaPublisher' => $this->configuration->get('main.metaPublisher'), | |
| 111 | 'metaLanguage' => Translation::get(key: 'metaLanguage'), | |
| 112 | 'metaRobots' => $this->seo->getMetaRobots($action), | |
| 113 | 'phpmyfaqVersion' => $this->configuration->getVersion(), | |
| 114 | 'stylesheet' => Translation::get(key: 'direction') === 'rtl' ? 'style.rtl' : 'style', | |
| 115 | 'currentPageUrl' => $request->getSchemeAndHttpHost() . $request->getRequestUri(), | |
| 116 | 'action' => $action, | |
| 117 | 'dir' => Translation::get(key: 'direction'), | |
| 118 | 'formActionUrl' => './search', | |
| 119 | 'searchBox' => Translation::get(key: 'msgSearch'), | |
| 120 | 'languageBox' => Translation::get(key: 'msgLanguageSubmit'), | |
| 121 | 'switchLanguages' => LanguageHelper::renderSelectLanguage( | |
| 122 | $this->configuration->getLanguage()->getLanguage(), | |
| 123 | true, | |
| 124 | ), | |
| 125 | 'copyright' => System::getPoweredByString(), | |
| 126 | 'isUserRegistrationEnabled' => $this->configuration->get('security.enableRegistration'), | |
| 127 | 'pluginStylesheets' => $this->configuration->getPluginManager()->getAllPluginStylesheets(), | |
| 128 | 'pluginScripts' => $this->configuration->getPluginManager()->getAllPluginScripts(), | |
| 129 | 'msgFullName' => Translation::getString(key: 'ad_user_loggedin') . $this->currentUser->getLogin(), | |
| 130 | 'msgLoginName' => $this->currentUser->getUserData('display_name'), | |
| 131 | 'loginHeader' => Translation::get(key: 'msgLoginUser'), | |
| 132 | 'msgAdvancedSearch' => Translation::get(key: 'msgAdvancedSearch'), | |
| 133 | 'currentYear' => date(format: 'Y', timestamp: time()), | |
| 134 | 'cookieConsentEnabled' => $this->configuration->get('layout.enableCookieConsent'), | |
| 135 | 'faqHome' => $this->configuration->getDefaultUrl(), | |
| 136 | 'topNavigation' => $this->getTopNavigation($request), | |
| 137 | 'isAskQuestionsEnabled' => $this->configuration->get('main.enableAskQuestions'), | |
| 138 | 'isOpenQuestionsEnabled' => $this->configuration->get('main.enableAskQuestions'), | |
| 139 | 'footerNavigation' => $this->getFooterNavigation($request), | |
| 140 | 'isPrivacyLinkEnabled' => $this->configuration->get('layout.enablePrivacyLink'), | |
| 141 | 'msgPrivacyNote' => Translation::get(key: 'msgPrivacyNote'), | |
| 142 | 'isTermsLinkEnabled' => (string) $this->configuration->get('main.termsURL') !== '', | |
| 143 | 'msgTermsOfService' => Translation::get(key: 'msgTermsOfService'), | |
| 144 | 'isImprintLinkEnabled' => (string) $this->configuration->get('main.imprintURL') !== '', | |
| 145 | 'msgImprint' => Translation::get(key: 'msgImprint'), | |
| 146 | 'isCookieConsentEnabled' => $this->configuration->get('layout.enableCookieConsent'), | |
| 147 | 'cookiePreferences' => Translation::get(key: 'cookiePreferences'), | |
| 148 | 'isAccessibilityStatementEnabled' => | |
| 149 | (string) $this->configuration->get('main.accessibilityStatementURL') !== '', | |
| 150 | 'msgAccessibilityStatement' => Translation::get(key: 'msgAccessibilityStatement'), | |
| 151 | 'pushEnabled' => | |
| 152 | ( | |
| 153 | $this->configuration->get('push.enableWebPush') === 'true' | |
| 154 | || $this->configuration->get('push.enableWebPush') === true | |
| 155 | ) | |
| 156 | && (string) $this->configuration->get('push.vapidPublicKey') !== '', | |
| 157 | ]; | |
| 158 | } |
| 160 | private function getTopNavigation(Request $request): array | |
| 161 | { | |
| 162 | $action = $request->query->get(key: 'action', default: 'index'); | |
| 163 | ||
| 164 | return [ | |
| 165 | [ | |
| 166 | 'name' => Translation::get(key: 'msgShowAllCategories'), | |
| 167 | 'link' => './show-categories.html', | |
| 168 | 'active' => 'show' === $action ? 'active' : '', | |
| 169 | ], | |
| 170 | [ | |
| 171 | 'name' => Translation::get(key: 'msgAddContent'), | |
| 172 | 'link' => './add-faq.html', | |
| 173 | 'active' => 'add' === $action ? 'active' : '', | |
| 174 | ], | |
| 175 | [ | |
| 176 | 'name' => Translation::get(key: 'msgQuestion'), | |
| 177 | 'link' => './add-question.html', | |
| 178 | 'active' => 'ask' === $action ? 'active' : '', | |
| 179 | ], | |
| 180 | [ | |
| 181 | 'name' => Translation::get(key: 'msgOpenQuestions'), | |
| 182 | 'link' => './open-questions.html', | |
| 183 | 'active' => 'open-questions' === $action ? 'active' : '', | |
| 184 | ], | |
| 185 | ]; | |
| 186 | } |
| 191 | private function getUserDropdown(): array | |
| 192 | { | |
| 193 | $templateVars = []; | |
| 194 | if ($this->currentUser->isLoggedIn() && $this->currentUser->getUserId() > 0) { | |
| 195 | $csrfLogoutToken = Token::getInstance($this->session)->getTokenString('logout'); | |
| 196 | ||
| 197 | if ( | |
| 198 | $this->currentUser->perm->hasPermission( | |
| 199 | $this->currentUser->getUserId(), | |
| 200 | PermissionType::VIEW_ADMIN_LINK->value, | |
| 201 | ) | |
| 202 | || $this->currentUser->isSuperAdmin() | |
| 203 | ) { | |
| 204 | $templateVars = [ | |
| 205 | ...$templateVars, | |
| 206 | 'msgAdmin' => Translation::get(key: 'adminSection'), | |
| 207 | ]; | |
| 208 | } | |
| 209 | ||
| 210 | $templateVars = [ | |
| 211 | ...$templateVars, | |
| 212 | 'msgUserControlDropDown' => Translation::get(key: 'headerUserControlPanel'), | |
| 213 | 'msgBookmarks' => Translation::get(key: 'msgBookmarks'), | |
| 214 | 'msgUserRemoval' => Translation::get(key: 'ad_menu_RequestRemove'), | |
| 215 | 'msgLogoutUser' => Translation::get(key: 'ad_menu_logout'), | |
| 216 | 'csrfLogout' => $csrfLogoutToken, | |
| 217 | ]; | |
| 218 | } | |
| 219 | ||
| 220 | return $templateVars; | |
| 221 | } |
| 223 | private function getFooterNavigation(Request $request): array | |
| 224 | { | |
| 225 | $action = $request->query->get(key: 'action', default: 'index'); | |
| 226 | ||
| 227 | return [ | |
| 228 | [ | |
| 229 | 'name' => Translation::get(key: 'faqOverview'), | |
| 230 | 'link' => './overview.html', | |
| 231 | 'active' => 'faq-overview' === $action ? 'active' : '', | |
| 232 | ], | |
| 233 | [ | |
| 234 | 'name' => Translation::get(key: 'msgSitemap'), | |
| 235 | 'link' => './sitemap/A/' . $this->configuration->getLanguage()->getLanguage() . '.html', | |
| 236 | 'active' => 'sitemap' === $action ? 'active' : '', | |
| 237 | ], | |
| 238 | [ | |
| 239 | 'name' => Translation::get(key: 'ad_menu_glossary'), | |
| 240 | 'link' => './glossary.html', | |
| 241 | 'active' => 'glossary' === $action ? 'active' : '', | |
| 242 | ], | |
| 243 | [ | |
| 244 | 'name' => Translation::get(key: 'msgContact'), | |
| 245 | 'link' => './contact.html', | |
| 246 | 'active' => 'contact' === $action ? 'active' : '', | |
| 247 | ], | |
| 248 | ]; | |
| 249 | } |
| 259 | protected function handleStaticPageRedirect(string $configKey): Response | |
| 260 | { | |
| 261 | $url = $this->configuration->get($configKey); | |
| 262 | ||
| 263 | // Check if this is a reference to a custom page (format: "page:slug") | |
| 264 | if (str_starts_with((string) $url, 'page:')) { | |
| 265 | $slug = substr(string: (string) $url, offset: 5); | |
| 266 | $customPage = new CustomPage($this->configuration); | |
| 267 | $page = $customPage->getBySlug($slug); | |
| 268 | ||
| 269 | if ($page && $page->isActive()) { | |
| 270 | // Redirect to the custom page URL | |
| 271 | $pageUrl = $this->configuration->getDefaultUrl() . 'page/' . $page->getSlug() . '.html'; | |
| 272 | return new RedirectResponse($pageUrl); | |
| 273 | } | |
| 274 | } | |
| 275 | ||
| 276 | // Default behavior: redirect to external URL | |
| 277 | if ((string) $url !== '') { | |
| 278 | return new RedirectResponse((string) $url); | |
| 279 | } | |
| 280 | ||
| 281 | // If no URL configured and no fallback, return 404 | |
| 282 | $response = new Response(); | |
| 283 | $response->setStatusCode(Response::HTTP_NOT_FOUND); | |
| 284 | return $this->render('404.twig', [], $response); | |
| 285 | } |
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 | } |