diff options
author | Jeremy Benoist <jeremy.benoist@gmail.com> | 2017-06-30 16:54:26 +0200 |
---|---|---|
committer | Jeremy Benoist <jeremy.benoist@gmail.com> | 2017-07-03 13:45:04 +0200 |
commit | a05b61159e147776f63baee731b5026796e5f7ae (patch) | |
tree | 80dae1ea169f3fb072a7aa2072f24507e10e91ed /src/Wallabag/ApiBundle | |
parent | 71e1cbc8eb5928d393b0772055d6b711e90a09b3 (diff) | |
download | wallabag-a05b61159e147776f63baee731b5026796e5f7ae.tar.gz wallabag-a05b61159e147776f63baee731b5026796e5f7ae.tar.zst wallabag-a05b61159e147776f63baee731b5026796e5f7ae.zip |
Fix PATCH method
The PATCH method for the entry should only update what user sent to us and not the whole entry as it was before.
Also, sending tags when patching an entry will now remove all current tags & assocatied new ones.
Diffstat (limited to 'src/Wallabag/ApiBundle')
-rw-r--r-- | src/Wallabag/ApiBundle/Controller/EntryRestController.php | 211 |
1 files changed, 142 insertions, 69 deletions
diff --git a/src/Wallabag/ApiBundle/Controller/EntryRestController.php b/src/Wallabag/ApiBundle/Controller/EntryRestController.php index ca460c84..a2e913af 100644 --- a/src/Wallabag/ApiBundle/Controller/EntryRestController.php +++ b/src/Wallabag/ApiBundle/Controller/EntryRestController.php | |||
@@ -299,8 +299,8 @@ class EntryRestController extends WallabagRestController | |||
299 | * {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."}, | 299 | * {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."}, |
300 | * {"name"="title", "dataType"="string", "required"=false, "description"="Optional, we'll get the title from the page."}, | 300 | * {"name"="title", "dataType"="string", "required"=false, "description"="Optional, we'll get the title from the page."}, |
301 | * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."}, | 301 | * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."}, |
302 | * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already starred"}, | ||
303 | * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already archived"}, | 302 | * {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already archived"}, |
303 | * {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="entry already starred"}, | ||
304 | * {"name"="content", "dataType"="string", "required"=false, "description"="Content of the entry"}, | 304 | * {"name"="content", "dataType"="string", "required"=false, "description"="Content of the entry"}, |
305 | * {"name"="language", "dataType"="string", "required"=false, "description"="Language of the entry"}, | 305 | * {"name"="language", "dataType"="string", "required"=false, "description"="Language of the entry"}, |
306 | * {"name"="preview_picture", "dataType"="string", "required"=false, "description"="Preview picture of the entry"}, | 306 | * {"name"="preview_picture", "dataType"="string", "required"=false, "description"="Preview picture of the entry"}, |
@@ -328,7 +328,58 @@ class EntryRestController extends WallabagRestController | |||
328 | $entry->setUrl($url); | 328 | $entry->setUrl($url); |
329 | } | 329 | } |
330 | 330 | ||
331 | $this->upsertEntry($entry, $request); | 331 | $data = $this->retrieveValueFromRequest($request); |
332 | |||
333 | try { | ||
334 | $this->get('wallabag_core.content_proxy')->updateEntry( | ||
335 | $entry, | ||
336 | $entry->getUrl(), | ||
337 | [ | ||
338 | 'title' => !empty($data['title']) ? $data['title'] : $entry->getTitle(), | ||
339 | 'html' => !empty($data['content']) ? $data['content'] : $entry->getContent(), | ||
340 | 'url' => $entry->getUrl(), | ||
341 | 'language' => !empty($data['language']) ? $data['language'] : $entry->getLanguage(), | ||
342 | 'date' => !empty($data['publishedAt']) ? $data['publishedAt'] : $entry->getPublishedAt(), | ||
343 | // faking the open graph preview picture | ||
344 | 'open_graph' => [ | ||
345 | 'og_image' => !empty($data['picture']) ? $data['picture'] : $entry->getPreviewPicture(), | ||
346 | ], | ||
347 | 'authors' => is_string($data['authors']) ? explode(',', $data['authors']) : $entry->getPublishedBy(), | ||
348 | ] | ||
349 | ); | ||
350 | } catch (\Exception $e) { | ||
351 | $this->get('logger')->error('Error while saving an entry', [ | ||
352 | 'exception' => $e, | ||
353 | 'entry' => $entry, | ||
354 | ]); | ||
355 | } | ||
356 | |||
357 | if (!is_null($data['isArchived'])) { | ||
358 | $entry->setArchived((bool) $data['isArchived']); | ||
359 | } | ||
360 | |||
361 | if (!is_null($data['isStarred'])) { | ||
362 | $entry->setStarred((bool) $data['isStarred']); | ||
363 | } | ||
364 | |||
365 | if (!empty($data['tags'])) { | ||
366 | $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $data['tags']); | ||
367 | } | ||
368 | |||
369 | if (!is_null($data['isPublic'])) { | ||
370 | if (true === (bool) $data['isPublic'] && null === $entry->getUid()) { | ||
371 | $entry->generateUid(); | ||
372 | } elseif (false === (bool) $data['isPublic']) { | ||
373 | $entry->cleanUid(); | ||
374 | } | ||
375 | } | ||
376 | |||
377 | $em = $this->getDoctrine()->getManager(); | ||
378 | $em->persist($entry); | ||
379 | $em->flush(); | ||
380 | |||
381 | // entry saved, dispatch event about it! | ||
382 | $this->get('event_dispatcher')->dispatch(EntrySavedEvent::NAME, new EntrySavedEvent($entry)); | ||
332 | 383 | ||
333 | return $this->sendResponse($entry); | 384 | return $this->sendResponse($entry); |
334 | } | 385 | } |
@@ -361,7 +412,78 @@ class EntryRestController extends WallabagRestController | |||
361 | $this->validateAuthentication(); | 412 | $this->validateAuthentication(); |
362 | $this->validateUserAccess($entry->getUser()->getId()); | 413 | $this->validateUserAccess($entry->getUser()->getId()); |
363 | 414 | ||
364 | $this->upsertEntry($entry, $request, true); | 415 | $contentProxy = $this->get('wallabag_core.content_proxy'); |
416 | |||
417 | $data = $this->retrieveValueFromRequest($request); | ||
418 | |||
419 | // this is a special case where user want to manually update the entry content | ||
420 | // the ContentProxy will only cleanup the html | ||
421 | // and also we force to not re-fetch the content in case of error | ||
422 | if (!empty($data['content'])) { | ||
423 | try { | ||
424 | $contentProxy->updateEntry( | ||
425 | $entry, | ||
426 | $entry->getUrl(), | ||
427 | [ | ||
428 | 'html' => $data['content'], | ||
429 | ], | ||
430 | true | ||
431 | ); | ||
432 | } catch (\Exception $e) { | ||
433 | $this->get('logger')->error('Error while saving an entry', [ | ||
434 | 'exception' => $e, | ||
435 | 'entry' => $entry, | ||
436 | ]); | ||
437 | } | ||
438 | } | ||
439 | |||
440 | if (!empty($data['title'])) { | ||
441 | $entry->setTitle($data['title']); | ||
442 | } | ||
443 | |||
444 | if (!empty($data['language'])) { | ||
445 | $contentProxy->updateLanguage($entry, $data['language']); | ||
446 | } | ||
447 | |||
448 | if (!empty($data['authors']) && is_string($data['authors'])) { | ||
449 | $entry->setPublishedBy(explode(',', $data['authors'])); | ||
450 | } | ||
451 | |||
452 | if (!empty($data['picture'])) { | ||
453 | $contentProxy->updatePreviewPicture($entry, $data['picture']); | ||
454 | } | ||
455 | |||
456 | if (!empty($data['publishedAt'])) { | ||
457 | $contentProxy->updatePublishedAt($entry, $data['publishedAt']); | ||
458 | } | ||
459 | |||
460 | if (!is_null($data['isArchived'])) { | ||
461 | $entry->setArchived((bool) $data['isArchived']); | ||
462 | } | ||
463 | |||
464 | if (!is_null($data['isStarred'])) { | ||
465 | $entry->setStarred((bool) $data['isStarred']); | ||
466 | } | ||
467 | |||
468 | if (!empty($data['tags'])) { | ||
469 | $entry->removeAllTags(); | ||
470 | $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $data['tags']); | ||
471 | } | ||
472 | |||
473 | if (!is_null($data['isPublic'])) { | ||
474 | if (true === (bool) $data['isPublic'] && null === $entry->getUid()) { | ||
475 | $entry->generateUid(); | ||
476 | } elseif (false === (bool) $data['isPublic']) { | ||
477 | $entry->cleanUid(); | ||
478 | } | ||
479 | } | ||
480 | |||
481 | $em = $this->getDoctrine()->getManager(); | ||
482 | $em->persist($entry); | ||
483 | $em->flush(); | ||
484 | |||
485 | // entry saved, dispatch event about it! | ||
486 | $this->get('event_dispatcher')->dispatch(EntrySavedEvent::NAME, new EntrySavedEvent($entry)); | ||
365 | 487 | ||
366 | return $this->sendResponse($entry); | 488 | return $this->sendResponse($entry); |
367 | } | 489 | } |
@@ -634,76 +756,27 @@ class EntryRestController extends WallabagRestController | |||
634 | } | 756 | } |
635 | 757 | ||
636 | /** | 758 | /** |
637 | * Update or Insert a new entry. | 759 | * Retrieve value from the request. |
760 | * Used for POST & PATCH on a an entry. | ||
638 | * | 761 | * |
639 | * @param Entry $entry | ||
640 | * @param Request $request | 762 | * @param Request $request |
641 | * @param bool $disableContentUpdate If we don't want the content to be update by fetching the url (used when patching instead of posting) | 763 | * |
764 | * @return array | ||
642 | */ | 765 | */ |
643 | private function upsertEntry(Entry $entry, Request $request, $disableContentUpdate = false) | 766 | private function retrieveValueFromRequest(Request $request) |
644 | { | 767 | { |
645 | $title = $request->request->get('title'); | 768 | return [ |
646 | $tags = $request->request->get('tags', []); | 769 | 'title' => $request->request->get('title'), |
647 | $isArchived = $request->request->get('archive'); | 770 | 'tags' => $request->request->get('tags', []), |
648 | $isStarred = $request->request->get('starred'); | 771 | 'isArchived' => $request->request->get('archive'), |
649 | $isPublic = $request->request->get('public'); | 772 | 'isStarred' => $request->request->get('starred'), |
650 | $content = $request->request->get('content'); | 773 | 'isPublic' => $request->request->get('public'), |
651 | $language = $request->request->get('language'); | 774 | 'content' => $request->request->get('content'), |
652 | $picture = $request->request->get('preview_picture'); | 775 | 'language' => $request->request->get('language'), |
653 | $publishedAt = $request->request->get('published_at'); | 776 | 'picture' => $request->request->get('preview_picture'), |
654 | $authors = $request->request->get('authors', ''); | 777 | 'publishedAt' => $request->request->get('published_at'), |
655 | 778 | 'authors' => $request->request->get('authors', ''), | |
656 | try { | 779 | ]; |
657 | $this->get('wallabag_core.content_proxy')->updateEntry( | ||
658 | $entry, | ||
659 | $entry->getUrl(), | ||
660 | [ | ||
661 | 'title' => !empty($title) ? $title : $entry->getTitle(), | ||
662 | 'html' => !empty($content) ? $content : $entry->getContent(), | ||
663 | 'url' => $entry->getUrl(), | ||
664 | 'language' => !empty($language) ? $language : $entry->getLanguage(), | ||
665 | 'date' => !empty($publishedAt) ? $publishedAt : $entry->getPublishedAt(), | ||
666 | // faking the open graph preview picture | ||
667 | 'open_graph' => [ | ||
668 | 'og_image' => !empty($picture) ? $picture : $entry->getPreviewPicture(), | ||
669 | ], | ||
670 | 'authors' => is_string($authors) ? explode(',', $authors) : $entry->getPublishedBy(), | ||
671 | ], | ||
672 | $disableContentUpdate | ||
673 | ); | ||
674 | } catch (\Exception $e) { | ||
675 | $this->get('logger')->error('Error while saving an entry', [ | ||
676 | 'exception' => $e, | ||
677 | 'entry' => $entry, | ||
678 | ]); | ||
679 | } | ||
680 | |||
681 | if (null !== $isArchived) { | ||
682 | $entry->setArchived((bool) $isArchived); | ||
683 | } | ||
684 | |||
685 | if (null !== $isStarred) { | ||
686 | $entry->setStarred((bool) $isStarred); | ||
687 | } | ||
688 | |||
689 | if (!empty($tags)) { | ||
690 | $this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $tags); | ||
691 | } | ||
692 | |||
693 | if (null !== $isPublic) { | ||
694 | if (true === (bool) $isPublic && null === $entry->getUid()) { | ||
695 | $entry->generateUid(); | ||
696 | } elseif (false === (bool) $isPublic) { | ||
697 | $entry->cleanUid(); | ||
698 | } | ||
699 | } | ||
700 | |||
701 | $em = $this->getDoctrine()->getManager(); | ||
702 | $em->persist($entry); | ||
703 | $em->flush(); | ||
704 | |||
705 | // entry saved, dispatch event about it! | ||
706 | $this->get('event_dispatcher')->dispatch(EntrySavedEvent::NAME, new EntrySavedEvent($entry)); | ||
707 | } | 780 | } |
708 | 781 | ||
709 | /** | 782 | /** |