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
  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 'untagged':
 230                 $qb = $repository->getBuilderForUntaggedByUser($this->getUser()->getId());
 231
 232                 break;
 233             case 'starred':
 234                 $qb = $repository->getBuilderForStarredByUser($this->getUser()->getId());
 235                 break;
 236
 237             case 'archive':
 238                 $qb = $repository->getBuilderForArchiveByUser($this->getUser()->getId());
 239                 break;
 240
 241             case 'unread':
 242                 $qb = $repository->getBuilderForUnreadByUser($this->getUser()->getId());
 243                 break;
 244
 245             case 'all':
 246                 $qb = $repository->getBuilderForAllByUser($this->getUser()->getId());
 247                 break;
 248
 249             default:
 250                 throw new \InvalidArgumentException(sprintf('Type "%s" is not implemented.', $type));
 251         }
 252
 253         $form = $this->createForm(EntryFilterType::class);
 254
 255         if ($request->query->has($form->getName())) {
 256             // manually bind values from the request
 257             $form->submit($request->query->get($form->getName()));
 258
 259             // build the query from the given form object
 260             $this->get('lexik_form_filter.query_builder_updater')->addFilterConditions($form, $qb);
 261         }
 262
 263         $pagerAdapter = new DoctrineORMAdapter($qb->getQuery());
 264
 265         $entries = $this->get('wallabag_core.helper.prepare_pager_for_entries')
 266             ->prepare($pagerAdapter, $page);
 267
 268         try {
 269             $entries->setCurrentPage($page);
 270         } catch (OutOfRangeCurrentPageException $e) {
 271             if ($page > 1) {
 272                 return $this->redirect($this->generateUrl($type, ['page' => $entries->getNbPages()]), 302);
 273             }
 274         }
 275
 276         return $this->render(
 277             'WallabagCoreBundle:Entry:entries.html.twig',
 278             [
 279                 'form' => $form->createView(),
 280                 'entries' => $entries,
 281                 'currentPage' => $page,
 282             ]
 283         );
 284     }
 285
 286     /**
 287      * Shows entry content.
 288      *
 289      * @param Entry $entry
 290      *
 291      * @Route("/view/{id}", requirements={"id" = "\d+"}, name="view")
 292      *
 293      * @return \Symfony\Component\HttpFoundation\Response
 294      */
 295     public function viewAction(Entry $entry)
 296     {
 297         $this->checkUserAction($entry);
 298
 299         return $this->render(
 300             'WallabagCoreBundle:Entry:entry.html.twig',
 301             ['entry' => $entry]
 302         );
 303     }
 304
 305     /**
 306      * Reload an entry.
 307      * Refetch content from the website and make it readable again.
 308      *
 309      * @param Entry $entry
 310      *
 311      * @Route("/reload/{id}", requirements={"id" = "\d+"}, name="reload_entry")
 312      *
 313      * @return \Symfony\Component\HttpFoundation\RedirectResponse
 314      */
 315     public function reloadAction(Entry $entry)
 316     {
 317         $this->checkUserAction($entry);
 318
 319         $message = 'flashes.entry.notice.entry_reloaded';
 320         if (false === $this->updateEntry($entry)) {
 321             $message = 'flashes.entry.notice.entry_reload_failed';
 322         }
 323
 324         $this->get('session')->getFlashBag()->add(
 325             'notice',
 326             $message
 327         );
 328
 329         return $this->redirect($this->generateUrl('view', ['id' => $entry->getId()]));
 330     }
 331
 332     /**
 333      * Changes read status for an entry.
 334      *
 335      * @param Request $request
 336      * @param Entry   $entry
 337      *
 338      * @Route("/archive/{id}", requirements={"id" = "\d+"}, name="archive_entry")
 339      *
 340      * @return \Symfony\Component\HttpFoundation\RedirectResponse
 341      */
 342     public function toggleArchiveAction(Request $request, Entry $entry)
 343     {
 344         $this->checkUserAction($entry);
 345
 346         $entry->toggleArchive();
 347         $this->getDoctrine()->getManager()->flush();
 348
 349         $message = 'flashes.entry.notice.entry_unarchived';
 350         if ($entry->isArchived()) {
 351             $message = 'flashes.entry.notice.entry_archived';
 352         }
 353
 354         $this->get('session')->getFlashBag()->add(
 355             'notice',
 356             $message
 357         );
 358
 359         $redirectUrl = $this->get('wallabag_core.helper.redirect')->to($request->headers->get('referer'));
 360
 361         return $this->redirect($redirectUrl);
 362     }
 363
 364     /**
 365      * Changes starred status for an entry.
 366      *
 367      * @param Request $request
 368      * @param Entry   $entry
 369      *
 370      * @Route("/star/{id}", requirements={"id" = "\d+"}, name="star_entry")
 371      *
 372      * @return \Symfony\Component\HttpFoundation\RedirectResponse
 373      */
 374     public function toggleStarAction(Request $request, Entry $entry)
 375     {
 376         $this->checkUserAction($entry);
 377
 378         $entry->toggleStar();
 379         $this->getDoctrine()->getManager()->flush();
 380
 381         $message = 'flashes.entry.notice.entry_unstarred';
 382         if ($entry->isStarred()) {
 383             $message = 'flashes.entry.notice.entry_starred';
 384         }
 385
 386         $this->get('session')->getFlashBag()->add(
 387             'notice',
 388             $message
 389         );
 390
 391         $redirectUrl = $this->get('wallabag_core.helper.redirect')->to($request->headers->get('referer'));
 392
 393         return $this->redirect($redirectUrl);
 394     }
 395
 396     /**
 397      * Deletes entry and redirect to the homepage or the last viewed page.
 398      *
 399      * @param Entry $entry
 400      *
 401      * @Route("/delete/{id}", requirements={"id" = "\d+"}, name="delete_entry")
 402      *
 403      * @return \Symfony\Component\HttpFoundation\RedirectResponse
 404      */
 405     public function deleteEntryAction(Request $request, Entry $entry)
 406     {
 407         $this->checkUserAction($entry);
 408
 409         // generates the view url for this entry to check for redirection later
 410         // to avoid redirecting to the deleted entry. Ugh.
 411         $url = $this->generateUrl(
 412             'view',
 413             ['id' => $entry->getId()],
 414             UrlGeneratorInterface::ABSOLUTE_PATH
 415         );
 416
 417         $em = $this->getDoctrine()->getManager();
 418         $em->remove($entry);
 419         $em->flush();
 420
 421         $this->get('session')->getFlashBag()->add(
 422             'notice',
 423             'flashes.entry.notice.entry_deleted'
 424         );
 425
 426         // don't redirect user to the deleted entry (check that the referer doesn't end with the same url)
 427         $referer = $request->headers->get('referer');
 428         $to = (1 !== preg_match('#'.$url.'$#i', $referer) ? $referer : null);
 429
 430         $redirectUrl = $this->get('wallabag_core.helper.redirect')->to($to);
 431
 432         return $this->redirect($redirectUrl);
 433     }
 434
 435     /**
 436      * Check if the logged user can manage the given entry.
 437      *
 438      * @param Entry $entry
 439      */
 440     private function checkUserAction(Entry $entry)
 441     {
 442         if (null === $this->getUser() || $this->getUser()->getId() != $entry->getUser()->getId()) {
 443             throw $this->createAccessDeniedException('You can not access this entry.');
 444         }
 445     }
 446
 447     /**
 448      * Check for existing entry, if it exists, redirect to it with a message.
 449      *
 450      * @param Entry $entry
 451      *
 452      * @return Entry|bool
 453      */
 454     private function checkIfEntryAlreadyExists(Entry $entry)
 455     {
 456         return $this->get('wallabag_core.entry_repository')->findByUrlAndUserId($entry->getUrl(), $this->getUser()->getId());
 457     }
 458
 459     /**
 460      * Get public URL for entry (and generate it if necessary).
 461      *
 462      * @param Entry $entry
 463      *
 464      * @Route("/share/{id}", requirements={"id" = "\d+"}, name="share")
 465      *
 466      * @return \Symfony\Component\HttpFoundation\Response
 467      */
 468     public function shareAction(Entry $entry)
 469     {
 470         $this->checkUserAction($entry);
 471
 472         if (null === $entry->getUuid()) {
 473             $entry->generateUuid();
 474
 475             $em = $this->getDoctrine()->getManager();
 476             $em->persist($entry);
 477             $em->flush();
 478         }
 479
 480         return $this->redirect($this->generateUrl('share_entry', [
 481             'uuid' => $entry->getUuid(),
 482         ]));
 483     }
 484
 485     /**
 486      * Disable public sharing for an entry.
 487      *
 488      * @param Entry $entry
 489      *
 490      * @Route("/share/delete/{id}", requirements={"id" = "\d+"}, name="delete_share")
 491      *
 492      * @return \Symfony\Component\HttpFoundation\Response
 493      */
 494     public function deleteShareAction(Entry $entry)
 495     {
 496         $this->checkUserAction($entry);
 497
 498         $entry->cleanUuid();
 499
 500         $em = $this->getDoctrine()->getManager();
 501         $em->persist($entry);
 502         $em->flush();
 503
 504         return $this->redirect($this->generateUrl('view', [
 505             'id' => $entry->getId(),
 506         ]));
 507     }
 508
 509     /**
 510      * Ability to view a content publicly.
 511      *
 512      * @param Entry $entry
 513      *
 514      * @Route("/share/{uuid}", requirements={"uuid" = ".+"}, name="share_entry")
 515      * @Cache(maxage="25200", smaxage="25200", public=true)
 516      *
 517      * @return \Symfony\Component\HttpFoundation\Response
 518      */
 519     public function shareEntryAction(Entry $entry)
 520     {
 521         if (!$this->get('craue_config')->get('share_public')) {
 522             throw $this->createAccessDeniedException('Sharing an entry is disabled for this user.');
 523         }
 524
 525         return $this->render(
 526             '@WallabagCore/themes/share.html.twig',
 527             ['entry' => $entry]
 528         );
 529     }
 530
 531     /**
 532      * Shows untagged articles for current user.
 533      *
 534      * @param Request $request
 535      * @param int     $page
 536      *
 537      * @Route("/untagged/list/{page}", name="untagged", defaults={"page" = "1"})
 538      *
 539      * @return \Symfony\Component\HttpFoundation\Response
 540      */
 541     public function showUntaggedEntriesAction(Request $request, $page)
 542     {
 543         return $this->showEntries('untagged', $request, $page);
 544     }
 545 }