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 Pagerfanta\Pagerfanta;
   8 use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
   9 use Symfony\Bundle\FrameworkBundle\Controller\Controller;
  10 use Symfony\Component\HttpFoundation\Request;
  11 use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  12 use Wallabag\CoreBundle\Entity\Entry;
  13 use Wallabag\CoreBundle\Form\Type\EntryFilterType;
  14 use Wallabag\CoreBundle\Form\Type\EditEntryType;
  15 use Wallabag\CoreBundle\Form\Type\NewEntryType;
  16
  17 class EntryController extends Controller
  18 {
  19     /**
  20      * @param Entry $entry
  21      */
  22     private function updateEntry(Entry $entry)
  23     {
  24         try {
  25             $entry = $this->get('wallabag_core.content_proxy')->updateEntry($entry, $entry->getUrl());
  26
  27             $em = $this->getDoctrine()->getManager();
  28             $em->persist($entry);
  29             $em->flush();
  30         } catch (\Exception $e) {
  31             $this->get('logger')->error('Error while saving an entry', [
  32                 'exception' => $e,
  33                 'entry' => $entry,
  34             ]);
  35
  36             return false;
  37         }
  38
  39         return true;
  40     }
  41
  42     /**
  43      * @param Request $request
  44      *
  45      * @Route("/new-entry", name="new_entry")
  46      *
  47      * @return \Symfony\Component\HttpFoundation\Response
  48      */
  49     public function addEntryFormAction(Request $request)
  50     {
  51         $entry = new Entry($this->getUser());
  52
  53         $form = $this->createForm(NewEntryType::class, $entry);
  54
  55         $form->handleRequest($request);
  56
  57         if ($form->isValid()) {
  58             $existingEntry = $this->checkIfEntryAlreadyExists($entry);
  59
  60             if (false !== $existingEntry) {
  61                 $this->get('session')->getFlashBag()->add(
  62                     'notice',
  63                     $this->get('translator')->trans('flashes.entry.notice.entry_already_saved', ['%date%' => $existingEntry->getCreatedAt()->format('d-m-Y')])
  64                 );
  65
  66                 return $this->redirect($this->generateUrl('view', ['id' => $existingEntry->getId()]));
  67             }
  68
  69             $message = 'flashes.entry.notice.entry_saved';
  70             if (false === $this->updateEntry($entry)) {
  71                 $message = 'flashes.entry.notice.entry_saved_failed';
  72             }
  73
  74             $this->get('session')->getFlashBag()->add('notice', $message);
  75
  76             return $this->redirect($this->generateUrl('homepage'));
  77         }
  78
  79         return $this->render('WallabagCoreBundle:Entry:new_form.html.twig', [
  80             'form' => $form->createView(),
  81         ]);
  82     }
  83
  84     /**
  85      * @param Request $request
  86      *
  87      * @Route("/bookmarklet", name="bookmarklet")
  88      *
  89      * @return \Symfony\Component\HttpFoundation\Response
  90      */
  91     public function addEntryViaBookmarkletAction(Request $request)
  92     {
  93         $entry = new Entry($this->getUser());
  94         $entry->setUrl($request->get('url'));
  95
  96         if (false === $this->checkIfEntryAlreadyExists($entry)) {
  97             $this->updateEntry($entry);
  98         }
  99
 100         return $this->redirect($this->generateUrl('homepage'));
 101     }
 102
 103     /**
 104      * @Route("/new", name="new")
 105      *
 106      * @return \Symfony\Component\HttpFoundation\Response
 107      */
 108     public function addEntryAction()
 109     {
 110         return $this->render('WallabagCoreBundle:Entry:new.html.twig');
 111     }
 112
 113     /**
 114      * Edit an entry content.
 115      *
 116      * @param Request $request
 117      * @param Entry   $entry
 118      *
 119      * @Route("/edit/{id}", requirements={"id" = "\d+"}, name="edit")
 120      *
 121      * @return \Symfony\Component\HttpFoundation\Response
 122      */
 123     public function editEntryAction(Request $request, Entry $entry)
 124     {
 125         $this->checkUserAction($entry);
 126
 127         $form = $this->createForm(EditEntryType::class, $entry);
 128
 129         $form->handleRequest($request);
 130
 131         if ($form->isValid()) {
 132             $em = $this->getDoctrine()->getManager();
 133             $em->persist($entry);
 134             $em->flush();
 135
 136             $this->get('session')->getFlashBag()->add(
 137                 'notice',
 138                 'flashes.entry.notice.entry_updated'
 139             );
 140
 141             return $this->redirect($this->generateUrl('view', ['id' => $entry->getId()]));
 142         }
 143
 144         return $this->render('WallabagCoreBundle:Entry:edit.html.twig', [
 145             'form' => $form->createView(),
 146         ]);
 147     }
 148
 149     /**
 150      * Shows all entries for current user.
 151      *
 152      * @param Request $request
 153      * @param int     $page
 154      *
 155      * @Route("/all/list/{page}", name="all", defaults={"page" = "1"})
 156      *
 157      * @return \Symfony\Component\HttpFoundation\Response
 158      */
 159     public function showAllAction(Request $request, $page)
 160     {
 161         return $this->showEntries('all', $request, $page);
 162     }
 163
 164     /**
 165      * Shows unread entries for current user.
 166      *
 167      * @param Request $request
 168      * @param int     $page
 169      *
 170      * @Route("/unread/list/{page}", name="unread", defaults={"page" = "1"})
 171      *
 172      * @return \Symfony\Component\HttpFoundation\Response
 173      */
 174     public function showUnreadAction(Request $request, $page)
 175     {
 176         // load the quickstart if no entry in database
 177         if ($page == 1 && $this->get('wallabag_core.entry_repository')->countAllEntriesByUsername($this->getUser()->getId()) == 0) {
 178             return $this->redirect($this->generateUrl('quickstart'));
 179         }
 180
 181         return $this->showEntries('unread', $request, $page);
 182     }
 183
 184     /**
 185      * Shows read entries for current user.
 186      *
 187      * @param Request $request
 188      * @param int     $page
 189      *
 190      * @Route("/archive/list/{page}", name="archive", defaults={"page" = "1"})
 191      *
 192      * @return \Symfony\Component\HttpFoundation\Response
 193      */
 194     public function showArchiveAction(Request $request, $page)
 195     {
 196         return $this->showEntries('archive', $request, $page);
 197     }
 198
 199     /**
 200      * Shows starred entries for current user.
 201      *
 202      * @param Request $request
 203      * @param int     $page
 204      *
 205      * @Route("/starred/list/{page}", name="starred", defaults={"page" = "1"})
 206      *
 207      * @return \Symfony\Component\HttpFoundation\Response
 208      */
 209     public function showStarredAction(Request $request, $page)
 210     {
 211         return $this->showEntries('starred', $request, $page);
 212     }
 213
 214     /**
 215      * Global method to retrieve entries depending on the given type
 216      * It returns the response to be send.
 217      *
 218      * @param string  $type    Entries type: unread, starred or archive
 219      * @param Request $request
 220      * @param int     $page
 221      *
 222      * @return \Symfony\Component\HttpFoundation\Response
 223      */
 224     private function showEntries($type, Request $request, $page)
 225     {
 226         $repository = $this->get('wallabag_core.entry_repository');
 227
 228         switch ($type) {
 229             case 'starred':
 230                 $qb = $repository->getBuilderForStarredByUser($this->getUser()->getId());
 231                 break;
 232
 233             case 'archive':
 234                 $qb = $repository->getBuilderForArchiveByUser($this->getUser()->getId());
 235                 break;
 236
 237             case 'unread':
 238                 $qb = $repository->getBuilderForUnreadByUser($this->getUser()->getId());
 239                 break;
 240
 241             case 'all':
 242                 $qb = $repository->getBuilderForAllByUser($this->getUser()->getId());
 243                 break;
 244
 245             default:
 246                 throw new \InvalidArgumentException(sprintf('Type "%s" is not implemented.', $type));
 247         }
 248
 249         $form = $this->createForm(EntryFilterType::class);
 250
 251         if ($request->query->has($form->getName())) {
 252             // manually bind values from the request
 253             $form->submit($request->query->get($form->getName()));
 254
 255             // build the query from the given form object
 256             $this->get('lexik_form_filter.query_builder_updater')->addFilterConditions($form, $qb);
 257         }
 258
 259         $pagerAdapter = new DoctrineORMAdapter($qb->getQuery());
 260         $entries = new Pagerfanta($pagerAdapter);
 261
 262         $entries->setMaxPerPage($this->getUser()->getConfig()->getItemsPerPage());
 263         try {
 264             $entries->setCurrentPage($page);
 265         } catch (OutOfRangeCurrentPageException $e) {
 266             if ($page > 1) {
 267                 return $this->redirect($this->generateUrl($type, ['page' => $entries->getNbPages()]), 302);
 268             }
 269         }
 270
 271         return $this->render(
 272             'WallabagCoreBundle:Entry:entries.html.twig',
 273             [
 274                 'form' => $form->createView(),
 275                 'entries' => $entries,
 276                 'currentPage' => $page,
 277             ]
 278         );
 279     }
 280
 281     /**
 282      * Shows entry content.
 283      *
 284      * @param Entry $entry
 285      *
 286      * @Route("/view/{id}", requirements={"id" = "\d+"}, name="view")
 287      *
 288      * @return \Symfony\Component\HttpFoundation\Response
 289      */
 290     public function viewAction(Entry $entry)
 291     {
 292         $this->checkUserAction($entry);
 293
 294         return $this->render(
 295             'WallabagCoreBundle:Entry:entry.html.twig',
 296             ['entry' => $entry]
 297         );
 298     }
 299
 300     /**
 301      * Reload an entry.
 302      * Refetch content from the website and make it readable again.
 303      *
 304      * @param Entry $entry
 305      *
 306      * @Route("/reload/{id}", requirements={"id" = "\d+"}, name="reload_entry")
 307      *
 308      * @return \Symfony\Component\HttpFoundation\RedirectResponse
 309      */
 310     public function reloadAction(Entry $entry)
 311     {
 312         $this->checkUserAction($entry);
 313
 314         $message = 'flashes.entry.notice.entry_reloaded';
 315         if (false === $this->updateEntry($entry)) {
 316             $message = 'flashes.entry.notice.entry_reload_failed';
 317         }
 318
 319         $this->get('session')->getFlashBag()->add(
 320             'notice',
 321             $message
 322         );
 323
 324         return $this->redirect($this->generateUrl('view', ['id' => $entry->getId()]));
 325     }
 326
 327     /**
 328      * Changes read status for an entry.
 329      *
 330      * @param Request $request
 331      * @param Entry   $entry
 332      *
 333      * @Route("/archive/{id}", requirements={"id" = "\d+"}, name="archive_entry")
 334      *
 335      * @return \Symfony\Component\HttpFoundation\RedirectResponse
 336      */
 337     public function toggleArchiveAction(Request $request, Entry $entry)
 338     {
 339         $this->checkUserAction($entry);
 340
 341         $entry->toggleArchive();
 342         $this->getDoctrine()->getManager()->flush();
 343
 344         $message = 'flashes.entry.notice.entry_unarchived';
 345         if ($entry->isArchived()) {
 346             $message = 'flashes.entry.notice.entry_archived';
 347         }
 348
 349         $this->get('session')->getFlashBag()->add(
 350             'notice',
 351             $message
 352         );
 353
 354         $redirectUrl = $this->get('wallabag_core.helper.redirect')->to($request->headers->get('referer'));
 355
 356         return $this->redirect($redirectUrl);
 357     }
 358
 359     /**
 360      * Changes favorite status for an entry.
 361      *
 362      * @param Request $request
 363      * @param Entry   $entry
 364      *
 365      * @Route("/star/{id}", requirements={"id" = "\d+"}, name="star_entry")
 366      *
 367      * @return \Symfony\Component\HttpFoundation\RedirectResponse
 368      */
 369     public function toggleStarAction(Request $request, Entry $entry)
 370     {
 371         $this->checkUserAction($entry);
 372
 373         $entry->toggleStar();
 374         $this->getDoctrine()->getManager()->flush();
 375
 376         $message = 'flashes.entry.notice.entry_unstarred';
 377         if ($entry->isStarred()) {
 378             $message = 'flashes.entry.notice.entry_starred';
 379         }
 380
 381         $this->get('session')->getFlashBag()->add(
 382             'notice',
 383             $message
 384         );
 385
 386         $redirectUrl = $this->get('wallabag_core.helper.redirect')->to($request->headers->get('referer'));
 387
 388         return $this->redirect($redirectUrl);
 389     }
 390
 391     /**
 392      * Deletes entry and redirect to the homepage or the last viewed page.
 393      *
 394      * @param Entry $entry
 395      *
 396      * @Route("/delete/{id}", requirements={"id" = "\d+"}, name="delete_entry")
 397      *
 398      * @return \Symfony\Component\HttpFoundation\RedirectResponse
 399      */
 400     public function deleteEntryAction(Request $request, Entry $entry)
 401     {
 402         $this->checkUserAction($entry);
 403
 404         // generates the view url for this entry to check for redirection later
 405         // to avoid redirecting to the deleted entry. Ugh.
 406         $url = $this->generateUrl(
 407             'view',
 408             ['id' => $entry->getId()],
 409             UrlGeneratorInterface::ABSOLUTE_URL
 410         );
 411
 412         $em = $this->getDoctrine()->getManager();
 413         $em->remove($entry);
 414         $em->flush();
 415
 416         $this->get('session')->getFlashBag()->add(
 417             'notice',
 418             'flashes.entry.notice.entry_deleted'
 419         );
 420
 421         // don't redirect user to the deleted entry
 422         $to = ($url !== $request->headers->get('referer') ? $request->headers->get('referer') : null);
 423
 424         $redirectUrl = $this->get('wallabag_core.helper.redirect')->to($to);
 425
 426         return $this->redirect($redirectUrl);
 427     }
 428
 429     /**
 430      * Check if the logged user can manage the given entry.
 431      *
 432      * @param Entry $entry
 433      */
 434     private function checkUserAction(Entry $entry)
 435     {
 436         if ($this->getUser()->getId() != $entry->getUser()->getId()) {
 437             throw $this->createAccessDeniedException('You can not access this entry.');
 438         }
 439     }
 440
 441     /**
 442      * Check for existing entry, if it exists, redirect to it with a message.
 443      *
 444      * @param Entry $entry
 445      *
 446      * @return Entry|bool
 447      */
 448     private function checkIfEntryAlreadyExists(Entry $entry)
 449     {
 450         return $this->get('wallabag_core.entry_repository')->findByUrlAndUserId($entry->getUrl(), $this->getUser()->getId());
 451     }
 452 }