wallabag/src/Wallabag/CoreBundle/Controller/EntryController.php

604 lines
19 KiB
PHP
Raw Normal View History

2015-01-22 16:18:56 +00:00
<?php
namespace Wallabag\CoreBundle\Controller;
2015-01-22 16:18:56 +00:00
use Pagerfanta\Adapter\DoctrineORMAdapter;
use Pagerfanta\Exception\OutOfRangeCurrentPageException;
2017-07-01 07:52:38 +00:00
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Cache;
2015-01-22 16:18:56 +00:00
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
2015-01-23 11:45:24 +00:00
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
2015-02-06 06:45:32 +00:00
use Wallabag\CoreBundle\Entity\Entry;
2017-07-01 07:52:38 +00:00
use Wallabag\CoreBundle\Event\EntryDeletedEvent;
use Wallabag\CoreBundle\Event\EntrySavedEvent;
use Wallabag\CoreBundle\Form\Type\EditEntryType;
2017-07-01 07:52:38 +00:00
use Wallabag\CoreBundle\Form\Type\EntryFilterType;
use Wallabag\CoreBundle\Form\Type\NewEntryType;
2016-11-04 22:24:43 +00:00
use Wallabag\CoreBundle\Form\Type\SearchEntryType;
2015-01-22 16:18:56 +00:00
class EntryController extends Controller
{
2016-11-04 22:24:43 +00:00
/**
* @param Request $request
* @param int $page
*
2016-12-14 10:54:30 +00:00
* @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
2016-11-04 22:24:43 +00:00
*
* @return \Symfony\Component\HttpFoundation\Response
*/
2016-12-14 10:54:30 +00:00
public function searchFormAction(Request $request, $page = 1, $currentRoute = null)
2016-11-04 22:24:43 +00:00
{
2016-12-14 10:54:30 +00:00
// 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');
}
2016-11-04 22:24:43 +00:00
$form = $this->createForm(SearchEntryType::class);
$form->handleRequest($request);
2016-12-14 10:54:30 +00:00
if ($form->isSubmitted() && $form->isValid()) {
2016-11-04 22:24:43 +00:00
return $this->showEntries('search', $request, $page);
}
return $this->render('WallabagCoreBundle:Entry:search_form.html.twig', [
'form' => $form->createView(),
'currentRoute' => $currentRoute,
2016-11-04 22:24:43 +00:00
]);
}
2015-01-23 13:58:17 +00:00
/**
* @param Request $request
*
2015-08-12 06:22:30 +00:00
* @Route("/new-entry", name="new_entry")
*
2015-01-23 13:58:17 +00:00
* @return \Symfony\Component\HttpFoundation\Response
*/
2015-08-12 06:22:30 +00:00
public function addEntryFormAction(Request $request)
2015-01-23 13:58:17 +00:00
{
$entry = new Entry($this->getUser());
2015-01-23 13:58:17 +00:00
$form = $this->createForm(NewEntryType::class, $entry);
2015-01-23 13:58:17 +00:00
$form->handleRequest($request);
2016-12-14 10:54:30 +00:00
if ($form->isSubmitted() && $form->isValid()) {
2016-04-09 11:44:54 +00:00
$existingEntry = $this->checkIfEntryAlreadyExists($entry);
if (false !== $existingEntry) {
$this->get('session')->getFlashBag()->add(
'notice',
$this->get('translator')->trans('flashes.entry.notice.entry_already_saved', ['%date%' => $existingEntry->getCreatedAt()->format('d-m-Y')])
);
return $this->redirect($this->generateUrl('view', ['id' => $existingEntry->getId()]));
}
$this->updateEntry($entry);
$em = $this->getDoctrine()->getManager();
$em->persist($entry);
$em->flush();
2015-01-23 13:58:17 +00:00
// entry saved, dispatch event about it!
$this->get('event_dispatcher')->dispatch(EntrySavedEvent::NAME, new EntrySavedEvent($entry));
2015-01-23 13:58:17 +00:00
return $this->redirect($this->generateUrl('homepage'));
}
return $this->render('WallabagCoreBundle:Entry:new_form.html.twig', [
2015-01-23 13:58:17 +00:00
'form' => $form->createView(),
]);
2015-01-23 13:58:17 +00:00
}
2015-10-07 16:08:51 +00:00
/**
* @param Request $request
*
* @Route("/bookmarklet", name="bookmarklet")
*
* @return \Symfony\Component\HttpFoundation\Response
*/
2016-01-20 16:16:17 +00:00
public function addEntryViaBookmarkletAction(Request $request)
2015-10-07 16:08:51 +00:00
{
$entry = new Entry($this->getUser());
$entry->setUrl($request->get('url'));
2016-04-09 11:44:54 +00:00
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));
}
2015-10-07 16:08:51 +00:00
return $this->redirect($this->generateUrl('homepage'));
}
2015-08-12 06:22:30 +00:00
/**
* @Route("/new", name="new")
*
* @return \Symfony\Component\HttpFoundation\Response
*/
2016-03-27 18:35:56 +00:00
public function addEntryAction()
2015-08-12 06:22:30 +00:00
{
return $this->render('WallabagCoreBundle:Entry:new.html.twig');
}
/**
* Edit an entry content.
*
* @param Request $request
* @param Entry $entry
*
* @Route("/edit/{id}", requirements={"id" = "\d+"}, name="edit")
*
* @return \Symfony\Component\HttpFoundation\Response
*/
public function editEntryAction(Request $request, Entry $entry)
{
$this->checkUserAction($entry);
$form = $this->createForm(EditEntryType::class, $entry);
$form->handleRequest($request);
2016-12-14 10:54:30 +00:00
if ($form->isSubmitted() && $form->isValid()) {
$em = $this->getDoctrine()->getManager();
$em->persist($entry);
$em->flush();
$this->get('session')->getFlashBag()->add(
'notice',
2016-03-11 13:48:46 +00:00
'flashes.entry.notice.entry_updated'
);
return $this->redirect($this->generateUrl('view', ['id' => $entry->getId()]));
}
return $this->render('WallabagCoreBundle:Entry:edit.html.twig', [
'form' => $form->createView(),
]);
}
/**
* Shows all entries for current user.
*
* @param Request $request
* @param int $page
*
* @Route("/all/list/{page}", name="all", defaults={"page" = "1"})
*
* @return \Symfony\Component\HttpFoundation\Response
*/
public function showAllAction(Request $request, $page)
{
return $this->showEntries('all', $request, $page);
}
2015-01-22 16:18:56 +00:00
/**
2015-05-30 11:52:26 +00:00
* Shows unread entries for current user.
2015-01-23 11:45:24 +00:00
*
* @param Request $request
* @param int $page
*
* @Route("/unread/list/{page}", name="unread", defaults={"page" = "1"})
*
2015-01-23 11:45:24 +00:00
* @return \Symfony\Component\HttpFoundation\Response
2015-01-22 16:18:56 +00:00
*/
public function showUnreadAction(Request $request, $page)
2015-01-22 16:18:56 +00:00
{
2016-01-09 13:34:49 +00:00
// load the quickstart if no entry in database
2017-07-03 05:30:54 +00:00
if ((int) $page === 1 && $this->get('wallabag_core.entry_repository')->countAllEntriesByUser($this->getUser()->getId()) === 0) {
2016-01-09 13:34:49 +00:00
return $this->redirect($this->generateUrl('quickstart'));
}
return $this->showEntries('unread', $request, $page);
2015-01-22 16:18:56 +00:00
}
2015-01-22 20:11:22 +00:00
/**
2015-05-30 11:52:26 +00:00
* Shows read entries for current user.
2015-01-23 11:45:24 +00:00
*
* @param Request $request
* @param int $page
*
* @Route("/archive/list/{page}", name="archive", defaults={"page" = "1"})
*
2015-01-23 11:45:24 +00:00
* @return \Symfony\Component\HttpFoundation\Response
2015-01-22 20:11:22 +00:00
*/
public function showArchiveAction(Request $request, $page)
2015-01-22 20:11:22 +00:00
{
return $this->showEntries('archive', $request, $page);
}
/**
* Shows starred entries for current user.
*
* @param Request $request
* @param int $page
*
* @Route("/starred/list/{page}", name="starred", defaults={"page" = "1"})
*
* @return \Symfony\Component\HttpFoundation\Response
*/
public function showStarredAction(Request $request, $page)
{
return $this->showEntries('starred', $request, $page);
}
2015-01-22 20:11:22 +00:00
/**
2015-05-30 11:52:26 +00:00
* Shows entry content.
2015-01-23 11:45:24 +00:00
*
* @param Entry $entry
*
2015-01-22 20:11:22 +00:00
* @Route("/view/{id}", requirements={"id" = "\d+"}, name="view")
*
2015-01-23 11:45:24 +00:00
* @return \Symfony\Component\HttpFoundation\Response
2015-01-22 20:11:22 +00:00
*/
2015-02-06 06:45:32 +00:00
public function viewAction(Entry $entry)
2015-01-22 20:11:22 +00:00
{
$this->checkUserAction($entry);
2015-01-22 20:11:22 +00:00
return $this->render(
'WallabagCoreBundle:Entry:entry.html.twig',
['entry' => $entry]
2015-01-22 20:11:22 +00:00
);
2015-01-23 11:45:24 +00:00
}
/**
* 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
*/
public function reloadAction(Entry $entry)
{
$this->checkUserAction($entry);
$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()]));
}
$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', ['id' => $entry->getId()]));
}
2015-01-23 11:45:24 +00:00
/**
2015-05-30 11:52:26 +00:00
* Changes read status for an entry.
2015-01-23 11:45:24 +00:00
*
* @param Request $request
* @param Entry $entry
*
2015-01-23 11:45:24 +00:00
* @Route("/archive/{id}", requirements={"id" = "\d+"}, name="archive_entry")
*
2015-01-23 11:45:24 +00:00
* @return \Symfony\Component\HttpFoundation\RedirectResponse
*/
2015-02-06 06:45:32 +00:00
public function toggleArchiveAction(Request $request, Entry $entry)
2015-01-23 11:45:24 +00:00
{
$this->checkUserAction($entry);
2015-01-23 11:45:24 +00:00
$entry->toggleArchive();
$this->getDoctrine()->getManager()->flush();
2016-03-11 13:48:46 +00:00
$message = 'flashes.entry.notice.entry_unarchived';
if ($entry->isArchived()) {
$message = 'flashes.entry.notice.entry_archived';
}
2015-01-23 11:45:24 +00:00
$this->get('session')->getFlashBag()->add(
'notice',
2016-03-11 13:48:46 +00:00
$message
2015-01-23 11:45:24 +00:00
);
$redirectUrl = $this->get('wallabag_core.helper.redirect')->to($request->headers->get('referer'));
return $this->redirect($redirectUrl);
2015-01-23 11:45:24 +00:00
}
/**
2016-08-18 13:30:28 +00:00
* Changes starred status for an entry.
2015-01-23 11:45:24 +00:00
*
* @param Request $request
* @param Entry $entry
*
2015-01-23 11:45:24 +00:00
* @Route("/star/{id}", requirements={"id" = "\d+"}, name="star_entry")
*
2015-01-23 11:45:24 +00:00
* @return \Symfony\Component\HttpFoundation\RedirectResponse
*/
2015-02-06 06:45:32 +00:00
public function toggleStarAction(Request $request, Entry $entry)
2015-01-23 11:45:24 +00:00
{
$this->checkUserAction($entry);
2015-01-23 11:45:24 +00:00
$entry->toggleStar();
$this->getDoctrine()->getManager()->flush();
2016-03-11 13:48:46 +00:00
$message = 'flashes.entry.notice.entry_unstarred';
if ($entry->isStarred()) {
$message = 'flashes.entry.notice.entry_starred';
}
2015-01-23 11:45:24 +00:00
$this->get('session')->getFlashBag()->add(
'notice',
2016-03-11 13:48:46 +00:00
$message
2015-01-23 11:45:24 +00:00
);
$redirectUrl = $this->get('wallabag_core.helper.redirect')->to($request->headers->get('referer'));
return $this->redirect($redirectUrl);
2015-01-23 11:45:24 +00:00
}
/**
* Deletes entry and redirect to the homepage or the last viewed page.
2015-01-23 11:45:24 +00:00
*
2015-08-22 09:40:45 +00:00
* @param Entry $entry
*
2015-01-23 11:45:24 +00:00
* @Route("/delete/{id}", requirements={"id" = "\d+"}, name="delete_entry")
*
2015-01-23 11:45:24 +00:00
* @return \Symfony\Component\HttpFoundation\RedirectResponse
*/
2015-10-21 13:26:37 +00:00
public function deleteEntryAction(Request $request, Entry $entry)
2015-01-23 11:45:24 +00:00
{
$this->checkUserAction($entry);
// generates the view url for this entry to check for redirection later
// to avoid redirecting to the deleted entry. Ugh.
$url = $this->generateUrl(
'view',
['id' => $entry->getId()],
UrlGeneratorInterface::ABSOLUTE_PATH
);
// entry deleted, dispatch event about it!
$this->get('event_dispatcher')->dispatch(EntryDeletedEvent::NAME, new EntryDeletedEvent($entry));
2015-02-20 14:36:25 +00:00
$em = $this->getDoctrine()->getManager();
$em->remove($entry);
$em->flush();
2015-01-23 11:45:24 +00:00
$this->get('session')->getFlashBag()->add(
'notice',
2016-03-11 13:48:46 +00:00
'flashes.entry.notice.entry_deleted'
2015-01-23 11:45:24 +00:00
);
2015-01-22 20:11:22 +00:00
// don't redirect user to the deleted entry (check that the referer doesn't end with the same url)
$referer = $request->headers->get('referer');
2017-07-01 07:52:38 +00:00
$to = (1 !== preg_match('#' . $url . '$#i', $referer) ? $referer : null);
$redirectUrl = $this->get('wallabag_core.helper.redirect')->to($to);
return $this->redirect($redirectUrl);
2015-01-22 20:11:22 +00:00
}
2016-08-23 14:49:12 +00:00
/**
* Get public URL for entry (and generate it if necessary).
*
* @param Entry $entry
*
* @Route("/share/{id}", requirements={"id" = "\d+"}, name="share")
*
* @return \Symfony\Component\HttpFoundation\Response
*/
public function shareAction(Entry $entry)
{
$this->checkUserAction($entry);
2016-12-29 09:09:44 +00:00
if (null === $entry->getUid()) {
$entry->generateUid();
2016-08-24 20:29:36 +00:00
$em = $this->getDoctrine()->getManager();
$em->persist($entry);
$em->flush();
2016-08-23 14:49:12 +00:00
}
return $this->redirect($this->generateUrl('share_entry', [
2016-12-29 09:09:44 +00:00
'uid' => $entry->getUid(),
2016-08-23 14:49:12 +00:00
]));
}
/**
* Disable public sharing for an entry.
*
* @param Entry $entry
*
* @Route("/share/delete/{id}", requirements={"id" = "\d+"}, name="delete_share")
*
* @return \Symfony\Component\HttpFoundation\Response
*/
public function deleteShareAction(Entry $entry)
{
$this->checkUserAction($entry);
2016-12-29 09:09:44 +00:00
$entry->cleanUid();
2016-08-24 20:29:36 +00:00
2016-08-23 14:49:12 +00:00
$em = $this->getDoctrine()->getManager();
$em->persist($entry);
$em->flush();
return $this->redirect($this->generateUrl('view', [
'id' => $entry->getId(),
]));
}
2016-04-10 19:48:11 +00:00
/**
2016-08-24 20:29:36 +00:00
* Ability to view a content publicly.
2016-04-10 15:33:15 +00:00
*
* @param Entry $entry
*
2016-12-29 09:09:44 +00:00
* @Route("/share/{uid}", requirements={"uid" = ".+"}, name="share_entry")
2016-08-24 20:29:36 +00:00
* @Cache(maxage="25200", smaxage="25200", public=true)
2016-04-10 15:33:15 +00:00
*
* @return \Symfony\Component\HttpFoundation\Response
*/
2016-04-10 19:48:11 +00:00
public function shareEntryAction(Entry $entry)
2016-04-10 15:33:15 +00:00
{
2016-08-24 20:29:36 +00:00
if (!$this->get('craue_config')->get('share_public')) {
throw $this->createAccessDeniedException('Sharing an entry is disabled for this user.');
}
2016-04-10 15:33:15 +00:00
return $this->render(
2016-09-30 07:38:08 +00:00
'@WallabagCore/themes/common/Entry/share.html.twig',
2016-08-24 20:29:36 +00:00
['entry' => $entry]
2016-04-10 15:33:15 +00:00
);
}
2016-08-26 14:55:41 +00:00
/**
* Shows untagged articles for current user.
*
* @param Request $request
* @param int $page
*
* @Route("/untagged/list/{page}", name="untagged", defaults={"page" = "1"})
*
* @return \Symfony\Component\HttpFoundation\Response
*/
public function showUntaggedEntriesAction(Request $request, $page)
{
return $this->showEntries('untagged', $request, $page);
}
2017-07-01 07:52:38 +00:00
/**
* 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';
}
$this->get('session')->getFlashBag()->add('notice', $message);
}
/**
* 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 Request $request
* @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);
}
}
return $this->render(
'WallabagCoreBundle:Entry:entries.html.twig', [
'form' => $form->createView(),
'entries' => $entries,
'currentPage' => $page,
'searchTerm' => $searchTerm,
]
);
}
/**
* Check if the logged user can manage the given entry.
*
* @param Entry $entry
*/
private function checkUserAction(Entry $entry)
{
if (null === $this->getUser() || $this->getUser()->getId() !== $entry->getUser()->getId()) {
throw $this->createAccessDeniedException('You can not access this entry.');
}
}
/**
* Check for existing entry, if it exists, redirect to it with a message.
*
* @param Entry $entry
*
* @return Entry|bool
*/
private function checkIfEntryAlreadyExists(Entry $entry)
{
return $this->get('wallabag_core.entry_repository')->findByUrlAndUserId($entry->getUrl(), $this->getUser()->getId());
}
2015-01-22 16:18:56 +00:00
}