3 namespace Wallabag\CoreBundle\Controller
;
5 use JMS\Serializer\SerializationContext
;
6 use JMS\Serializer\SerializerBuilder
;
7 use PragmaRX\Recovery\Recovery
as BackupCodes
;
8 use Symfony\Bundle\FrameworkBundle\Controller\Controller
;
9 use Symfony\Component\HttpFoundation\JsonResponse
;
10 use Symfony\Component\HttpFoundation\RedirectResponse
;
11 use Symfony\Component\HttpFoundation\Request
;
12 use Symfony\Component\HttpFoundation\Response
;
13 use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException
;
14 use Symfony\Component\Routing\Annotation\Route
;
15 use Symfony\Component\Validator\Constraints\Locale
as LocaleConstraint
;
16 use Wallabag\CoreBundle\Entity\Config
;
17 use Wallabag\CoreBundle\Entity\TaggingRule
;
18 use Wallabag\CoreBundle\Form\Type\ChangePasswordType
;
19 use Wallabag\CoreBundle\Form\Type\ConfigType
;
20 use Wallabag\CoreBundle\Form\Type\FeedType
;
21 use Wallabag\CoreBundle\Form\Type\TaggingRuleImportType
;
22 use Wallabag\CoreBundle\Form\Type\TaggingRuleType
;
23 use Wallabag\CoreBundle\Form\Type\UserInformationType
;
24 use Wallabag\CoreBundle\Tools\Utils
;
26 class ConfigController
extends Controller
29 * @Route("/config", name="config")
31 public function indexAction(Request
$request)
33 $em = $this->getDoctrine()->getManager();
34 $config = $this->getConfig();
35 $userManager = $this->container
->get('fos_user.user_manager');
36 $user = $this->getUser();
38 // handle basic config detail (this form is defined as a service)
39 $configForm = $this->createForm(ConfigType
::class, $config, ['action' => $this->generateUrl('config')]);
40 $configForm->handleRequest($request);
42 if ($configForm->isSubmitted() && $configForm->isValid()) {
43 $em->persist($config);
46 $request->getSession()->set('_locale', $config->getLanguage());
48 // switch active theme
49 $activeTheme = $this->get('liip_theme.active_theme');
50 $activeTheme->setName($config->getTheme());
54 'flashes.config.notice.config_saved'
57 return $this->redirect($this->generateUrl('config'));
60 // handle changing password
61 $pwdForm = $this->createForm(ChangePasswordType
::class, null, ['action' => $this->generateUrl('config') . '#set4']);
62 $pwdForm->handleRequest($request);
64 if ($pwdForm->isSubmitted() && $pwdForm->isValid()) {
65 if ($this->get('craue_config')->get('demo_mode_enabled') && $this->get('craue_config')->get('demo_mode_username') === $user->getUsername()) {
66 $message = 'flashes.config.notice.password_not_updated_demo';
68 $message = 'flashes.config.notice.password_updated';
70 $user->setPlainPassword($pwdForm->get('new_password')->getData());
71 $userManager->updateUser($user, true);
74 $this->addFlash('notice', $message);
76 return $this->redirect($this->generateUrl('config') . '#set4');
79 // handle changing user information
80 $userForm = $this->createForm(UserInformationType
::class, $user, [
81 'validation_groups' => ['Profile'],
82 'action' => $this->generateUrl('config') . '#set3',
84 $userForm->handleRequest($request);
86 if ($userForm->isSubmitted() && $userForm->isValid()) {
87 $userManager->updateUser($user, true);
91 'flashes.config.notice.user_updated'
94 return $this->redirect($this->generateUrl('config') . '#set3');
97 // handle feed information
98 $feedForm = $this->createForm(FeedType
::class, $config, ['action' => $this->generateUrl('config') . '#set2']);
99 $feedForm->handleRequest($request);
101 if ($feedForm->isSubmitted() && $feedForm->isValid()) {
102 $em->persist($config);
107 'flashes.config.notice.feed_updated'
110 return $this->redirect($this->generateUrl('config') . '#set2');
113 // handle tagging rule
114 $taggingRule = new TaggingRule();
115 $action = $this->generateUrl('config') . '#set5';
117 if ($request->query
->has('tagging-rule')) {
118 $taggingRule = $this->getDoctrine()
119 ->getRepository('WallabagCoreBundle:TaggingRule')
120 ->find($request->query
->get('tagging-rule'));
122 if ($this->getUser()->getId() !== $taggingRule->getConfig()->getUser()->getId()) {
123 return $this->redirect($action);
126 $action = $this->generateUrl('config') . '?tagging-rule=' . $taggingRule->getId() . '#set5';
129 $newTaggingRule = $this->createForm(TaggingRuleType
::class, $taggingRule, ['action' => $action]);
130 $newTaggingRule->handleRequest($request);
132 if ($newTaggingRule->isSubmitted() && $newTaggingRule->isValid()) {
133 $taggingRule->setConfig($config);
134 $em->persist($taggingRule);
139 'flashes.config.notice.tagging_rules_updated'
142 return $this->redirect($this->generateUrl('config') . '#set5');
145 // handle tagging rules import
146 $taggingRulesImportform = $this->createForm(TaggingRuleImportType
::class);
147 $taggingRulesImportform->handleRequest($request);
149 if ($taggingRulesImportform->isSubmitted() && $taggingRulesImportform->isValid()) {
150 $message = 'flashes.config.notice.tagging_rules_not_imported';
151 $file = $taggingRulesImportform->get('file')->getData();
153 if (null !== $file && $file->isValid() && \
in_array($file->getClientMimeType(), ['application/json', 'application/octet-stream'], true)) {
154 $content = json_decode(file_get_contents($file->getPathname()), true);
156 if (\
is_array($content)) {
157 foreach ($content as $rule) {
158 $taggingRule = new TaggingRule();
159 $taggingRule->setRule($rule['rule']);
160 $taggingRule->setTags($rule['tags']);
161 $taggingRule->setConfig($config);
162 $em->persist($taggingRule);
167 $message = 'flashes.config.notice.tagging_rules_imported';
171 $this->addFlash('notice', $message);
173 return $this->redirect($this->generateUrl('config') . '#set5');
176 return $this->render('WallabagCoreBundle:Config:index.html.twig', [
178 'config' => $configForm->createView(),
179 'feed' => $feedForm->createView(),
180 'pwd' => $pwdForm->createView(),
181 'user' => $userForm->createView(),
182 'new_tagging_rule' => $newTaggingRule->createView(),
183 'import_tagging_rule' => $taggingRulesImportform->createView(),
186 'username' => $user->getUsername(),
187 'token' => $config->getFeedToken(),
189 'twofactor_auth' => $this->getParameter('twofactor_auth'),
190 'wallabag_url' => $this->getParameter('domain_name'),
191 'enabled_users' => $this->get('wallabag_user.user_repository')->getSumEnabledUsers(),
196 * Enable 2FA using email.
198 * @Route("/config/otp/email", name="config_otp_email")
200 public function otpEmailAction()
202 if (!$this->getParameter('twofactor_auth')) {
203 return $this->createNotFoundException('two_factor not enabled');
206 $user = $this->getUser();
208 $user->setGoogleAuthenticatorSecret(null);
209 $user->setBackupCodes(null);
210 $user->setEmailTwoFactor(true);
212 $this->container
->get('fos_user.user_manager')->updateUser($user, true);
216 'flashes.config.notice.otp_enabled'
219 return $this->redirect($this->generateUrl('config') . '#set3');
223 * Enable 2FA using OTP app, user will need to confirm the generated code from the app.
225 * @Route("/config/otp/app", name="config_otp_app")
227 public function otpAppAction()
229 if (!$this->getParameter('twofactor_auth')) {
230 return $this->createNotFoundException('two_factor not enabled');
233 $user = $this->getUser();
234 $secret = $this->get('scheb_two_factor.security.google_authenticator')->generateSecret();
236 $user->setGoogleAuthenticatorSecret($secret);
237 $user->setEmailTwoFactor(false);
239 $backupCodes = (new BackupCodes())->toArray();
240 $backupCodesHashed = array_map(
241 function ($backupCode) {
242 return password_hash($backupCode, PASSWORD_DEFAULT
);
247 $user->setBackupCodes($backupCodesHashed);
249 $this->container
->get('fos_user.user_manager')->updateUser($user, true);
251 return $this->render('WallabagCoreBundle:Config:otp_app.html.twig', [
252 'backupCodes' => $backupCodes,
253 'qr_code' => $this->get('scheb_two_factor.security.google_authenticator')->getQRContent($user),
258 * Cancelling 2FA using OTP app.
260 * @Route("/config/otp/app/cancel", name="config_otp_app_cancel")
262 public function otpAppCancelAction()
264 if (!$this->getParameter('twofactor_auth')) {
265 return $this->createNotFoundException('two_factor not enabled');
268 $user = $this->getUser();
269 $user->setGoogleAuthenticatorSecret(null);
270 $user->setBackupCodes(null);
272 $this->container
->get('fos_user.user_manager')->updateUser($user, true);
274 return $this->redirect($this->generateUrl('config') . '#set3');
280 * @Route("/config/otp/app/check", name="config_otp_app_check")
282 public function otpAppCheckAction(Request
$request)
284 $isValid = $this->get('scheb_two_factor.security.google_authenticator')->checkCode(
286 $request->get('_auth_code')
289 if (true === $isValid) {
292 'flashes.config.notice.otp_enabled'
295 return $this->redirect($this->generateUrl('config') . '#set3');
300 'scheb_two_factor.code_invalid'
303 return $this->redirect($this->generateUrl('config_otp_app'));
307 * @Route("/generate-token", name="generate_token")
309 * @return RedirectResponse|JsonResponse
311 public function generateTokenAction(Request
$request)
313 $config = $this->getConfig();
314 $config->setFeedToken(Utils
::generateToken());
316 $em = $this->getDoctrine()->getManager();
317 $em->persist($config);
320 if ($request->isXmlHttpRequest()) {
321 return new JsonResponse(['token' => $config->getFeedToken()]);
326 'flashes.config.notice.feed_token_updated'
329 return $this->redirect($this->generateUrl('config') . '#set2');
333 * @Route("/revoke-token", name="revoke_token")
335 * @return RedirectResponse|JsonResponse
337 public function revokeTokenAction(Request
$request)
339 $config = $this->getConfig();
340 $config->setFeedToken(null);
342 $em = $this->getDoctrine()->getManager();
343 $em->persist($config);
346 if ($request->isXmlHttpRequest()) {
347 return new JsonResponse();
352 'flashes.config.notice.feed_token_revoked'
355 return $this->redirect($this->generateUrl('config') . '#set2');
359 * Deletes a tagging rule and redirect to the config homepage.
361 * @Route("/tagging-rule/delete/{id}", requirements={"id" = "\d+"}, name="delete_tagging_rule")
363 * @return RedirectResponse
365 public function deleteTaggingRuleAction(TaggingRule
$rule)
367 $this->validateRuleAction($rule);
369 $em = $this->getDoctrine()->getManager();
375 'flashes.config.notice.tagging_rules_deleted'
378 return $this->redirect($this->generateUrl('config') . '#set5');
382 * Edit a tagging rule.
384 * @Route("/tagging-rule/edit/{id}", requirements={"id" = "\d+"}, name="edit_tagging_rule")
386 * @return RedirectResponse
388 public function editTaggingRuleAction(TaggingRule
$rule)
390 $this->validateRuleAction($rule);
392 return $this->redirect($this->generateUrl('config') . '?tagging-rule=' . $rule->getId() . '#set5');
396 * Remove all annotations OR tags OR entries for the current user.
398 * @Route("/reset/{type}", requirements={"id" = "annotations|tags|entries"}, name="config_reset")
400 * @return RedirectResponse
402 public function resetAction($type)
407 ->getRepository('WallabagAnnotationBundle:Annotation')
408 ->removeAllByUserId($this->getUser()->getId());
411 $this->removeAllTagsByUserId($this->getUser()->getId());
414 // SQLite doesn't care about cascading remove, so we need to manually remove associated stuff
415 // otherwise they won't be removed ...
416 if ($this->get('doctrine')->getConnection()->getDatabasePlatform() instanceof \Doctrine\DBAL\Platforms\SqlitePlatform
) {
417 $this->getDoctrine()->getRepository('WallabagAnnotationBundle:Annotation')->removeAllByUserId($this->getUser()->getId());
420 // manually remove tags to avoid orphan tag
421 $this->removeAllTagsByUserId($this->getUser()->getId());
423 $this->get('wallabag_core.entry_repository')->removeAllByUserId($this->getUser()->getId());
426 if ($this->get('doctrine')->getConnection()->getDatabasePlatform() instanceof \Doctrine\DBAL\Platforms\SqlitePlatform
) {
427 $this->removeAnnotationsForArchivedByUserId($this->getUser()->getId());
430 // manually remove tags to avoid orphan tag
431 $this->removeTagsForArchivedByUserId($this->getUser()->getId());
433 $this->get('wallabag_core.entry_repository')->removeArchivedByUserId($this->getUser()->getId());
439 'flashes.config.notice.' . $type . '_reset'
442 return $this->redirect($this->generateUrl('config') . '#set3');
446 * Delete account for current user.
448 * @Route("/account/delete", name="delete_account")
450 * @throws AccessDeniedHttpException
452 * @return \Symfony\Component\HttpFoundation\RedirectResponse
454 public function deleteAccountAction(Request
$request)
456 $enabledUsers = $this->get('wallabag_user.user_repository')
457 ->getSumEnabledUsers();
459 if ($enabledUsers <= 1) {
460 throw new AccessDeniedHttpException();
463 $user = $this->getUser();
465 // logout current user
466 $this->get('security.token_storage')->setToken(null);
467 $request->getSession()->invalidate();
469 $em = $this->get('fos_user.user_manager');
470 $em->deleteUser($user);
472 return $this->redirect($this->generateUrl('fos_user_security_login'));
476 * Switch view mode for current user.
478 * @Route("/config/view-mode", name="switch_view_mode")
480 * @return \Symfony\Component\HttpFoundation\RedirectResponse
482 public function changeViewModeAction(Request
$request)
484 $user = $this->getUser();
485 $user->getConfig()->setListMode(!$user->getConfig()->getListMode());
487 $em = $this->getDoctrine()->getManager();
491 return $this->redirect($request->headers
->get('referer'));
495 * Change the locale for the current user.
497 * @param string $language
499 * @Route("/locale/{language}", name="changeLocale")
501 * @return \Symfony\Component\HttpFoundation\RedirectResponse
503 public function setLocaleAction(Request
$request, $language = null)
505 $errors = $this->get('validator')->validate($language, (new LocaleConstraint()));
507 if (0 === \
count($errors)) {
508 $request->getSession()->set('_locale', $language);
511 return $this->redirect($request->headers
->get('referer', $this->generateUrl('homepage')));
515 * Export tagging rules for the logged in user.
517 * @Route("/tagging-rule/export", name="export_tagging_rule")
521 public function exportTaggingRulesAction()
523 $data = SerializerBuilder
::create()->build()->serialize(
524 $this->getUser()->getConfig()->getTaggingRules(),
526 SerializationContext
::create()->setGroups(['export_tagging_rule'])
529 return Response
::create(
533 'Content-type' => 'application/json',
534 'Content-Disposition' => 'attachment; filename="tagging_rules_' . $this->getUser()->getUsername() . '.json"',
535 'Content-Transfer-Encoding' => 'UTF-8',
541 * Remove all tags for given tags and a given user and cleanup orphan tags.
546 private function removeAllTagsByStatusAndUserId($tags, $userId)
552 $this->get('wallabag_core.entry_repository')
553 ->removeTags($userId, $tags);
555 // cleanup orphan tags
556 $em = $this->getDoctrine()->getManager();
558 foreach ($tags as $tag) {
559 if (0 === \
count($tag->getEntries())) {
568 * Remove all tags for a given user and cleanup orphan tags.
572 private function removeAllTagsByUserId($userId)
574 $tags = $this->get('wallabag_core.tag_repository')->findAllTags($userId);
575 $this->removeAllTagsByStatusAndUserId($tags, $userId);
579 * Remove all tags for a given user and cleanup orphan tags.
583 private function removeTagsForArchivedByUserId($userId)
585 $tags = $this->get('wallabag_core.tag_repository')->findForArchivedArticlesByUser($userId);
586 $this->removeAllTagsByStatusAndUserId($tags, $userId);
589 private function removeAnnotationsForArchivedByUserId($userId)
591 $em = $this->getDoctrine()->getManager();
593 $archivedEntriesAnnotations = $this->getDoctrine()
594 ->getRepository('WallabagAnnotationBundle:Annotation')
595 ->findAllArchivedEntriesByUser($userId);
597 foreach ($archivedEntriesAnnotations as $archivedEntriesAnnotation) {
598 $em->remove($archivedEntriesAnnotation);
605 * Validate that a rule can be edited/deleted by the current user.
607 private function validateRuleAction(TaggingRule
$rule)
609 if ($this->getUser()->getId() !== $rule->getConfig()->getUser()->getId()) {
610 throw $this->createAccessDeniedException('You can not access this tagging rule.');
615 * Retrieve config for the current user.
616 * If no config were found, create a new one.
620 private function getConfig()
622 $config = $this->getDoctrine()
623 ->getRepository('WallabagCoreBundle:Config')
624 ->findOneByUser($this->getUser());
626 // should NEVER HAPPEN ...
628 $config = new Config($this->getUser());