]> git.immae.eu Git - github/wallabag/wallabag.git/blame - src/Wallabag/ApiBundle/Controller/EntryRestController.php
Merge remote-tracking branch 'origin/master' into 2.3
[github/wallabag/wallabag.git] / src / Wallabag / ApiBundle / Controller / EntryRestController.php
CommitLineData
900c8448
NL
1<?php
2
3namespace Wallabag\ApiBundle\Controller;
4
5use Hateoas\Configuration\Route;
6use Hateoas\Representation\Factory\PagerfantaFactory;
7use Nelmio\ApiDocBundle\Annotation\ApiDoc;
72db15ca 8use Symfony\Component\HttpKernel\Exception\HttpException;
900c8448
NL
9use Symfony\Component\HttpFoundation\Request;
10use Symfony\Component\HttpFoundation\JsonResponse;
11use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
12use Wallabag\CoreBundle\Entity\Entry;
13use Wallabag\CoreBundle\Entity\Tag;
5a619812
JB
14use Wallabag\CoreBundle\Event\EntrySavedEvent;
15use Wallabag\CoreBundle\Event\EntryDeletedEvent;
900c8448
NL
16
17class 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
ca9a83ee 45 $results[$url] = $res instanceof Entry ? $res->getId() : false;
900c8448
NL
46 }
47
72db15ca 48 return $this->sendResponse($results);
900c8448
NL
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
ca9a83ee 62 $exists = $res instanceof Entry ? $res->getId() : false;
900c8448 63
72db15ca 64 return $this->sendResponse(['exists' => $exists]);
900c8448
NL
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
b60a666d 98 /** @var \Pagerfanta\Pagerfanta $pager */
900c8448
NL
99 $pager = $this->getDoctrine()
100 ->getRepository('WallabagCoreBundle:Entry')
101 ->findEntries($this->getUser()->getId(), $isArchived, $isStarred, $sort, $order, $since, $tags);
102
900c8448 103 $pager->setMaxPerPage($perPage);
b60a666d 104 $pager->setCurrentPage($page);
900c8448
NL
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
72db15ca 125 return $this->sendResponse($paginatedCollection);
900c8448
NL
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
72db15ca 144 return $this->sendResponse($entry);
900c8448
NL
145 }
146
864c1dd2
JB
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
1eca7831 169 /**
a7abcc7b 170 * Handles an entries list and delete URL.
1eca7831
NL
171 *
172 * @ApiDoc(
173 * parameters={
a7abcc7b 174 * {"name"="urls", "dataType"="string", "required"=true, "format"="A JSON array of urls [{'url': 'http://...'}, {'url': 'http://...'}]", "description"="Urls (as an array) to delete."}
1eca7831
NL
175 * }
176 * )
177 *
178 * @return JsonResponse
179 */
a7abcc7b 180 public function deleteEntriesListAction(Request $request)
1eca7831
NL
181 {
182 $this->validateAuthentication();
183
a7abcc7b 184 $urls = json_decode($request->query->get('urls', []));
72db15ca
JB
185
186 if (empty($urls)) {
187 return $this->sendResponse([]);
188 }
189
1eca7831
NL
190 $results = [];
191
192 // handle multiple urls
72db15ca
JB
193 foreach ($urls as $key => $url) {
194 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
195 $url,
196 $this->getUser()->getId()
197 );
a7abcc7b 198
72db15ca 199 $results[$key]['url'] = $url;
a7abcc7b 200
72db15ca
JB
201 if (false !== $entry) {
202 $em = $this->getDoctrine()->getManager();
203 $em->remove($entry);
204 $em->flush();
1eca7831 205
72db15ca
JB
206 // entry deleted, dispatch event about it!
207 $this->get('event_dispatcher')->dispatch(EntryDeletedEvent::NAME, new EntryDeletedEvent($entry));
a7abcc7b 208 }
1eca7831 209
72db15ca
JB
210 $results[$key]['entry'] = $entry instanceof Entry ? true : false;
211 }
1eca7831 212
72db15ca 213 return $this->sendResponse($results);
a7abcc7b 214 }
1eca7831 215
a7abcc7b
NL
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
efd351c9 226 *
72db15ca 227 * @throws HttpException When limit is reached
a7abcc7b
NL
228 */
229 public function postEntriesListAction(Request $request)
230 {
231 $this->validateAuthentication();
1eca7831 232
a7abcc7b
NL
233 $urls = json_decode($request->query->get('urls', []));
234 $results = [];
1eca7831 235
efd351c9
NL
236 $limit = $this->container->getParameter('wallabag_core.api_limit_mass_actions');
237
238 if (count($urls) > $limit) {
72db15ca 239 throw new HttpException(400, 'API limit reached');
efd351c9
NL
240 }
241
a7abcc7b
NL
242 // handle multiple urls
243 if (!empty($urls)) {
a7abcc7b
NL
244 foreach ($urls as $key => $url) {
245 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
246 $url,
247 $this->getUser()->getId()
248 );
1eca7831 249
a7abcc7b 250 $results[$key]['url'] = $url;
1eca7831 251
a7abcc7b
NL
252 if (false === $entry) {
253 $entry = $this->get('wallabag_core.content_proxy')->updateEntry(
254 new Entry($this->getUser()),
255 $url
256 );
1eca7831 257 }
a7abcc7b
NL
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));
1eca7831
NL
267 }
268 }
269
72db15ca 270 return $this->sendResponse($results);
1eca7831
NL
271 }
272
900c8448
NL
273 /**
274 * Create an entry.
275 *
276 * @ApiDoc(
277 * parameters={
278 * {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."},
279 * {"name"="title", "dataType"="string", "required"=false, "description"="Optional, we'll get the title from the page."},
280 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
281 * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already starred"},
282 * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already archived"},
283 * }
284 * )
285 *
286 * @return JsonResponse
287 */
288 public function postEntriesAction(Request $request)
289 {
290 $this->validateAuthentication();
291
292 $url = $request->request->get('url');
293 $title = $request->request->get('title');
294 $isArchived = $request->request->get('archive');
295 $isStarred = $request->request->get('starred');
296
297 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId($url, $this->getUser()->getId());
298
299 if (false === $entry) {
300 $entry = $this->get('wallabag_core.content_proxy')->updateEntry(
301 new Entry($this->getUser()),
302 $url
303 );
304 }
305
306 if (!is_null($title)) {
307 $entry->setTitle($title);
308 }
309
310 $tags = $request->request->get('tags', '');
311 if (!empty($tags)) {
312 $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
313 }
314
315 if (!is_null($isStarred)) {
316 $entry->setStarred((bool) $isStarred);
317 }
318
319 if (!is_null($isArchived)) {
320 $entry->setArchived((bool) $isArchived);
321 }
322
323 $em = $this->getDoctrine()->getManager();
324 $em->persist($entry);
900c8448
NL
325 $em->flush();
326
5a619812
JB
327 // entry saved, dispatch event about it!
328 $this->get('event_dispatcher')->dispatch(EntrySavedEvent::NAME, new EntrySavedEvent($entry));
329
72db15ca 330 return $this->sendResponse($entry);
900c8448
NL
331 }
332
333 /**
334 * Change several properties of an entry.
335 *
336 * @ApiDoc(
337 * requirements={
338 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
339 * },
340 * parameters={
341 * {"name"="title", "dataType"="string", "required"=false},
342 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
343 * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="archived the entry."},
344 * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="starred the entry."},
345 * }
346 * )
347 *
348 * @return JsonResponse
349 */
350 public function patchEntriesAction(Entry $entry, Request $request)
351 {
352 $this->validateAuthentication();
353 $this->validateUserAccess($entry->getUser()->getId());
354
355 $title = $request->request->get('title');
356 $isArchived = $request->request->get('archive');
357 $isStarred = $request->request->get('starred');
358
359 if (!is_null($title)) {
360 $entry->setTitle($title);
361 }
362
363 if (!is_null($isArchived)) {
364 $entry->setArchived((bool) $isArchived);
365 }
366
367 if (!is_null($isStarred)) {
368 $entry->setStarred((bool) $isStarred);
369 }
370
371 $tags = $request->request->get('tags', '');
372 if (!empty($tags)) {
373 $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
374 }
375
376 $em = $this->getDoctrine()->getManager();
377 $em->flush();
378
72db15ca 379 return $this->sendResponse($entry);
900c8448
NL
380 }
381
0a6f4568
JB
382 /**
383 * Reload an entry.
5cd0857e 384 * 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).
0a6f4568
JB
385 *
386 * @ApiDoc(
387 * requirements={
388 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
389 * }
390 * )
391 *
392 * @return JsonResponse
393 */
394 public function patchEntriesReloadAction(Entry $entry)
395 {
396 $this->validateAuthentication();
397 $this->validateUserAccess($entry->getUser()->getId());
398
0a6f4568
JB
399 try {
400 $entry = $this->get('wallabag_core.content_proxy')->updateEntry($entry, $entry->getUrl());
401 } catch (\Exception $e) {
402 $this->get('logger')->error('Error while saving an entry', [
403 'exception' => $e,
404 'entry' => $entry,
405 ]);
406
5cd0857e 407 return new JsonResponse([], 304);
0a6f4568
JB
408 }
409
410 // if refreshing entry failed, don't save it
411 if ($this->getParameter('wallabag_core.fetching_error_message') === $entry->getContent()) {
5cd0857e 412 return new JsonResponse([], 304);
0a6f4568
JB
413 }
414
415 $em = $this->getDoctrine()->getManager();
416 $em->persist($entry);
417 $em->flush();
418
419 // entry saved, dispatch event about it!
420 $this->get('event_dispatcher')->dispatch(EntrySavedEvent::NAME, new EntrySavedEvent($entry));
421
72db15ca 422 return $this->sendResponse($entry);
0a6f4568
JB
423 }
424
900c8448
NL
425 /**
426 * Delete **permanently** an entry.
427 *
428 * @ApiDoc(
429 * requirements={
430 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
431 * }
432 * )
433 *
434 * @return JsonResponse
435 */
436 public function deleteEntriesAction(Entry $entry)
437 {
438 $this->validateAuthentication();
439 $this->validateUserAccess($entry->getUser()->getId());
440
441 $em = $this->getDoctrine()->getManager();
442 $em->remove($entry);
443 $em->flush();
444
5a619812
JB
445 // entry deleted, dispatch event about it!
446 $this->get('event_dispatcher')->dispatch(EntryDeletedEvent::NAME, new EntryDeletedEvent($entry));
447
72db15ca 448 return $this->sendResponse($entry);
900c8448
NL
449 }
450
451 /**
452 * Retrieve all tags for an entry.
453 *
454 * @ApiDoc(
455 * requirements={
456 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
457 * }
458 * )
459 *
460 * @return JsonResponse
461 */
462 public function getEntriesTagsAction(Entry $entry)
463 {
464 $this->validateAuthentication();
465 $this->validateUserAccess($entry->getUser()->getId());
466
72db15ca 467 return $this->sendResponse($entry->getTags());
900c8448
NL
468 }
469
470 /**
471 * Add one or more tags to an entry.
472 *
473 * @ApiDoc(
474 * requirements={
475 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
476 * },
477 * parameters={
478 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
479 * }
480 * )
481 *
482 * @return JsonResponse
483 */
484 public function postEntriesTagsAction(Request $request, Entry $entry)
485 {
486 $this->validateAuthentication();
487 $this->validateUserAccess($entry->getUser()->getId());
488
489 $tags = $request->request->get('tags', '');
490 if (!empty($tags)) {
491 $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
492 }
493
494 $em = $this->getDoctrine()->getManager();
495 $em->persist($entry);
496 $em->flush();
497
72db15ca 498 return $this->sendResponse($entry);
900c8448
NL
499 }
500
501 /**
502 * Permanently remove one tag for an entry.
503 *
504 * @ApiDoc(
505 * requirements={
506 * {"name"="tag", "dataType"="integer", "requirement"="\w+", "description"="The tag ID"},
507 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
508 * }
509 * )
510 *
511 * @return JsonResponse
512 */
513 public function deleteEntriesTagsAction(Entry $entry, Tag $tag)
514 {
515 $this->validateAuthentication();
516 $this->validateUserAccess($entry->getUser()->getId());
517
518 $entry->removeTag($tag);
519 $em = $this->getDoctrine()->getManager();
520 $em->persist($entry);
521 $em->flush();
522
72db15ca 523 return $this->sendResponse($entry);
900c8448 524 }
d1fc5902
NL
525
526 /**
80299ed2 527 * Handles an entries list delete tags from them.
d1fc5902
NL
528 *
529 * @ApiDoc(
530 * parameters={
80299ed2 531 * {"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."}
d1fc5902
NL
532 * }
533 * )
534 *
535 * @return JsonResponse
536 */
80299ed2 537 public function deleteEntriesTagsListAction(Request $request)
d1fc5902
NL
538 {
539 $this->validateAuthentication();
540
541 $list = json_decode($request->query->get('list', []));
72db15ca
JB
542
543 if (empty($list)) {
544 return $this->sendResponse([]);
545 }
d1fc5902
NL
546
547 // handle multiple urls
72db15ca 548 $results = [];
d1fc5902 549
72db15ca
JB
550 foreach ($list as $key => $element) {
551 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
552 $element->url,
553 $this->getUser()->getId()
554 );
d1fc5902 555
72db15ca
JB
556 $results[$key]['url'] = $element->url;
557 $results[$key]['entry'] = $entry instanceof Entry ? $entry->getId() : false;
d1fc5902 558
72db15ca 559 $tags = $element->tags;
80299ed2 560
72db15ca
JB
561 if (false !== $entry && !(empty($tags))) {
562 $tags = explode(',', $tags);
563 foreach ($tags as $label) {
564 $label = trim($label);
80299ed2 565
72db15ca
JB
566 $tag = $this->getDoctrine()
567 ->getRepository('WallabagCoreBundle:Tag')
568 ->findOneByLabel($label);
d1fc5902 569
72db15ca
JB
570 if (false !== $tag) {
571 $entry->removeTag($tag);
572 }
d1fc5902 573 }
72db15ca
JB
574
575 $em = $this->getDoctrine()->getManager();
576 $em->persist($entry);
577 $em->flush();
d1fc5902
NL
578 }
579 }
580
72db15ca 581 return $this->sendResponse($results);
d1fc5902 582 }
80299ed2
NL
583
584 /**
585 * Handles an entries list and add tags to them.
586 *
587 * @ApiDoc(
588 * parameters={
589 * {"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."}
590 * }
591 * )
592 *
593 * @return JsonResponse
594 */
595 public function postEntriesTagsListAction(Request $request)
596 {
597 $this->validateAuthentication();
598
599 $list = json_decode($request->query->get('list', []));
72db15ca
JB
600
601 if (empty($list)) {
602 return $this->sendResponse([]);
603 }
604
80299ed2
NL
605 $results = [];
606
607 // handle multiple urls
72db15ca
JB
608 foreach ($list as $key => $element) {
609 $entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
610 $element->url,
611 $this->getUser()->getId()
612 );
80299ed2 613
72db15ca
JB
614 $results[$key]['url'] = $element->url;
615 $results[$key]['entry'] = $entry instanceof Entry ? $entry->getId() : false;
80299ed2 616
72db15ca 617 $tags = $element->tags;
80299ed2 618
72db15ca
JB
619 if (false !== $entry && !(empty($tags))) {
620 $this->get('wallabag_core.content_proxy')->assignTagsToEntry($entry, $tags);
80299ed2 621
72db15ca
JB
622 $em = $this->getDoctrine()->getManager();
623 $em->persist($entry);
624 $em->flush();
80299ed2
NL
625 }
626 }
627
72db15ca
JB
628 return $this->sendResponse($results);
629 }
630
631 /**
632 * Shortcut to send data serialized in json.
633 *
634 * @param mixed $data
635 *
636 * @return JsonResponse
637 */
638 private function sendResponse($data)
639 {
640 $json = $this->get('serializer')->serialize($data, 'json');
80299ed2
NL
641
642 return (new JsonResponse())->setJson($json);
643 }
900c8448 644}