]> git.immae.eu Git - github/wallabag/wallabag.git/blob - src/Wallabag/ApiBundle/Controller/EntryRestController.php
Merge pull request #3077 from wallabag/add-tags-list-view
[github/wallabag/wallabag.git] / src / Wallabag / ApiBundle / Controller / EntryRestController.php
1 <?php
2
3 namespace Wallabag\ApiBundle\Controller;
4
5 use Hateoas\Configuration\Route;
6 use Hateoas\Representation\Factory\PagerfantaFactory;
7 use Nelmio\ApiDocBundle\Annotation\ApiDoc;
8 use Symfony\Component\HttpKernel\Exception\HttpException;
9 use Symfony\Component\HttpFoundation\Request;
10 use Symfony\Component\HttpFoundation\JsonResponse;
11 use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
12 use Wallabag\CoreBundle\Entity\Entry;
13 use Wallabag\CoreBundle\Entity\Tag;
14 use Wallabag\CoreBundle\Event\EntrySavedEvent;
15 use Wallabag\CoreBundle\Event\EntryDeletedEvent;
16
17 class EntryRestController extends WallabagRestController
18 {
19 /**
20 * Check if an entry exist by url.
21 *
22 * @ApiDoc(
23 * parameters={
24 * {"name"="url", "dataType"="string", "required"=true, "format"="An url", "description"="Url to check if it exists"},
25 * {"name"="urls", "dataType"="string", "required"=false, "format"="An array of urls (?urls[]=http...&urls[]=http...)", "description"="Urls (as an array) to check if it exists"}
26 * }
27 * )
28 *
29 * @return JsonResponse
30 */
31 public function getEntriesExistsAction(Request $request)
32 {
33 $this->validateAuthentication();
34
35 $urls = $request->query->get('urls', []);
36
37 // handle multiple urls first
38 if (!empty($urls)) {
39 $results = [];
40 foreach ($urls as $url) {
41 $res = $this->getDoctrine()
42 ->getRepository('WallabagCoreBundle:Entry')
43 ->findByUrlAndUserId($url, $this->getUser()->getId());
44
45 $results[$url] = $res instanceof Entry ? $res->getId() : false;
46 }
47
48 return $this->sendResponse($results);
49 }
50
51 // let's see if it is a simple url?
52 $url = $request->query->get('url', '');
53
54 if (empty($url)) {
55 throw $this->createAccessDeniedException('URL is empty?, logged user id: '.$this->getUser()->getId());
56 }
57
58 $res = $this->getDoctrine()
59 ->getRepository('WallabagCoreBundle:Entry')
60 ->findByUrlAndUserId($url, $this->getUser()->getId());
61
62 $exists = $res instanceof Entry ? $res->getId() : false;
63
64 return $this->sendResponse(['exists' => $exists]);
65 }
66
67 /**
68 * Retrieve all entries. It could be filtered by many options.
69 *
70 * @ApiDoc(
71 * parameters={
72 * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0, all entries by default", "description"="filter by archived status."},
73 * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0, all entries by default", "description"="filter by starred status."},
74 * {"name"="sort", "dataType"="string", "required"=false, "format"="'created' or 'updated', default 'created'", "description"="sort entries by date."},
75 * {"name"="order", "dataType"="string", "required"=false, "format"="'asc' or 'desc', default 'desc'", "description"="order of sort."},
76 * {"name"="page", "dataType"="integer", "required"=false, "format"="default '1'", "description"="what page you want."},
77 * {"name"="perPage", "dataType"="integer", "required"=false, "format"="default'30'", "description"="results per page."},
78 * {"name"="tags", "dataType"="string", "required"=false, "format"="api,rest", "description"="a list of tags url encoded. Will returns entries that matches ALL tags."},
79 * {"name"="since", "dataType"="integer", "required"=false, "format"="default '0'", "description"="The timestamp since when you want entries updated."},
80 * }
81 * )
82 *
83 * @return JsonResponse
84 */
85 public function getEntriesAction(Request $request)
86 {
87 $this->validateAuthentication();
88
89 $isArchived = (null === $request->query->get('archive')) ? null : (bool) $request->query->get('archive');
90 $isStarred = (null === $request->query->get('starred')) ? null : (bool) $request->query->get('starred');
91 $sort = $request->query->get('sort', 'created');
92 $order = $request->query->get('order', 'desc');
93 $page = (int) $request->query->get('page', 1);
94 $perPage = (int) $request->query->get('perPage', 30);
95 $tags = $request->query->get('tags', '');
96 $since = $request->query->get('since', 0);
97
98 /** @var \Pagerfanta\Pagerfanta $pager */
99 $pager = $this->getDoctrine()
100 ->getRepository('WallabagCoreBundle:Entry')
101 ->findEntries($this->getUser()->getId(), $isArchived, $isStarred, $sort, $order, $since, $tags);
102
103 $pager->setMaxPerPage($perPage);
104 $pager->setCurrentPage($page);
105
106 $pagerfantaFactory = new PagerfantaFactory('page', 'perPage');
107 $paginatedCollection = $pagerfantaFactory->createRepresentation(
108 $pager,
109 new Route(
110 'api_get_entries',
111 [
112 'archive' => $isArchived,
113 'starred' => $isStarred,
114 'sort' => $sort,
115 'order' => $order,
116 'page' => $page,
117 'perPage' => $perPage,
118 'tags' => $tags,
119 'since' => $since,
120 ],
121 UrlGeneratorInterface::ABSOLUTE_URL
122 )
123 );
124
125 return $this->sendResponse($paginatedCollection);
126 }
127
128 /**
129 * Retrieve a single entry.
130 *
131 * @ApiDoc(
132 * requirements={
133 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
134 * }
135 * )
136 *
137 * @return JsonResponse
138 */
139 public function getEntryAction(Entry $entry)
140 {
141 $this->validateAuthentication();
142 $this->validateUserAccess($entry->getUser()->getId());
143
144 return $this->sendResponse($entry);
145 }
146
147 /**
148 * Retrieve a single entry as a predefined format.
149 *
150 * @ApiDoc(
151 * requirements={
152 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
153 * }
154 * )
155 *
156 * @return Response
157 */
158 public function getEntryExportAction(Entry $entry, Request $request)
159 {
160 $this->validateAuthentication();
161 $this->validateUserAccess($entry->getUser()->getId());
162
163 return $this->get('wallabag_core.helper.entries_export')
164 ->setEntries($entry)
165 ->updateTitle('entry')
166 ->exportAs($request->attributes->get('_format'));
167 }
168
169 /**
170 * Handles an entries list and delete URL.
171 *
172 * @ApiDoc(
173 * parameters={
174 * {"name"="urls", "dataType"="string", "required"=true, "format"="A JSON array of urls [{'url': 'http://...'}, {'url': 'http://...'}]", "description"="Urls (as an array) to delete."}
175 * }
176 * )
177 *
178 * @return JsonResponse
179 */
180 public function deleteEntriesListAction(Request $request)
181 {
182 $this->validateAuthentication();
183
184 $urls = json_decode($request->query->get('urls', []));
185
186 if (empty($urls)) {
187 return $this->sendResponse([]);
188 }
189
190 $results = [];
191
192 // handle multiple urls
193 foreach ($urls as $key => $url) {
194 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
195 $url,
196 $this->getUser()->getId()
197 );
198
199 $results[$key]['url'] = $url;
200
201 if (false !== $entry) {
202 $em = $this->getDoctrine()->getManager();
203 $em->remove($entry);
204 $em->flush();
205
206 // entry deleted, dispatch event about it!
207 $this->get('event_dispatcher')->dispatch(EntryDeletedEvent::NAME, new EntryDeletedEvent($entry));
208 }
209
210 $results[$key]['entry'] = $entry instanceof Entry ? true : false;
211 }
212
213 return $this->sendResponse($results);
214 }
215
216 /**
217 * Handles an entries list and create URL.
218 *
219 * @ApiDoc(
220 * parameters={
221 * {"name"="urls", "dataType"="string", "required"=true, "format"="A JSON array of urls [{'url': 'http://...'}, {'url': 'http://...'}]", "description"="Urls (as an array) to create."}
222 * }
223 * )
224 *
225 * @return JsonResponse
226 *
227 * @throws HttpException When limit is reached
228 */
229 public function postEntriesListAction(Request $request)
230 {
231 $this->validateAuthentication();
232
233 $urls = json_decode($request->query->get('urls', []));
234 $results = [];
235
236 $limit = $this->container->getParameter('wallabag_core.api_limit_mass_actions');
237
238 if (count($urls) > $limit) {
239 throw new HttpException(400, 'API limit reached');
240 }
241
242 // handle multiple urls
243 if (!empty($urls)) {
244 foreach ($urls as $key => $url) {
245 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
246 $url,
247 $this->getUser()->getId()
248 );
249
250 $results[$key]['url'] = $url;
251
252 if (false === $entry) {
253 $entry = $this->get('wallabag_core.content_proxy')->updateEntry(
254 new Entry($this->getUser()),
255 $url
256 );
257 }
258
259 $em = $this->getDoctrine()->getManager();
260 $em->persist($entry);
261 $em->flush();
262
263 $results[$key]['entry'] = $entry instanceof Entry ? $entry->getId() : false;
264
265 // entry saved, dispatch event about it!
266 $this->get('event_dispatcher')->dispatch(EntrySavedEvent::NAME, new EntrySavedEvent($entry));
267 }
268 }
269
270 return $this->sendResponse($results);
271 }
272
273 /**
274 * Create an entry.
275 *
276 * If you want to provide the HTML content (which means wallabag won't fetch it from the url), you must provide `content`, `title` & `url` fields **non-empty**.
277 * Otherwise, content will be fetched as normal from the url and values will be overwritten.
278 *
279 * @ApiDoc(
280 * parameters={
281 * {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."},
282 * {"name"="title", "dataType"="string", "required"=false, "description"="Optional, we'll get the title from the page."},
283 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
284 * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already starred"},
285 * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already archived"},
286 * {"name"="content", "dataType"="string", "required"=false, "description"="Content of the entry"},
287 * {"name"="language", "dataType"="string", "required"=false, "description"="Language of the entry"},
288 * {"name"="preview_picture", "dataType"="string", "required"=false, "description"="Preview picture of the entry"},
289 * {"name"="published_at", "dataType"="datetime|integer", "format"="YYYY-MM-DDTHH:II:SS+TZ or a timestamp", "required"=false, "description"="Published date of the entry"},
290 * {"name"="authors", "dataType"="string", "format"="Name Firstname,author2,author3", "required"=false, "description"="Authors of the entry"},
291 * }
292 * )
293 *
294 * @return JsonResponse
295 */
296 public function postEntriesAction(Request $request)
297 {
298 $this->validateAuthentication();
299
300 $url = $request->request->get('url');
301 $title = $request->request->get('title');
302 $tags = $request->request->get('tags', []);
303 $isArchived = $request->request->get('archive');
304 $isStarred = $request->request->get('starred');
305 $content = $request->request->get('content');
306 $language = $request->request->get('language');
307 $picture = $request->request->get('preview_picture');
308 $publishedAt = $request->request->get('published_at');
309 $authors = $request->request->get('authors', '');
310
311 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId($url, $this->getUser()->getId());
312
313 if (false === $entry) {
314 $entry = new Entry($this->getUser());
315 }
316
317 try {
318 $entry = $this->get('wallabag_core.content_proxy')->updateEntry(
319 $entry,
320 $url,
321 [
322 'title' => $title,
323 'html' => $content,
324 'url' => $url,
325 'language' => $language,
326 'date' => $publishedAt,
327 // faking the preview picture
328 'open_graph' => [
329 'og_image' => $picture,
330 ],
331 'authors' => explode(',', $authors),
332 ]
333 );
334 } catch (\Exception $e) {
335 $this->get('logger')->error('Error while saving an entry', [
336 'exception' => $e,
337 'entry' => $entry,
338 ]);
339 $entry->setUrl($url);
340 }
341
342 if (!empty($tags)) {
343 $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $tags);
344 }
345
346 if (!is_null($isStarred)) {
347 $entry->setStarred((bool) $isStarred);
348 }
349
350 if (!is_null($isArchived)) {
351 $entry->setArchived((bool) $isArchived);
352 }
353
354 $em = $this->getDoctrine()->getManager();
355 $em->persist($entry);
356 $em->flush();
357
358 // entry saved, dispatch event about it!
359 $this->get('event_dispatcher')->dispatch(EntrySavedEvent::NAME, new EntrySavedEvent($entry));
360
361 return $this->sendResponse($entry);
362 }
363
364 /**
365 * Change several properties of an entry.
366 *
367 * @ApiDoc(
368 * requirements={
369 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
370 * },
371 * parameters={
372 * {"name"="title", "dataType"="string", "required"=false},
373 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
374 * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="archived the entry."},
375 * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="starred the entry."},
376 * }
377 * )
378 *
379 * @return JsonResponse
380 */
381 public function patchEntriesAction(Entry $entry, Request $request)
382 {
383 $this->validateAuthentication();
384 $this->validateUserAccess($entry->getUser()->getId());
385
386 $title = $request->request->get('title');
387 $isArchived = $request->request->get('archive');
388 $isStarred = $request->request->get('starred');
389
390 if (!is_null($title)) {
391 $entry->setTitle($title);
392 }
393
394 if (!is_null($isArchived)) {
395 $entry->setArchived((bool) $isArchived);
396 }
397
398 if (!is_null($isStarred)) {
399 $entry->setStarred((bool) $isStarred);
400 }
401
402 $tags = $request->request->get('tags', '');
403 if (!empty($tags)) {
404 $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $tags);
405 }
406
407 $em = $this->getDoctrine()->getManager();
408 $em->flush();
409
410 return $this->sendResponse($entry);
411 }
412
413 /**
414 * Reload an entry.
415 * An empty response with HTTP Status 304 will be send if we weren't able to update the content (because it hasn't changed or we got an error).
416 *
417 * @ApiDoc(
418 * requirements={
419 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
420 * }
421 * )
422 *
423 * @return JsonResponse
424 */
425 public function patchEntriesReloadAction(Entry $entry)
426 {
427 $this->validateAuthentication();
428 $this->validateUserAccess($entry->getUser()->getId());
429
430 try {
431 $entry = $this->get('wallabag_core.content_proxy')->updateEntry($entry, $entry->getUrl());
432 } catch (\Exception $e) {
433 $this->get('logger')->error('Error while saving an entry', [
434 'exception' => $e,
435 'entry' => $entry,
436 ]);
437
438 return new JsonResponse([], 304);
439 }
440
441 // if refreshing entry failed, don't save it
442 if ($this->getParameter('wallabag_core.fetching_error_message') === $entry->getContent()) {
443 return new JsonResponse([], 304);
444 }
445
446 $em = $this->getDoctrine()->getManager();
447 $em->persist($entry);
448 $em->flush();
449
450 // entry saved, dispatch event about it!
451 $this->get('event_dispatcher')->dispatch(EntrySavedEvent::NAME, new EntrySavedEvent($entry));
452
453 return $this->sendResponse($entry);
454 }
455
456 /**
457 * Delete **permanently** an entry.
458 *
459 * @ApiDoc(
460 * requirements={
461 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
462 * }
463 * )
464 *
465 * @return JsonResponse
466 */
467 public function deleteEntriesAction(Entry $entry)
468 {
469 $this->validateAuthentication();
470 $this->validateUserAccess($entry->getUser()->getId());
471
472 $em = $this->getDoctrine()->getManager();
473 $em->remove($entry);
474 $em->flush();
475
476 // entry deleted, dispatch event about it!
477 $this->get('event_dispatcher')->dispatch(EntryDeletedEvent::NAME, new EntryDeletedEvent($entry));
478
479 return $this->sendResponse($entry);
480 }
481
482 /**
483 * Retrieve all tags for an entry.
484 *
485 * @ApiDoc(
486 * requirements={
487 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
488 * }
489 * )
490 *
491 * @return JsonResponse
492 */
493 public function getEntriesTagsAction(Entry $entry)
494 {
495 $this->validateAuthentication();
496 $this->validateUserAccess($entry->getUser()->getId());
497
498 return $this->sendResponse($entry->getTags());
499 }
500
501 /**
502 * Add one or more tags to an entry.
503 *
504 * @ApiDoc(
505 * requirements={
506 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
507 * },
508 * parameters={
509 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
510 * }
511 * )
512 *
513 * @return JsonResponse
514 */
515 public function postEntriesTagsAction(Request $request, Entry $entry)
516 {
517 $this->validateAuthentication();
518 $this->validateUserAccess($entry->getUser()->getId());
519
520 $tags = $request->request->get('tags', '');
521 if (!empty($tags)) {
522 $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $tags);
523 }
524
525 $em = $this->getDoctrine()->getManager();
526 $em->persist($entry);
527 $em->flush();
528
529 return $this->sendResponse($entry);
530 }
531
532 /**
533 * Permanently remove one tag for an entry.
534 *
535 * @ApiDoc(
536 * requirements={
537 * {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag ID"},
538 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
539 * }
540 * )
541 *
542 * @return JsonResponse
543 */
544 public function deleteEntriesTagsAction(Entry $entry, Tag $tag)
545 {
546 $this->validateAuthentication();
547 $this->validateUserAccess($entry->getUser()->getId());
548
549 $entry->removeTag($tag);
550 $em = $this->getDoctrine()->getManager();
551 $em->persist($entry);
552 $em->flush();
553
554 return $this->sendResponse($entry);
555 }
556
557 /**
558 * Handles an entries list delete tags from them.
559 *
560 * @ApiDoc(
561 * parameters={
562 * {"name"="list", "dataType"="string", "required"=true, "format"="A JSON array of urls [{'url': 'http://...','tags': 'tag1, tag2'}, {'url': 'http://...','tags': 'tag1, tag2'}]", "description"="Urls (as an array) to handle."}
563 * }
564 * )
565 *
566 * @return JsonResponse
567 */
568 public function deleteEntriesTagsListAction(Request $request)
569 {
570 $this->validateAuthentication();
571
572 $list = json_decode($request->query->get('list', []));
573
574 if (empty($list)) {
575 return $this->sendResponse([]);
576 }
577
578 // handle multiple urls
579 $results = [];
580
581 foreach ($list as $key => $element) {
582 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
583 $element->url,
584 $this->getUser()->getId()
585 );
586
587 $results[$key]['url'] = $element->url;
588 $results[$key]['entry'] = $entry instanceof Entry ? $entry->getId() : false;
589
590 $tags = $element->tags;
591
592 if (false !== $entry && !(empty($tags))) {
593 $tags = explode(',', $tags);
594 foreach ($tags as $label) {
595 $label = trim($label);
596
597 $tag = $this->getDoctrine()
598 ->getRepository('WallabagCoreBundle:Tag')
599 ->findOneByLabel($label);
600
601 if (false !== $tag) {
602 $entry->removeTag($tag);
603 }
604 }
605
606 $em = $this->getDoctrine()->getManager();
607 $em->persist($entry);
608 $em->flush();
609 }
610 }
611
612 return $this->sendResponse($results);
613 }
614
615 /**
616 * Handles an entries list and add tags to them.
617 *
618 * @ApiDoc(
619 * parameters={
620 * {"name"="list", "dataType"="string", "required"=true, "format"="A JSON array of urls [{'url': 'http://...','tags': 'tag1, tag2'}, {'url': 'http://...','tags': 'tag1, tag2'}]", "description"="Urls (as an array) to handle."}
621 * }
622 * )
623 *
624 * @return JsonResponse
625 */
626 public function postEntriesTagsListAction(Request $request)
627 {
628 $this->validateAuthentication();
629
630 $list = json_decode($request->query->get('list', []));
631
632 if (empty($list)) {
633 return $this->sendResponse([]);
634 }
635
636 $results = [];
637
638 // handle multiple urls
639 foreach ($list as $key => $element) {
640 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
641 $element->url,
642 $this->getUser()->getId()
643 );
644
645 $results[$key]['url'] = $element->url;
646 $results[$key]['entry'] = $entry instanceof Entry ? $entry->getId() : false;
647
648 $tags = $element->tags;
649
650 if (false !== $entry && !(empty($tags))) {
651 $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $tags);
652
653 $em = $this->getDoctrine()->getManager();
654 $em->persist($entry);
655 $em->flush();
656 }
657 }
658
659 return $this->sendResponse($results);
660 }
661
662 /**
663 * Shortcut to send data serialized in json.
664 *
665 * @param mixed $data
666 *
667 * @return JsonResponse
668 */
669 private function sendResponse($data)
670 {
671 $json = $this->get('serializer')->serialize($data, 'json');
672
673 return (new JsonResponse())->setJson($json);
674 }
675 }