3 namespace Wallabag\CoreBundle\Controller
;
5 use Nelmio\ApiDocBundle\Annotation\ApiDoc
;
6 use Symfony\Bundle\FrameworkBundle\Controller\Controller
;
7 use Symfony\Component\HttpFoundation\Request
;
8 use Symfony\Component\HttpFoundation\Response
;
9 use Wallabag\CoreBundle\Entity\Entry
;
10 use Wallabag\CoreBundle\Entity\Tag
;
11 use Wallabag\CoreBundle\Service\Extractor
;
12 use Symfony\Component\Security\Core\Exception\AccessDeniedException
;
14 class WallabagRestController
extends Controller
20 private function assignTagsToEntry(Entry
$entry, $tags)
22 foreach (explode(',', $tags) as $label) {
23 $label = trim($label);
26 ->getRepository('WallabagCoreBundle:Tag')
27 ->findOneByLabel($label);
29 if (is_null($tagEntity)) {
30 $tagEntity = new Tag($this->getUser());
31 $tagEntity->setLabel($label);
34 // only add the tag on the entry if the relation doesn't exist
35 if (!$entry->getTags()->contains($tagEntity)) {
36 $entry->addTag($tagEntity);
42 * Retrieve salt for a giver user.
46 * {"name"="username", "dataType"="string", "required"=true, "description"="username"}
51 public function getSaltAction($username)
55 ->getRepository('WallabagCoreBundle:User')
56 ->findOneByUsername($username);
59 throw $this->createNotFoundException();
62 return array($user->getSalt() ?: null);
65 * Retrieve all entries. It could be filtered by many options.
69 * {"name"="archive", "dataType"="boolean", "required"=false, "format"="true or false, all entries by default", "description"="filter by archived status."},
70 * {"name"="star", "dataType"="boolean", "required"=false, "format"="true or false, all entries by default", "description"="filter by starred status."},
71 * {"name"="sort", "dataType"="string", "required"=false, "format"="'created' or 'updated', default 'created'", "description"="sort entries by date."},
72 * {"name"="order", "dataType"="string", "required"=false, "format"="'asc' or 'desc', default 'desc'", "description"="order of sort."},
73 * {"name"="page", "dataType"="integer", "required"=false, "format"="default '1'", "description"="what page you want."},
74 * {"name"="perPage", "dataType"="integer", "required"=false, "format"="default'30'", "description"="results per page."},
75 * {"name"="tags", "dataType"="string", "required"=false, "format"="api%2Crest", "description"="a list of tags url encoded. Will returns entries that matches ALL tags."},
80 public function getEntriesAction(Request
$request)
82 $isArchived = $request->query
->get('archive');
83 $isStarred = $request->query
->get('star');
84 $sort = $request->query
->get('sort', 'created');
85 $order = $request->query
->get('order', 'desc');
86 $page = $request->query
->get('page', 1);
87 $perPage = $request->query
->get('perPage', 30);
88 $tags = $request->query
->get('tags', array());
92 ->getRepository('WallabagCoreBundle:Entry')
93 ->findEntries($this->getUser()->getId(), $isArchived, $isStarred, $sort, $order);
96 throw $this->createNotFoundException();
99 $json = $this->get('serializer')->serialize($entries, 'json');
101 return new Response($json, 200, array('application/json'));
105 * Retrieve a single entry
109 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
114 public function getEntryAction(Entry
$entry)
116 if ($entry->getUser()->getId() != $this->getUser()->getId()) {
117 throw $this->createAccessDeniedException();
120 $json = $this->get('serializer')->serialize($entry, 'json');
122 return new Response($json, 200, array('application/json'));
130 * {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."},
131 * {"name"="title", "dataType"="string", "required"=false, "description"="Optional, we'll get the title from the page."},
132 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
137 public function postEntriesAction(Request
$request)
139 $url = $request->request
->get('url');
141 $content = Extractor
::extract($url);
142 $entry = new Entry($this->getUser());
143 $entry->setUrl($url);
144 $entry->setTitle($request->request
->get('title') ?: $content->getTitle());
145 $entry->setContent($content->getBody());
147 $this->assignTagsToEntry($entry, $request->request
->get('tags', array()));
149 $em = $this->getDoctrine()->getManager();
150 $em->persist($entry);
153 $json = $this->get('serializer')->serialize($entry, 'json');
155 return new Response($json, 200, array('application/json'));
159 * Change several properties of an entry
163 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
166 * {"name"="title", "dataType"="string", "required"=false},
167 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
168 * {"name"="archive", "dataType"="boolean", "required"=false, "format"="true or false", "description"="archived the entry."},
169 * {"name"="star", "dataType"="boolean", "required"=false, "format"="true or false", "description"="starred the entry."},
174 public function patchEntriesAction(Entry
$entry, Request
$request)
176 if ($entry->getUser()->getId() != $this->getUser()->getId()) {
177 throw $this->createAccessDeniedException();
180 $title = $request->request
->get("title");
181 $isArchived = $request->request
->get("archive");
182 $isStarred = $request->request
->get("star");
184 if (!is_null($title)) {
185 $entry->setTitle($title);
188 if (!is_null($isArchived)) {
189 $entry->setArchived($isArchived);
192 if (!is_null($isStarred)) {
193 $entry->setStarred($isStarred);
196 $this->assignTagsToEntry($entry, $request->request
->get('tags', array()));
198 $em = $this->getDoctrine()->getManager();
205 * Delete **permanently** an entry
209 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
214 public function deleteEntriesAction(Entry
$entry)
216 if ($entry->getUser()->getId() != $this->getUser()->getId()) {
217 throw $this->createAccessDeniedException();
220 $em = $this->getDoctrine()->getManager();
224 $json = $this->get('serializer')->serialize($entry, 'json');
226 return new Response($json, 200, array('application/json'));
230 * Retrieve all tags for an entry
234 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
238 public function getEntriesTagsAction(Entry
$entry)
240 if ($entry->getUser()->getId() != $this->getUser()->getId()) {
241 throw $this->createAccessDeniedException();
244 $json = $this->get('serializer')->serialize($entry->getTags(), 'json');
246 return new Response($json, 200, array('application/json'));
250 * Add one or more tags to an entry
254 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
257 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
261 public function postEntriesTagsAction(Request
$request, Entry
$entry)
263 if ($entry->getUser()->getId() != $this->getUser()->getId()) {
264 throw $this->createAccessDeniedException();
267 $this->assignTagsToEntry($entry, $request->request
->get('tags', array()));
269 $em = $this->getDoctrine()->getManager();
270 $em->persist($entry);
273 $json = $this->get('serializer')->serialize($entry, 'json');
275 return new Response($json, 200, array('application/json'));
279 * Permanently remove one tag for an entry
283 * {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"},
284 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
288 public function deleteEntriesTagsAction(Entry
$entry, Tag
$tag)
290 if ($entry->getUser()->getId() != $this->getUser()->getId()) {
291 throw $this->createAccessDeniedException();
294 $entry->removeTag($tag);
295 $em = $this->getDoctrine()->getManager();
296 $em->persist($entry);
299 $json = $this->get('serializer')->serialize($entry, 'json');
301 return new Response($json, 200, array('application/json'));
309 public function getTagsAction()
311 $json = $this->get('serializer')->serialize($this->getUser()->getTags(), 'json');
313 return new Response($json, 200, array('application/json'));
317 * Permanently remove one tag from **every** entry
321 * {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"}
325 public function deleteTagAction(Tag
$tag)
327 if ($tag->getUser()->getId() != $this->getUser()->getId()) {
328 throw $this->createAccessDeniedException();
331 $em = $this->getDoctrine()->getManager();
335 $json = $this->get('serializer')->serialize($tag, 'json');
337 return new Response($json, 200, array('application/json'));