X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=src%2FWallabag%2FCoreBundle%2FController%2FEntryController.php;h=3b28e635025253a8a7baa1c4eb6ff6c12600aba4;hb=8a8a78a64c116caf81aaa4339906298bdc0e32e0;hp=e60777070aa782bdff707e3f246d03ba96fcccb7;hpb=624a7c6df1142048cc73770e2c7b7377acd30a9e;p=github%2Fwallabag%2Fwallabag.git diff --git a/src/Wallabag/CoreBundle/Controller/EntryController.php b/src/Wallabag/CoreBundle/Controller/EntryController.php index e6077707..9b2954e7 100644 --- a/src/Wallabag/CoreBundle/Controller/EntryController.php +++ b/src/Wallabag/CoreBundle/Controller/EntryController.php @@ -2,39 +2,98 @@ namespace Wallabag\CoreBundle\Controller; +use Doctrine\ORM\NoResultException; use Pagerfanta\Adapter\DoctrineORMAdapter; -use Pagerfanta\Pagerfanta; -use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route; +use Pagerfanta\Exception\OutOfRangeCurrentPageException; +use Sensio\Bundle\FrameworkExtraBundle\Configuration\Cache; use Symfony\Bundle\FrameworkBundle\Controller\Controller; use Symfony\Component\HttpFoundation\Request; +use Symfony\Component\Routing\Annotation\Route; use Symfony\Component\Routing\Generator\UrlGeneratorInterface; use Wallabag\CoreBundle\Entity\Entry; -use Wallabag\CoreBundle\Form\Type\EntryFilterType; +use Wallabag\CoreBundle\Event\EntryDeletedEvent; +use Wallabag\CoreBundle\Event\EntrySavedEvent; use Wallabag\CoreBundle\Form\Type\EditEntryType; +use Wallabag\CoreBundle\Form\Type\EntryFilterType; use Wallabag\CoreBundle\Form\Type\NewEntryType; +use Wallabag\CoreBundle\Form\Type\SearchEntryType; class EntryController extends Controller { /** - * @param Entry $entry + * @Route("/mass", name="mass_action") + * + * @return \Symfony\Component\HttpFoundation\Response */ - private function updateEntry(Entry $entry) + public function massAction(Request $request) { - try { - $entry = $this->get('wallabag_core.content_proxy')->updateEntry($entry, $entry->getUrl()); - $em = $this->getDoctrine()->getManager(); - $em->persist($entry); + $em = $this->getDoctrine()->getManager(); + $values = $request->request->all(); + + $action = 'toggle-read'; + if (isset($values['toggle-star'])) { + $action = 'toggle-star'; + } elseif (isset($values['delete'])) { + $action = 'delete'; + } + + if (isset($values['entry-checkbox'])) { + foreach ($values['entry-checkbox'] as $id) { + /** @var Entry * */ + $entry = $this->get('wallabag_core.entry_repository')->findById((int) $id)[0]; + + $this->checkUserAction($entry); + + if ('toggle-read' === $action) { + $entry->toggleArchive(); + } elseif ('toggle-star' === $action) { + $entry->toggleStar(); + } elseif ('delete' === $action) { + $this->get('event_dispatcher')->dispatch(EntryDeletedEvent::NAME, new EntryDeletedEvent($entry)); + $em->remove($entry); + } + } + $em->flush(); - } catch (\Exception $e) { - return false; } - return true; + $redirectUrl = $this->get('wallabag_core.helper.redirect')->to($request->headers->get('referer')); + + return $this->redirect($redirectUrl); } /** - * @param Request $request + * @param int $page * + * @Route("/search/{page}", name="search", defaults={"page" = 1}) + * + * Default parameter for page is hardcoded (in duplication of the defaults from the Route) + * because this controller is also called inside the layout template without any page as argument + * + * @return \Symfony\Component\HttpFoundation\Response + */ + public function searchFormAction(Request $request, $page = 1, $currentRoute = null) + { + // fallback to retrieve currentRoute from query parameter instead of injected one (when using inside a template) + if (null === $currentRoute && $request->query->has('currentRoute')) { + $currentRoute = $request->query->get('currentRoute'); + } + + $form = $this->createForm(SearchEntryType::class); + + $form->handleRequest($request); + + if ($form->isSubmitted() && $form->isValid()) { + return $this->showEntries('search', $request, $page); + } + + return $this->render('WallabagCoreBundle:Entry:search_form.html.twig', [ + 'form' => $form->createView(), + 'currentRoute' => $currentRoute, + ]); + } + + /** * @Route("/new-entry", name="new_entry") * * @return \Symfony\Component\HttpFoundation\Response @@ -47,35 +106,36 @@ class EntryController extends Controller $form->handleRequest($request); - if ($form->isValid()) { + if ($form->isSubmitted() && $form->isValid()) { $existingEntry = $this->checkIfEntryAlreadyExists($entry); if (false !== $existingEntry) { $this->get('session')->getFlashBag()->add( 'notice', - $this->get('translator')->trans('flashes.entry.notice.entry_already_saved', array('%date%' => $existingEntry->getCreatedAt()->format('d-m-Y'))) + $this->get('translator')->trans('flashes.entry.notice.entry_already_saved', ['%date%' => $existingEntry->getCreatedAt()->format('d-m-Y')]) ); - return $this->redirect($this->generateUrl('view', array('id' => $existingEntry->getId()))); + return $this->redirect($this->generateUrl('view', ['id' => $existingEntry->getId()])); } $this->updateEntry($entry); - $this->get('session')->getFlashBag()->add( - 'notice', - 'flashes.entry.notice.entry_saved' - ); + + $em = $this->getDoctrine()->getManager(); + $em->persist($entry); + $em->flush(); + + // entry saved, dispatch event about it! + $this->get('event_dispatcher')->dispatch(EntrySavedEvent::NAME, new EntrySavedEvent($entry)); return $this->redirect($this->generateUrl('homepage')); } - return $this->render('WallabagCoreBundle:Entry:new_form.html.twig', array( + return $this->render('WallabagCoreBundle:Entry:new_form.html.twig', [ 'form' => $form->createView(), - )); + ]); } /** - * @param Request $request - * * @Route("/bookmarklet", name="bookmarklet") * * @return \Symfony\Component\HttpFoundation\Response @@ -87,6 +147,13 @@ class EntryController extends Controller if (false === $this->checkIfEntryAlreadyExists($entry)) { $this->updateEntry($entry); + + $em = $this->getDoctrine()->getManager(); + $em->persist($entry); + $em->flush(); + + // entry saved, dispatch event about it! + $this->get('event_dispatcher')->dispatch(EntrySavedEvent::NAME, new EntrySavedEvent($entry)); } return $this->redirect($this->generateUrl('homepage')); @@ -105,9 +172,6 @@ class EntryController extends Controller /** * Edit an entry content. * - * @param Request $request - * @param Entry $entry - * * @Route("/edit/{id}", requirements={"id" = "\d+"}, name="edit") * * @return \Symfony\Component\HttpFoundation\Response @@ -120,7 +184,7 @@ class EntryController extends Controller $form->handleRequest($request); - if ($form->isValid()) { + if ($form->isSubmitted() && $form->isValid()) { $em = $this->getDoctrine()->getManager(); $em->persist($entry); $em->flush(); @@ -130,19 +194,18 @@ class EntryController extends Controller 'flashes.entry.notice.entry_updated' ); - return $this->redirect($this->generateUrl('view', array('id' => $entry->getId()))); + return $this->redirect($this->generateUrl('view', ['id' => $entry->getId()])); } - return $this->render('WallabagCoreBundle:Entry:edit.html.twig', array( + return $this->render('WallabagCoreBundle:Entry:edit.html.twig', [ 'form' => $form->createView(), - )); + ]); } /** * Shows all entries for current user. * - * @param Request $request - * @param int $page + * @param int $page * * @Route("/all/list/{page}", name="all", defaults={"page" = "1"}) * @@ -156,8 +219,7 @@ class EntryController extends Controller /** * Shows unread entries for current user. * - * @param Request $request - * @param int $page + * @param int $page * * @Route("/unread/list/{page}", name="unread", defaults={"page" = "1"}) * @@ -166,7 +228,7 @@ class EntryController extends Controller public function showUnreadAction(Request $request, $page) { // load the quickstart if no entry in database - if ($page == 1 && $this->get('wallabag_core.entry_repository')->countAllEntriesByUsername($this->getUser()->getId()) == 0) { + if (1 === (int) $page && 0 === $this->get('wallabag_core.entry_repository')->countAllEntriesByUser($this->getUser()->getId())) { return $this->redirect($this->generateUrl('quickstart')); } @@ -176,8 +238,7 @@ class EntryController extends Controller /** * Shows read entries for current user. * - * @param Request $request - * @param int $page + * @param int $page * * @Route("/archive/list/{page}", name="archive", defaults={"page" = "1"}) * @@ -191,8 +252,7 @@ class EntryController extends Controller /** * Shows starred entries for current user. * - * @param Request $request - * @param int $page + * @param int $page * * @Route("/starred/list/{page}", name="starred", defaults={"page" = "1"}) * @@ -204,71 +264,47 @@ class EntryController extends Controller } /** - * Global method to retrieve entries depending on the given type - * It returns the response to be send. + * Shows untagged articles for current user. * - * @param string $type Entries type: unread, starred or archive - * @param Request $request - * @param int $page + * @param int $page + * + * @Route("/untagged/list/{page}", name="untagged", defaults={"page" = "1"}) * * @return \Symfony\Component\HttpFoundation\Response */ - private function showEntries($type, Request $request, $page) + public function showUntaggedEntriesAction(Request $request, $page) { - $repository = $this->get('wallabag_core.entry_repository'); - - switch ($type) { - case 'starred': - $qb = $repository->getBuilderForStarredByUser($this->getUser()->getId()); - break; - - case 'archive': - $qb = $repository->getBuilderForArchiveByUser($this->getUser()->getId()); - break; - - case 'unread': - $qb = $repository->getBuilderForUnreadByUser($this->getUser()->getId()); - break; - - case 'all': - $qb = $repository->getBuilderForAllByUser($this->getUser()->getId()); - break; - - default: - throw new \InvalidArgumentException(sprintf('Type "%s" is not implemented.', $type)); - } - - $form = $this->createForm(EntryFilterType::class); - - if ($request->query->has($form->getName())) { - // manually bind values from the request - $form->submit($request->query->get($form->getName())); + return $this->showEntries('untagged', $request, $page); + } - // build the query from the given form object - $this->get('lexik_form_filter.query_builder_updater')->addFilterConditions($form, $qb); + /** + * Shows random entry depending on the given type. + * + * @param string $type + * + * @Route("/{type}/random", name="random_entry", requirements={"type": "unread|starred|archive|untagged|all"}) + * + * @return \Symfony\Component\HttpFoundation\RedirectResponse + */ + public function redirectRandomEntryAction($type = 'all') + { + try { + $entry = $this->get('wallabag_core.entry_repository') + ->getRandomEntry($this->getUser()->getId(), $type); + } catch (NoResultException $e) { + $bag = $this->get('session')->getFlashBag(); + $bag->clear(); + $bag->add('notice', 'flashes.entry.notice.no_random_entry'); + + return $this->redirect($this->generateUrl($type)); } - $pagerAdapter = new DoctrineORMAdapter($qb->getQuery()); - $entries = new Pagerfanta($pagerAdapter); - - $entries->setMaxPerPage($this->getUser()->getConfig()->getItemsPerPage()); - $entries->setCurrentPage($page); - - return $this->render( - 'WallabagCoreBundle:Entry:entries.html.twig', - array( - 'form' => $form->createView(), - 'entries' => $entries, - 'currentPage' => $page, - ) - ); + return $this->redirect($this->generateUrl('view', ['id' => $entry->getId()])); } /** * Shows entry content. * - * @param Entry $entry - * * @Route("/view/{id}", requirements={"id" = "\d+"}, name="view") * * @return \Symfony\Component\HttpFoundation\Response @@ -279,7 +315,7 @@ class EntryController extends Controller return $this->render( 'WallabagCoreBundle:Entry:entry.html.twig', - array('entry' => $entry) + ['entry' => $entry] ); } @@ -287,8 +323,6 @@ class EntryController extends Controller * Reload an entry. * Refetch content from the website and make it readable again. * - * @param Entry $entry - * * @Route("/reload/{id}", requirements={"id" = "\d+"}, name="reload_entry") * * @return \Symfony\Component\HttpFoundation\RedirectResponse @@ -297,25 +331,30 @@ class EntryController extends Controller { $this->checkUserAction($entry); - $message = 'flashes.entry.notice.entry_reloaded'; - if (false === $this->updateEntry($entry)) { - $message = 'flashes.entry.notice.entry_reload_failed'; + $this->updateEntry($entry, 'entry_reloaded'); + + // if refreshing entry failed, don't save it + if ($this->getParameter('wallabag_core.fetching_error_message') === $entry->getContent()) { + $bag = $this->get('session')->getFlashBag(); + $bag->clear(); + $bag->add('notice', 'flashes.entry.notice.entry_reloaded_failed'); + + return $this->redirect($this->generateUrl('view', ['id' => $entry->getId()])); } - $this->get('session')->getFlashBag()->add( - 'notice', - $message - ); + $em = $this->getDoctrine()->getManager(); + $em->persist($entry); + $em->flush(); + + // entry saved, dispatch event about it! + $this->get('event_dispatcher')->dispatch(EntrySavedEvent::NAME, new EntrySavedEvent($entry)); - return $this->redirect($this->generateUrl('view', array('id' => $entry->getId()))); + return $this->redirect($this->generateUrl('view', ['id' => $entry->getId()])); } /** * Changes read status for an entry. * - * @param Request $request - * @param Entry $entry - * * @Route("/archive/{id}", requirements={"id" = "\d+"}, name="archive_entry") * * @return \Symfony\Component\HttpFoundation\RedirectResponse @@ -337,14 +376,13 @@ class EntryController extends Controller $message ); - return $this->redirect($request->headers->get('referer')); + $redirectUrl = $this->get('wallabag_core.helper.redirect')->to($request->headers->get('referer')); + + return $this->redirect($redirectUrl); } /** - * Changes favorite status for an entry. - * - * @param Request $request - * @param Entry $entry + * Changes starred status for an entry. * * @Route("/star/{id}", requirements={"id" = "\d+"}, name="star_entry") * @@ -355,6 +393,7 @@ class EntryController extends Controller $this->checkUserAction($entry); $entry->toggleStar(); + $entry->updateStar($entry->isStarred()); $this->getDoctrine()->getManager()->flush(); $message = 'flashes.entry.notice.entry_unstarred'; @@ -367,14 +406,14 @@ class EntryController extends Controller $message ); - return $this->redirect($request->headers->get('referer')); + $redirectUrl = $this->get('wallabag_core.helper.redirect')->to($request->headers->get('referer')); + + return $this->redirect($redirectUrl); } /** * Deletes entry and redirect to the homepage or the last viewed page. * - * @param Entry $entry - * * @Route("/delete/{id}", requirements={"id" = "\d+"}, name="delete_entry") * * @return \Symfony\Component\HttpFoundation\RedirectResponse @@ -387,10 +426,13 @@ class EntryController extends Controller // to avoid redirecting to the deleted entry. Ugh. $url = $this->generateUrl( 'view', - array('id' => $entry->getId()), - UrlGeneratorInterface::ABSOLUTE_URL + ['id' => $entry->getId()], + UrlGeneratorInterface::ABSOLUTE_PATH ); + // entry deleted, dispatch event about it! + $this->get('event_dispatcher')->dispatch(EntryDeletedEvent::NAME, new EntryDeletedEvent($entry)); + $em = $this->getDoctrine()->getManager(); $em->remove($entry); $em->flush(); @@ -400,18 +442,194 @@ class EntryController extends Controller 'flashes.entry.notice.entry_deleted' ); - // don't redirect user to the deleted entry - return $this->redirect($url !== $request->headers->get('referer') ? $request->headers->get('referer') : $this->generateUrl('homepage')); + // don't redirect user to the deleted entry (check that the referer doesn't end with the same url) + $referer = $request->headers->get('referer'); + $to = (1 !== preg_match('#' . $url . '$#i', $referer) ? $referer : null); + + $redirectUrl = $this->get('wallabag_core.helper.redirect')->to($to); + + return $this->redirect($redirectUrl); } /** - * Check if the logged user can manage the given entry. + * Get public URL for entry (and generate it if necessary). + * + * @Route("/share/{id}", requirements={"id" = "\d+"}, name="share") + * + * @return \Symfony\Component\HttpFoundation\Response + */ + public function shareAction(Entry $entry) + { + $this->checkUserAction($entry); + + if (null === $entry->getUid()) { + $entry->generateUid(); + + $em = $this->getDoctrine()->getManager(); + $em->persist($entry); + $em->flush(); + } + + return $this->redirect($this->generateUrl('share_entry', [ + 'uid' => $entry->getUid(), + ])); + } + + /** + * Disable public sharing for an entry. + * + * @Route("/share/delete/{id}", requirements={"id" = "\d+"}, name="delete_share") + * + * @return \Symfony\Component\HttpFoundation\Response + */ + public function deleteShareAction(Entry $entry) + { + $this->checkUserAction($entry); + + $entry->cleanUid(); + + $em = $this->getDoctrine()->getManager(); + $em->persist($entry); + $em->flush(); + + return $this->redirect($this->generateUrl('view', [ + 'id' => $entry->getId(), + ])); + } + + /** + * Ability to view a content publicly. + * + * @Route("/share/{uid}", requirements={"uid" = ".+"}, name="share_entry") + * @Cache(maxage="25200", smaxage="25200", public=true) + * + * @return \Symfony\Component\HttpFoundation\Response + */ + public function shareEntryAction(Entry $entry) + { + if (!$this->get('craue_config')->get('share_public')) { + throw $this->createAccessDeniedException('Sharing an entry is disabled for this user.'); + } + + return $this->render( + '@WallabagCore/themes/common/Entry/share.html.twig', + ['entry' => $entry] + ); + } + + /** + * Global method to retrieve entries depending on the given type + * It returns the response to be send. + * + * @param string $type Entries type: unread, starred or archive + * @param int $page + * + * @return \Symfony\Component\HttpFoundation\Response + */ + private function showEntries($type, Request $request, $page) + { + $repository = $this->get('wallabag_core.entry_repository'); + $searchTerm = (isset($request->get('search_entry')['term']) ? $request->get('search_entry')['term'] : ''); + $currentRoute = (null !== $request->query->get('currentRoute') ? $request->query->get('currentRoute') : ''); + + switch ($type) { + case 'search': + $qb = $repository->getBuilderForSearchByUser($this->getUser()->getId(), $searchTerm, $currentRoute); + break; + case 'untagged': + $qb = $repository->getBuilderForUntaggedByUser($this->getUser()->getId()); + break; + case 'starred': + $qb = $repository->getBuilderForStarredByUser($this->getUser()->getId()); + break; + case 'archive': + $qb = $repository->getBuilderForArchiveByUser($this->getUser()->getId()); + break; + case 'unread': + $qb = $repository->getBuilderForUnreadByUser($this->getUser()->getId()); + break; + case 'all': + $qb = $repository->getBuilderForAllByUser($this->getUser()->getId()); + break; + default: + throw new \InvalidArgumentException(sprintf('Type "%s" is not implemented.', $type)); + } + + $form = $this->createForm(EntryFilterType::class); + + if ($request->query->has($form->getName())) { + // manually bind values from the request + $form->submit($request->query->get($form->getName())); + + // build the query from the given form object + $this->get('lexik_form_filter.query_builder_updater')->addFilterConditions($form, $qb); + } + + $pagerAdapter = new DoctrineORMAdapter($qb->getQuery(), true, false); + + $entries = $this->get('wallabag_core.helper.prepare_pager_for_entries')->prepare($pagerAdapter); + + try { + $entries->setCurrentPage($page); + } catch (OutOfRangeCurrentPageException $e) { + if ($page > 1) { + return $this->redirect($this->generateUrl($type, ['page' => $entries->getNbPages()]), 302); + } + } + + $nbEntriesUntagged = $this->get('wallabag_core.entry_repository') + ->countUntaggedEntriesByUser($this->getUser()->getId()); + + return $this->render( + 'WallabagCoreBundle:Entry:entries.html.twig', [ + 'form' => $form->createView(), + 'entries' => $entries, + 'currentPage' => $page, + 'searchTerm' => $searchTerm, + 'isFiltered' => $form->isSubmitted(), + 'nbEntriesUntagged' => $nbEntriesUntagged, + ] + ); + } + + /** + * Fetch content and update entry. + * In case it fails, $entry->getContent will return an error message. * - * @param Entry $entry + * @param string $prefixMessage Should be the translation key: entry_saved or entry_reloaded + */ + private function updateEntry(Entry $entry, $prefixMessage = 'entry_saved') + { + $message = 'flashes.entry.notice.' . $prefixMessage; + + try { + $this->get('wallabag_core.content_proxy')->updateEntry($entry, $entry->getUrl()); + } catch (\Exception $e) { + $this->get('logger')->error('Error while saving an entry', [ + 'exception' => $e, + 'entry' => $entry, + ]); + + $message = 'flashes.entry.notice.' . $prefixMessage . '_failed'; + } + + if (empty($entry->getDomainName())) { + $this->get('wallabag_core.content_proxy')->setEntryDomainName($entry); + } + + if (empty($entry->getTitle())) { + $this->get('wallabag_core.content_proxy')->setDefaultEntryTitle($entry); + } + + $this->get('session')->getFlashBag()->add('notice', $message); + } + + /** + * Check if the logged user can manage the given entry. */ private function checkUserAction(Entry $entry) { - if ($this->getUser()->getId() != $entry->getUser()->getId()) { + if (null === $this->getUser() || $this->getUser()->getId() !== $entry->getUser()->getId()) { throw $this->createAccessDeniedException('You can not access this entry.'); } } @@ -419,11 +637,9 @@ class EntryController extends Controller /** * Check for existing entry, if it exists, redirect to it with a message. * - * @param $entry - * - * @return array|bool + * @return Entry|bool */ - private function checkIfEntryAlreadyExists($entry) + private function checkIfEntryAlreadyExists(Entry $entry) { return $this->get('wallabag_core.entry_repository')->findByUrlAndUserId($entry->getUrl(), $this->getUser()->getId()); }