mirrors/wallabag
1
0
Fork 0
mirror of https://github.com/wallabag/wallabag.git synced 2024-11-26 11:01:04 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #3181 from wallabag/api-content-patch

Browse source 
Add ability to patch an entry with more fields
This commit is contained in:
Jérémy Benoist 2017-06-07 15:40:59 +02:00 committed by GitHub
commit c0d756f67d
3 changed files with 87 additions and 76 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

150
src/Wallabag/ApiBundle/Controller/EntryRestController.php
View file

@ -299,65 +299,18 @@ class EntryRestController extends WallabagRestController
$this->validateAuthentication();
$url = $request->request->get('url');
$title = $request->request->get('title');
$tags = $request->request->get('tags', []);
$isArchived = $request->request->get('archive');
$isStarred = $request->request->get('starred');
$content = $request->request->get('content');
$language = $request->request->get('language');
$picture = $request->request->get('preview_picture');
$publishedAt = $request->request->get('published_at');
$authors = $request->request->get('authors', '');
$entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId($url, $this->getUser()->getId());
$entry = $this->get('wallabag_core.entry_repository')->findByUrlAndUserId(
$url,
$this->getUser()->getId()
);
if (false === $entry) {
$entry = new Entry($this->getUser());
}
try {
$this->get('wallabag_core.content_proxy')->updateEntry(
$entry,
$url,
[
'title' => $title,
'html' => $content,
'url' => $url,
'language' => $language,
'date' => $publishedAt,
// faking the preview picture
'open_graph' => [
'og_image' => $picture,
],
'authors' => explode(',', $authors),
]
);
} catch (\Exception $e) {
$this->get('logger')->error('Error while saving an entry', [
'exception' => $e,
'entry' => $entry,
]);
$entry->setUrl($url);
}
if (!empty($tags)) {
$this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $tags);
}
if (!is_null($isStarred)) {
$entry->setStarred((bool) $isStarred);
}
if (!is_null($isArchived)) {
$entry->setArchived((bool) $isArchived);
}
$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));
$this->upsertEntry($entry, $request);
return $this->sendResponse($entry);
}
@ -374,6 +327,11 @@ class EntryRestController extends WallabagRestController
* {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
* {"name"="archive", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="archived the entry."},
* {"name"="starred", "dataType"="integer", "required"=false, "format"="1 or 0", "description"="starred the entry."},
* {"name"="content", "dataType"="string", "required"=false, "description"="Content of the entry"},
* {"name"="language", "dataType"="string", "required"=false, "description"="Language of the entry"},
* {"name"="preview_picture", "dataType"="string", "required"=false, "description"="Preview picture of the entry"},
* {"name"="published_at", "dataType"="datetime|integer", "format"="YYYY-MM-DDTHH:II:SS+TZ or a timestamp", "required"=false, "description"="Published date of the entry"},
* {"name"="authors", "dataType"="string", "format"="Name Firstname,author2,author3", "required"=false, "description"="Authors of the entry"},
* }
* )
*
@ -384,29 +342,7 @@ class EntryRestController extends WallabagRestController
$this->validateAuthentication();
$this->validateUserAccess($entry->getUser()->getId());
$title = $request->request->get('title');
$isArchived = $request->request->get('archive');
$isStarred = $request->request->get('starred');
if (!is_null($title)) {
$entry->setTitle($title);
}
if (!is_null($isArchived)) {
$entry->setArchived((bool) $isArchived);
}
if (!is_null($isStarred)) {
$entry->setStarred((bool) $isStarred);
}
$tags = $request->request->get('tags', '');
if (!empty($tags)) {
$this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $tags);
}
$em = $this->getDoctrine()->getManager();
$em->flush();
$this->upsertEntry($entry, $request, true);
return $this->sendResponse($entry);
}
@ -673,4 +609,68 @@ class EntryRestController extends WallabagRestController
return (new JsonResponse())->setJson($json);
}
/**
* Update or Insert a new entry.
*
* @param Entry $entry
* @param Request $request
* @param bool $disableContentUpdate If we don't want the content to be update by fetching the url (used when patching instead of posting)
*/
private function upsertEntry(Entry $entry, Request $request, $disableContentUpdate = false)
{
$title = $request->request->get('title');
$tags = $request->request->get('tags', []);
$isArchived = $request->request->get('archive');
$isStarred = $request->request->get('starred');
$content = $request->request->get('content');
$language = $request->request->get('language');
$picture = $request->request->get('preview_picture');
$publishedAt = $request->request->get('published_at');
$authors = $request->request->get('authors', '');
try {
$this->get('wallabag_core.content_proxy')->updateEntry(
$entry,
$entry->getUrl(),
[
'title' => !empty($title) ? $title : $entry->getTitle(),
'html' => !empty($content) ? $content : $entry->getContent(),
'url' => $entry->getUrl(),
'language' => !empty($language) ? $language : $entry->getLanguage(),
'date' => !empty($publishedAt) ? $publishedAt : $entry->getPublishedAt(),
// faking the open graph preview picture
'open_graph' => [
'og_image' => !empty($picture) ? $picture : $entry->getPreviewPicture(),
],
'authors' => is_string($authors) ? explode(',', $authors) : $entry->getPublishedBy(),
],
$disableContentUpdate
);
} catch (\Exception $e) {
$this->get('logger')->error('Error while saving an entry', [
'exception' => $e,
'entry' => $entry,
]);
}
if (!is_null($isArchived)) {
$entry->setArchived((bool) $isArchived);
}
if (!is_null($isStarred)) {
$entry->setStarred((bool) $isStarred);
}
if (!empty($tags)) {
$this->get('wallabag_core.tags_assigner')->assignTagsToEntry($entry, $tags);
}
$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));
}
}

2
src/Wallabag/CoreBundle/Helper/ContentProxy.php
View file

@ -105,7 +105,7 @@ class ContentProxy
}
}
if (!empty($content['authors'])) {
if (!empty($content['authors']) && is_array($content['authors'])) {
$entry->setPublishedBy($content['authors']);
}

11
tests/Wallabag/ApiBundle/Controller/EntryRestControllerTest.php
View file

@ -477,6 +477,10 @@ class EntryRestControllerTest extends WallabagApiTestCase
'tags' => 'new tag '.uniqid(),
'starred' => '1',
'archive' => '0',
'language' => 'de_DE',
'preview_picture' => 'http://preview.io/picture.jpg',
'authors' => 'bob,sponge',
'content' => 'awesome',
]);
$this->assertEquals(200, $this->client->getResponse()->getStatusCode());
@ -488,6 +492,11 @@ class EntryRestControllerTest extends WallabagApiTestCase
$this->assertEquals('New awesome title', $content['title']);
$this->assertGreaterThan($nbTags, count($content['tags']));
$this->assertEquals(1, $content['user_id']);
$this->assertEquals('de_DE', $content['language']);
$this->assertEquals('http://preview.io/picture.jpg', $content['preview_picture']);
$this->assertContains('sponge', $content['published_by']);
$this->assertContains('bob', $content['published_by']);
$this->assertEquals('awesome', $content['content']);
}
public function testPatchEntryWithoutQuotes()
@ -509,6 +518,7 @@ class EntryRestControllerTest extends WallabagApiTestCase
'tags' => 'new tag '.uniqid(),
'starred' => 1,
'archive' => 0,
'authors' => ['bob', 'sponge'],
]);
$this->assertEquals(200, $this->client->getResponse()->getStatusCode());
@ -519,6 +529,7 @@ class EntryRestControllerTest extends WallabagApiTestCase
$this->assertEquals($entry->getUrl(), $content['url']);
$this->assertEquals('New awesome title', $content['title']);
$this->assertGreaterThan($nbTags, count($content['tags']));
$this->assertTrue(empty($content['published_by']), 'Authors were not saved because of an array instead of a string');
}
public function testGetTagsEntry()