src/Wallabag/CoreBundle/Controller/EntryController.php

   1 <?php
   2
   3 namespace Wallabag\CoreBundle\Controller;
   4
   5 use Pagerfanta\Adapter\DoctrineORMAdapter;
   6 use Pagerfanta\Exception\OutOfRangeCurrentPageException;
   7 use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
   8 use Symfony\Bundle\FrameworkBundle\Controller\Controller;
   9 use Symfony\Component\HttpFoundation\Request;
  10 use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  11 use Wallabag\CoreBundle\Entity\Entry;
  12 use Wallabag\CoreBundle\Form\Type\EntryFilterType;
  13 use Wallabag\CoreBundle\Form\Type\EditEntryType;
  14 use Wallabag\CoreBundle\Form\Type\NewEntryType;
  15 use Sensio\Bundle\FrameworkExtraBundle\Configuration\Cache;
  16 use Wallabag\CoreBundle\Event\EntrySavedEvent;
  17 use Wallabag\CoreBundle\Event\EntryDeletedEvent;
  18 use Wallabag\CoreBundle\Form\Type\SearchEntryType;
  19
  20 class EntryController extends Controller
  21 {
  22     /**
  23      * @param Request $request
  24      * @param int     $page
  25      *
  26      * @Route("/search/{page}", name="search", defaults={"page" = 1})
  27      *
  28      * Default parameter for page is hardcoded (in duplication of the defaults from the Route)
  29      * because this controller is also called inside the layout template without any page as argument
  30      *
  31      * @return \Symfony\Component\HttpFoundation\Response
  32      */
  33     public function searchFormAction(Request $request, $page = 1, $currentRoute = null)
  34     {
  35         // fallback to retrieve currentRoute from query parameter instead of injected one (when using inside a template)
  36         if (null === $currentRoute && $request->query->has('currentRoute')) {
  37             $currentRoute = $request->query->get('currentRoute');
  38         }
  39
  40         $form = $this->createForm(SearchEntryType::class);
  41
  42         $form->handleRequest($request);
  43
  44         if ($form->isSubmitted() && $form->isValid()) {
  45             return $this->showEntries('search', $request, $page);
  46         }
  47
  48         return $this->render('WallabagCoreBundle:Entry:search_form.html.twig', [
  49             'form' => $form->createView(),
  50             'currentRoute' => $currentRoute,
  51         ]);
  52     }
  53
  54     /**
  55      * Fetch content and update entry.
  56      * In case it fails, $entry->getContent will return an error message.
  57      *
  58      * @param Entry  $entry
  59      * @param string $prefixMessage Should be the translation key: entry_saved or entry_reloaded
  60      */
  61     private function updateEntry(Entry $entry, $prefixMessage = 'entry_saved')
  62     {
  63         $message = 'flashes.entry.notice.'.$prefixMessage;
  64
  65         try {
  66             $this->get('wallabag_core.content_proxy')->updateEntry($entry, $entry->getUrl());
  67         } catch (\Exception $e) {
  68             $this->get('logger')->error('Error while saving an entry', [
  69                 'exception' => $e,
  70                 'entry' => $entry,
  71             ]);
  72
  73             $message = 'flashes.entry.notice.'.$prefixMessage.'_failed';
  74         }
  75
  76         $this->get('session')->getFlashBag()->add('notice', $message);
  77     }
  78
  79     /**
  80      * @param Request $request
  81      *
  82      * @Route("/new-entry", name="new_entry")
  83      *
  84      * @return \Symfony\Component\HttpFoundation\Response
  85      */
  86     public function addEntryFormAction(Request $request)
  87     {
  88         $entry = new Entry($this->getUser());
  89
  90         $form = $this->createForm(NewEntryType::class, $entry);
  91
  92         $form->handleRequest($request);
  93
  94         if ($form->isSubmitted() && $form->isValid()) {
  95             $existingEntry = $this->checkIfEntryAlreadyExists($entry);
  96
  97             if (false !== $existingEntry) {
  98                 $this->get('session')->getFlashBag()->add(
  99                     'notice',
 100                     $this->get('translator')->trans('flashes.entry.notice.entry_already_saved', ['%date%' => $existingEntry->getCreatedAt()->format('d-m-Y')])
 101                 );
 102
 103                 return $this->redirect($this->generateUrl('view', ['id' => $existingEntry->getId()]));
 104             }
 105
 106             $this->updateEntry($entry);
 107
 108             $em = $this->getDoctrine()->getManager();
 109             $em->persist($entry);
 110             $em->flush();
 111
 112             // entry saved, dispatch event about it!
 113             $this->get('event_dispatcher')->dispatch(EntrySavedEvent::NAME, new EntrySavedEvent($entry));
 114
 115             return $this->redirect($this->generateUrl('homepage'));
 116         }
 117
 118         return $this->render('WallabagCoreBundle:Entry:new_form.html.twig', [
 119             'form' => $form->createView(),
 120         ]);
 121     }
 122
 123     /**
 124      * @param Request $request
 125      *
 126      * @Route("/bookmarklet", name="bookmarklet")
 127      *
 128      * @return \Symfony\Component\HttpFoundation\Response
 129      */
 130     public function addEntryViaBookmarkletAction(Request $request)
 131     {
 132         $entry = new Entry($this->getUser());
 133         $entry->setUrl($request->get('url'));
 134
 135         if (false === $this->checkIfEntryAlreadyExists($entry)) {
 136             $this->updateEntry($entry);
 137
 138             $em = $this->getDoctrine()->getManager();
 139             $em->persist($entry);
 140             $em->flush();
 141
 142             // entry saved, dispatch event about it!
 143             $this->get('event_dispatcher')->dispatch(EntrySavedEvent::NAME, new EntrySavedEvent($entry));
 144         }
 145
 146         return $this->redirect($this->generateUrl('homepage'));
 147     }
 148
 149     /**
 150      * @Route("/new", name="new")
 151      *
 152      * @return \Symfony\Component\HttpFoundation\Response
 153      */
 154     public function addEntryAction()
 155     {
 156         return $this->render('WallabagCoreBundle:Entry:new.html.twig');
 157     }
 158
 159     /**
 160      * Edit an entry content.
 161      *
 162      * @param Request $request
 163      * @param Entry   $entry
 164      *
 165      * @Route("/edit/{id}", requirements={"id" = "\d+"}, name="edit")
 166      *
 167      * @return \Symfony\Component\HttpFoundation\Response
 168      */
 169     public function editEntryAction(Request $request, Entry $entry)
 170     {
 171         $this->checkUserAction($entry);
 172
 173         $form = $this->createForm(EditEntryType::class, $entry);
 174
 175         $form->handleRequest($request);
 176
 177         if ($form->isSubmitted() && $form->isValid()) {
 178             $em = $this->getDoctrine()->getManager();
 179             $em->persist($entry);
 180             $em->flush();
 181
 182             $this->get('session')->getFlashBag()->add(
 183                 'notice',
 184                 'flashes.entry.notice.entry_updated'
 185             );
 186
 187             return $this->redirect($this->generateUrl('view', ['id' => $entry->getId()]));
 188         }
 189
 190         return $this->render('WallabagCoreBundle:Entry:edit.html.twig', [
 191             'form' => $form->createView(),
 192         ]);
 193     }
 194
 195     /**
 196      * Shows all entries for current user.
 197      *
 198      * @param Request $request
 199      * @param int     $page
 200      *
 201      * @Route("/all/list/{page}", name="all", defaults={"page" = "1"})
 202      *
 203      * @return \Symfony\Component\HttpFoundation\Response
 204      */
 205     public function showAllAction(Request $request, $page)
 206     {
 207         return $this->showEntries('all', $request, $page);
 208     }
 209
 210     /**
 211      * Shows unread entries for current user.
 212      *
 213      * @param Request $request
 214      * @param int     $page
 215      *
 216      * @Route("/unread/list/{page}", name="unread", defaults={"page" = "1"})
 217      *
 218      * @return \Symfony\Component\HttpFoundation\Response
 219      */
 220     public function showUnreadAction(Request $request, $page)
 221     {
 222         // load the quickstart if no entry in database
 223         if ($page == 1 && $this->get('wallabag_core.entry_repository')->countAllEntriesByUser($this->getUser()->getId()) == 0) {
 224             return $this->redirect($this->generateUrl('quickstart'));
 225         }
 226
 227         return $this->showEntries('unread', $request, $page);
 228     }
 229
 230     /**
 231      * Shows read entries for current user.
 232      *
 233      * @param Request $request
 234      * @param int     $page
 235      *
 236      * @Route("/archive/list/{page}", name="archive", defaults={"page" = "1"})
 237      *
 238      * @return \Symfony\Component\HttpFoundation\Response
 239      */
 240     public function showArchiveAction(Request $request, $page)
 241     {
 242         return $this->showEntries('archive', $request, $page);
 243     }
 244
 245     /**
 246      * Shows starred entries for current user.
 247      *
 248      * @param Request $request
 249      * @param int     $page
 250      *
 251      * @Route("/starred/list/{page}", name="starred", defaults={"page" = "1"})
 252      *
 253      * @return \Symfony\Component\HttpFoundation\Response
 254      */
 255     public function showStarredAction(Request $request, $page)
 256     {
 257         return $this->showEntries('starred', $request, $page);
 258     }
 259
 260     /**
 261      * Global method to retrieve entries depending on the given type
 262      * It returns the response to be send.
 263      *
 264      * @param string  $type    Entries type: unread, starred or archive
 265      * @param Request $request
 266      * @param int     $page
 267      *
 268      * @return \Symfony\Component\HttpFoundation\Response
 269      */
 270     private function showEntries($type, Request $request, $page)
 271     {
 272         $repository = $this->get('wallabag_core.entry_repository');
 273         $searchTerm = (isset($request->get('search_entry')['term']) ? $request->get('search_entry')['term'] : '');
 274         $currentRoute = (!is_null($request->query->get('currentRoute')) ? $request->query->get('currentRoute') : '');
 275
 276         switch ($type) {
 277             case 'search':
 278                 $qb = $repository->getBuilderForSearchByUser($this->getUser()->getId(), $searchTerm, $currentRoute);
 279
 280                 break;
 281             case 'untagged':
 282                 $qb = $repository->getBuilderForUntaggedByUser($this->getUser()->getId());
 283
 284                 break;
 285             case 'starred':
 286                 $qb = $repository->getBuilderForStarredByUser($this->getUser()->getId());
 287                 break;
 288
 289             case 'archive':
 290                 $qb = $repository->getBuilderForArchiveByUser($this->getUser()->getId());
 291                 break;
 292
 293             case 'unread':
 294                 $qb = $repository->getBuilderForUnreadByUser($this->getUser()->getId());
 295                 break;
 296
 297             case 'all':
 298                 $qb = $repository->getBuilderForAllByUser($this->getUser()->getId());
 299                 break;
 300
 301             default:
 302                 throw new \InvalidArgumentException(sprintf('Type "%s" is not implemented.', $type));
 303         }
 304
 305         $form = $this->createForm(EntryFilterType::class);
 306
 307         if ($request->query->has($form->getName())) {
 308             // manually bind values from the request
 309             $form->submit($request->query->get($form->getName()));
 310
 311             // build the query from the given form object
 312             $this->get('lexik_form_filter.query_builder_updater')->addFilterConditions($form, $qb);
 313         }
 314
 315         $pagerAdapter = new DoctrineORMAdapter($qb->getQuery(), true, false);
 316
 317         $entries = $this->get('wallabag_core.helper.prepare_pager_for_entries')->prepare($pagerAdapter);
 318
 319         try {
 320             $entries->setCurrentPage($page);
 321         } catch (OutOfRangeCurrentPageException $e) {
 322             if ($page > 1) {
 323                 return $this->redirect($this->generateUrl($type, ['page' => $entries->getNbPages()]), 302);
 324             }
 325         }
 326
 327         return $this->render(
 328             'WallabagCoreBundle:Entry:entries.html.twig', [
 329                 'form' => $form->createView(),
 330                 'entries' => $entries,
 331                 'currentPage' => $page,
 332                 'searchTerm' => $searchTerm,
 333             ]
 334         );
 335     }
 336
 337     /**
 338      * Shows entry content.
 339      *
 340      * @param Entry $entry
 341      *
 342      * @Route("/view/{id}", requirements={"id" = "\d+"}, name="view")
 343      *
 344      * @return \Symfony\Component\HttpFoundation\Response
 345      */
 346     public function viewAction(Entry $entry)
 347     {
 348         $this->checkUserAction($entry);
 349
 350         return $this->render(
 351             'WallabagCoreBundle:Entry:entry.html.twig',
 352             ['entry' => $entry]
 353         );
 354     }
 355
 356     /**
 357      * Reload an entry.
 358      * Refetch content from the website and make it readable again.
 359      *
 360      * @param Entry $entry
 361      *
 362      * @Route("/reload/{id}", requirements={"id" = "\d+"}, name="reload_entry")
 363      *
 364      * @return \Symfony\Component\HttpFoundation\RedirectResponse
 365      */
 366     public function reloadAction(Entry $entry)
 367     {
 368         $this->checkUserAction($entry);
 369
 370         $this->updateEntry($entry, 'entry_reloaded');
 371
 372         // if refreshing entry failed, don't save it
 373         if ($this->getParameter('wallabag_core.fetching_error_message') === $entry->getContent()) {
 374             $bag = $this->get('session')->getFlashBag();
 375             $bag->clear();
 376             $bag->add('notice', 'flashes.entry.notice.entry_reloaded_failed');
 377
 378             return $this->redirect($this->generateUrl('view', ['id' => $entry->getId()]));
 379         }
 380
 381         $em = $this->getDoctrine()->getManager();
 382         $em->persist($entry);
 383         $em->flush();
 384
 385         // entry saved, dispatch event about it!
 386         $this->get('event_dispatcher')->dispatch(EntrySavedEvent::NAME, new EntrySavedEvent($entry));
 387
 388         return $this->redirect($this->generateUrl('view', ['id' => $entry->getId()]));
 389     }
 390
 391     /**
 392      * Changes read status for an entry.
 393      *
 394      * @param Request $request
 395      * @param Entry   $entry
 396      *
 397      * @Route("/archive/{id}", requirements={"id" = "\d+"}, name="archive_entry")
 398      *
 399      * @return \Symfony\Component\HttpFoundation\RedirectResponse
 400      */
 401     public function toggleArchiveAction(Request $request, Entry $entry)
 402     {
 403         $this->checkUserAction($entry);
 404
 405         $entry->toggleArchive();
 406         $this->getDoctrine()->getManager()->flush();
 407
 408         $message = 'flashes.entry.notice.entry_unarchived';
 409         if ($entry->isArchived()) {
 410             $message = 'flashes.entry.notice.entry_archived';
 411         }
 412
 413         $this->get('session')->getFlashBag()->add(
 414             'notice',
 415             $message
 416         );
 417
 418         $redirectUrl = $this->get('wallabag_core.helper.redirect')->to($request->headers->get('referer'));
 419
 420         return $this->redirect($redirectUrl);
 421     }
 422
 423     /**
 424      * Changes starred status for an entry.
 425      *
 426      * @param Request $request
 427      * @param Entry   $entry
 428      *
 429      * @Route("/star/{id}", requirements={"id" = "\d+"}, name="star_entry")
 430      *
 431      * @return \Symfony\Component\HttpFoundation\RedirectResponse
 432      */
 433     public function toggleStarAction(Request $request, Entry $entry)
 434     {
 435         $this->checkUserAction($entry);
 436
 437         $entry->toggleStar();
 438         $this->getDoctrine()->getManager()->flush();
 439
 440         $message = 'flashes.entry.notice.entry_unstarred';
 441         if ($entry->isStarred()) {
 442             $message = 'flashes.entry.notice.entry_starred';
 443         }
 444
 445         $this->get('session')->getFlashBag()->add(
 446             'notice',
 447             $message
 448         );
 449
 450         $redirectUrl = $this->get('wallabag_core.helper.redirect')->to($request->headers->get('referer'));
 451
 452         return $this->redirect($redirectUrl);
 453     }
 454
 455     /**
 456      * Deletes entry and redirect to the homepage or the last viewed page.
 457      *
 458      * @param Entry $entry
 459      *
 460      * @Route("/delete/{id}", requirements={"id" = "\d+"}, name="delete_entry")
 461      *
 462      * @return \Symfony\Component\HttpFoundation\RedirectResponse
 463      */
 464     public function deleteEntryAction(Request $request, Entry $entry)
 465     {
 466         $this->checkUserAction($entry);
 467
 468         // generates the view url for this entry to check for redirection later
 469         // to avoid redirecting to the deleted entry. Ugh.
 470         $url = $this->generateUrl(
 471             'view',
 472             ['id' => $entry->getId()],
 473             UrlGeneratorInterface::ABSOLUTE_PATH
 474         );
 475
 476         // entry deleted, dispatch event about it!
 477         $this->get('event_dispatcher')->dispatch(EntryDeletedEvent::NAME, new EntryDeletedEvent($entry));
 478
 479         $em = $this->getDoctrine()->getManager();
 480         $em->remove($entry);
 481         $em->flush();
 482
 483         $this->get('session')->getFlashBag()->add(
 484             'notice',
 485             'flashes.entry.notice.entry_deleted'
 486         );
 487
 488         // don't redirect user to the deleted entry (check that the referer doesn't end with the same url)
 489         $referer = $request->headers->get('referer');
 490         $to = (1 !== preg_match('#'.$url.'$#i', $referer) ? $referer : null);
 491
 492         $redirectUrl = $this->get('wallabag_core.helper.redirect')->to($to);
 493
 494         return $this->redirect($redirectUrl);
 495     }
 496
 497     /**
 498      * Check if the logged user can manage the given entry.
 499      *
 500      * @param Entry $entry
 501      */
 502     private function checkUserAction(Entry $entry)
 503     {
 504         if (null === $this->getUser() || $this->getUser()->getId() != $entry->getUser()->getId()) {
 505             throw $this->createAccessDeniedException('You can not access this entry.');
 506         }
 507     }
 508
 509     /**
 510      * Check for existing entry, if it exists, redirect to it with a message.
 511      *
 512      * @param Entry $entry
 513      *
 514      * @return Entry|bool
 515      */
 516     private function checkIfEntryAlreadyExists(Entry $entry)
 517     {
 518         return $this->get('wallabag_core.entry_repository')->findByUrlAndUserId($entry->getUrl(), $this->getUser()->getId());
 519     }
 520
 521     /**
 522      * Get public URL for entry (and generate it if necessary).
 523      *
 524      * @param Entry $entry
 525      *
 526      * @Route("/share/{id}", requirements={"id" = "\d+"}, name="share")
 527      *
 528      * @return \Symfony\Component\HttpFoundation\Response
 529      */
 530     public function shareAction(Entry $entry)
 531     {
 532         $this->checkUserAction($entry);
 533
 534         if (null === $entry->getUid()) {
 535             $entry->generateUid();
 536
 537             $em = $this->getDoctrine()->getManager();
 538             $em->persist($entry);
 539             $em->flush();
 540         }
 541
 542         return $this->redirect($this->generateUrl('share_entry', [
 543             'uid' => $entry->getUid(),
 544         ]));
 545     }
 546
 547     /**
 548      * Disable public sharing for an entry.
 549      *
 550      * @param Entry $entry
 551      *
 552      * @Route("/share/delete/{id}", requirements={"id" = "\d+"}, name="delete_share")
 553      *
 554      * @return \Symfony\Component\HttpFoundation\Response
 555      */
 556     public function deleteShareAction(Entry $entry)
 557     {
 558         $this->checkUserAction($entry);
 559
 560         $entry->cleanUid();
 561
 562         $em = $this->getDoctrine()->getManager();
 563         $em->persist($entry);
 564         $em->flush();
 565
 566         return $this->redirect($this->generateUrl('view', [
 567             'id' => $entry->getId(),
 568         ]));
 569     }
 570
 571     /**
 572      * Ability to view a content publicly.
 573      *
 574      * @param Entry $entry
 575      *
 576      * @Route("/share/{uid}", requirements={"uid" = ".+"}, name="share_entry")
 577      * @Cache(maxage="25200", smaxage="25200", public=true)
 578      *
 579      * @return \Symfony\Component\HttpFoundation\Response
 580      */
 581     public function shareEntryAction(Entry $entry)
 582     {
 583         if (!$this->get('craue_config')->get('share_public')) {
 584             throw $this->createAccessDeniedException('Sharing an entry is disabled for this user.');
 585         }
 586
 587         return $this->render(
 588             '@WallabagCore/themes/common/Entry/share.html.twig',
 589             ['entry' => $entry]
 590         );
 591     }
 592
 593     /**
 594      * Shows untagged articles for current user.
 595      *
 596      * @param Request $request
 597      * @param int     $page
 598      *
 599      * @Route("/untagged/list/{page}", name="untagged", defaults={"page" = "1"})
 600      *
 601      * @return \Symfony\Component\HttpFoundation\Response
 602      */
 603     public function showUntaggedEntriesAction(Request $request, $page)
 604     {
 605         return $this->showEntries('untagged', $request, $page);
 606     }
 607 }