2015-01-29 15:56:58 +00:00
< ? php
2015-03-29 08:53:10 +00:00
namespace Wallabag\ApiBundle\Controller ;
2015-01-29 15:56:58 +00:00
use Nelmio\ApiDocBundle\Annotation\ApiDoc ;
use Symfony\Bundle\FrameworkBundle\Controller\Controller ;
2015-01-29 19:32:11 +00:00
use Symfony\Component\HttpFoundation\Request ;
2015-02-27 14:24:36 +00:00
use Symfony\Component\HttpFoundation\Response ;
2015-02-06 06:45:32 +00:00
use Wallabag\CoreBundle\Entity\Entry ;
2015-02-06 17:15:19 +00:00
use Wallabag\CoreBundle\Entity\Tag ;
2015-01-30 08:05:54 +00:00
use Wallabag\CoreBundle\Service\Extractor ;
2015-03-06 10:07:39 +00:00
use Hateoas\Configuration\Route ;
use Hateoas\Representation\Factory\PagerfantaFactory ;
2015-01-29 15:56:58 +00:00
2015-01-30 06:50:52 +00:00
class WallabagRestController extends Controller
2015-01-29 15:56:58 +00:00
{
2015-02-26 08:41:42 +00:00
/**
* @ param Entry $entry
* @ param string $tags
*/
private function assignTagsToEntry ( Entry $entry , $tags )
{
foreach ( explode ( ',' , $tags ) as $label ) {
$label = trim ( $label );
$tagEntity = $this
-> getDoctrine ()
-> getRepository ( 'WallabagCoreBundle:Tag' )
-> findOneByLabel ( $label );
if ( is_null ( $tagEntity )) {
$tagEntity = new Tag ( $this -> getUser ());
$tagEntity -> setLabel ( $label );
}
// only add the tag on the entry if the relation doesn't exist
if ( ! $entry -> getTags () -> contains ( $tagEntity )) {
$entry -> addTag ( $tagEntity );
}
}
}
2015-02-10 07:35:43 +00:00
/**
* Retrieve salt for a giver user .
*
2015-03-05 18:34:30 +00:00
* @ ApiDoc (
* parameters = {
* { " name " = " username " , " dataType " = " string " , " required " = true , " description " = " username " }
* }
* )
2015-02-11 10:52:10 +00:00
* @ return array
2015-02-10 07:35:43 +00:00
*/
2015-02-26 14:00:28 +00:00
public function getSaltAction ( $username )
2015-02-10 07:35:43 +00:00
{
$user = $this
-> getDoctrine ()
-> getRepository ( 'WallabagCoreBundle:User' )
2015-02-26 14:00:28 +00:00
-> findOneByUsername ( $username );
2015-02-10 07:35:43 +00:00
if ( is_null ( $user )) {
throw $this -> createNotFoundException ();
}
2015-02-11 14:15:06 +00:00
return array ( $user -> getSalt () ? : null );
2015-02-10 07:35:43 +00:00
}
2015-03-29 08:53:10 +00:00
2015-01-29 15:56:58 +00:00
/**
2015-01-30 06:50:52 +00:00
* Retrieve all entries . It could be filtered by many options .
2015-01-29 15:56:58 +00:00
*
* @ ApiDoc (
2015-01-30 06:50:52 +00:00
* parameters = {
2015-02-05 17:21:31 +00:00
* { " name " = " archive " , " dataType " = " boolean " , " required " = false , " format " = " true or false, all entries by default " , " description " = " filter by archived status. " },
* { " name " = " star " , " dataType " = " boolean " , " required " = false , " format " = " true or false, all entries by default " , " description " = " filter by starred status. " },
2015-01-30 06:50:52 +00:00
* { " name " = " sort " , " dataType " = " string " , " required " = false , " format " = " 'created' or 'updated', default 'created' " , " description " = " sort entries by date. " },
* { " name " = " order " , " dataType " = " string " , " required " = false , " format " = " 'asc' or 'desc', default 'desc' " , " description " = " order of sort. " },
* { " name " = " page " , " dataType " = " integer " , " required " = false , " format " = " default '1' " , " description " = " what page you want. " },
* { " name " = " perPage " , " dataType " = " integer " , " required " = false , " format " = " default'30' " , " description " = " results per page. " },
* { " name " = " tags " , " dataType " = " string " , " required " = false , " format " = " api%2Crest " , " description " = " a list of tags url encoded. Will returns entries that matches ALL tags. " },
* }
2015-01-29 15:56:58 +00:00
* )
2015-02-06 06:45:32 +00:00
* @ return Entry
2015-01-29 15:56:58 +00:00
*/
2015-01-29 19:32:11 +00:00
public function getEntriesAction ( Request $request )
2015-01-29 15:56:58 +00:00
{
2015-02-04 17:06:42 +00:00
$isArchived = $request -> query -> get ( 'archive' );
$isStarred = $request -> query -> get ( 'star' );
2015-01-30 06:50:52 +00:00
$sort = $request -> query -> get ( 'sort' , 'created' );
$order = $request -> query -> get ( 'order' , 'desc' );
2015-03-06 10:07:39 +00:00
$page = ( int ) $request -> query -> get ( 'page' , 1 );
$perPage = ( int ) $request -> query -> get ( 'perPage' , 30 );
2015-03-29 08:53:10 +00:00
$tags = $request -> query -> get ( 'tags' , []);
2015-01-30 06:50:52 +00:00
2015-03-06 10:07:39 +00:00
$pager = $this
2015-01-30 06:50:52 +00:00
-> getDoctrine ()
2015-02-06 06:45:32 +00:00
-> getRepository ( 'WallabagCoreBundle:Entry' )
2015-02-20 14:36:25 +00:00
-> findEntries ( $this -> getUser () -> getId (), $isArchived , $isStarred , $sort , $order );
2015-01-30 06:50:52 +00:00
2015-03-06 10:07:39 +00:00
$pager -> setCurrentPage ( $page );
$pager -> setMaxPerPage ( $perPage );
$pagerfantaFactory = new PagerfantaFactory ( 'page' , 'perPage' );
$paginatedCollection = $pagerfantaFactory -> createRepresentation (
$pager ,
new Route ( 'api_get_entries' , [], $absolute = true )
);
$json = $this -> get ( 'serializer' ) -> serialize ( $paginatedCollection , 'json' );
2015-02-20 10:45:38 +00:00
2015-03-29 08:53:10 +00:00
return $this -> renderJsonResponse ( $json );
2015-01-29 15:56:58 +00:00
}
/**
2015-01-30 06:50:52 +00:00
* Retrieve a single entry
2015-01-29 15:56:58 +00:00
*
* @ ApiDoc (
* requirements = {
* { " name " = " entry " , " dataType " = " integer " , " requirement " = " \ w+ " , " description " = " The entry ID " }
* }
* )
2015-02-06 06:45:32 +00:00
* @ return Entry
2015-01-29 15:56:58 +00:00
*/
2015-02-06 06:45:32 +00:00
public function getEntryAction ( Entry $entry )
2015-01-29 15:56:58 +00:00
{
2015-03-29 08:53:10 +00:00
$this -> validateUserAccess ( $entry -> getUser () -> getId (), $this -> getUser () -> getId ());
2015-02-26 08:41:42 +00:00
2015-02-20 13:18:01 +00:00
$json = $this -> get ( 'serializer' ) -> serialize ( $entry , 'json' );
2015-02-20 10:45:38 +00:00
2015-03-29 08:53:10 +00:00
return $this -> renderJsonResponse ( $json );
2015-01-29 15:56:58 +00:00
}
/**
2015-01-30 06:50:52 +00:00
* Create an entry
2015-01-29 15:56:58 +00:00
*
* @ ApiDoc (
2015-01-30 06:50:52 +00:00
* parameters = {
* { " name " = " url " , " dataType " = " string " , " required " = true , " format " = " http://www.test.com/article.html " , " description " = " Url for the entry. " },
* { " name " = " title " , " dataType " = " string " , " required " = false , " description " = " Optional, we'll get the title from the page. " },
* { " name " = " tags " , " dataType " = " string " , " required " = false , " format " = " tag1,tag2,tag3 " , " description " = " a comma-separated list of tags. " },
* }
2015-01-29 15:56:58 +00:00
* )
2015-02-06 06:45:32 +00:00
* @ return Entry
2015-01-29 15:56:58 +00:00
*/
2015-01-30 08:05:54 +00:00
public function postEntriesAction ( Request $request )
2015-01-29 15:56:58 +00:00
{
2015-01-31 14:14:10 +00:00
$url = $request -> request -> get ( 'url' );
$content = Extractor :: extract ( $url );
2015-02-10 11:12:44 +00:00
$entry = new Entry ( $this -> getUser ());
2015-01-31 14:14:10 +00:00
$entry -> setUrl ( $url );
2015-02-05 17:19:34 +00:00
$entry -> setTitle ( $request -> request -> get ( 'title' ) ? : $content -> getTitle ());
2015-01-30 08:05:54 +00:00
$entry -> setContent ( $content -> getBody ());
2015-02-26 08:41:42 +00:00
2015-02-26 13:25:40 +00:00
$tags = $request -> request -> get ( 'tags' , '' );
if ( ! empty ( $tags )) {
$this -> assignTagsToEntry ( $entry , $tags );
}
2015-02-26 08:41:42 +00:00
2015-01-30 08:05:54 +00:00
$em = $this -> getDoctrine () -> getManager ();
$em -> persist ( $entry );
$em -> flush ();
2015-02-20 13:18:01 +00:00
$json = $this -> get ( 'serializer' ) -> serialize ( $entry , 'json' );
2015-03-29 08:53:10 +00:00
return $this -> renderJsonResponse ( $json );
2015-01-29 15:56:58 +00:00
}
/**
2015-01-30 06:50:52 +00:00
* Change several properties of an entry
2015-01-29 15:56:58 +00:00
*
* @ ApiDoc (
* requirements = {
* { " name " = " entry " , " dataType " = " integer " , " requirement " = " \ w+ " , " description " = " The entry ID " }
2015-01-30 06:50:52 +00:00
* },
* parameters = {
* { " name " = " title " , " dataType " = " string " , " required " = false },
* { " name " = " tags " , " dataType " = " string " , " required " = false , " format " = " tag1,tag2,tag3 " , " description " = " a comma-separated list of tags. " },
2015-02-05 17:21:31 +00:00
* { " name " = " archive " , " dataType " = " boolean " , " required " = false , " format " = " true or false " , " description " = " archived the entry. " },
* { " name " = " star " , " dataType " = " boolean " , " required " = false , " format " = " true or false " , " description " = " starred the entry. " },
2015-02-20 14:36:25 +00:00
* }
2015-01-29 15:56:58 +00:00
* )
2015-02-06 06:45:32 +00:00
* @ return Entry
2015-01-29 15:56:58 +00:00
*/
2015-02-06 06:45:32 +00:00
public function patchEntriesAction ( Entry $entry , Request $request )
2015-01-29 15:56:58 +00:00
{
2015-03-29 08:53:10 +00:00
$this -> validateUserAccess ( $entry -> getUser () -> getId (), $this -> getUser () -> getId ());
2015-02-26 08:41:42 +00:00
2015-02-05 17:21:31 +00:00
$title = $request -> request -> get ( " title " );
$isArchived = $request -> request -> get ( " archive " );
$isStarred = $request -> request -> get ( " star " );
if ( ! is_null ( $title )) {
$entry -> setTitle ( $title );
}
if ( ! is_null ( $isArchived )) {
2015-02-05 21:33:36 +00:00
$entry -> setArchived ( $isArchived );
2015-02-05 17:21:31 +00:00
}
if ( ! is_null ( $isStarred )) {
2015-02-05 21:33:36 +00:00
$entry -> setStarred ( $isStarred );
2015-02-05 17:21:31 +00:00
}
2015-02-26 13:25:40 +00:00
$tags = $request -> request -> get ( 'tags' , '' );
if ( ! empty ( $tags )) {
$this -> assignTagsToEntry ( $entry , $tags );
}
2015-02-26 08:41:42 +00:00
2015-02-05 17:21:31 +00:00
$em = $this -> getDoctrine () -> getManager ();
$em -> flush ();
2015-02-26 13:25:40 +00:00
$json = $this -> get ( 'serializer' ) -> serialize ( $entry , 'json' );
2015-03-29 08:53:10 +00:00
return $this -> renderJsonResponse ( $json );
2015-01-29 15:56:58 +00:00
}
/**
2015-01-30 06:50:52 +00:00
* Delete ** permanently ** an entry
2015-01-29 15:56:58 +00:00
*
* @ ApiDoc (
2015-01-30 06:50:52 +00:00
* requirements = {
* { " name " = " entry " , " dataType " = " integer " , " requirement " = " \ w+ " , " description " = " The entry ID " }
* }
2015-01-29 15:56:58 +00:00
* )
2015-02-06 06:45:32 +00:00
* @ return Entry
2015-01-29 15:56:58 +00:00
*/
2015-02-06 06:45:32 +00:00
public function deleteEntriesAction ( Entry $entry )
2015-01-29 15:56:58 +00:00
{
2015-03-29 08:53:10 +00:00
$this -> validateUserAccess ( $entry -> getUser () -> getId (), $this -> getUser () -> getId ());
2015-02-26 08:41:42 +00:00
2015-02-04 16:54:23 +00:00
$em = $this -> getDoctrine () -> getManager ();
2015-02-20 14:36:25 +00:00
$em -> remove ( $entry );
2015-02-04 16:54:23 +00:00
$em -> flush ();
2015-02-20 14:36:25 +00:00
$json = $this -> get ( 'serializer' ) -> serialize ( $entry , 'json' );
2015-03-29 08:53:10 +00:00
return $this -> renderJsonResponse ( $json );
2015-01-29 15:56:58 +00:00
}
/**
2015-01-30 06:50:52 +00:00
* Retrieve all tags for an entry
2015-01-29 15:56:58 +00:00
*
* @ ApiDoc (
* requirements = {
* { " name " = " entry " , " dataType " = " integer " , " requirement " = " \ w+ " , " description " = " The entry ID " }
* }
* )
*/
2015-02-06 06:45:32 +00:00
public function getEntriesTagsAction ( Entry $entry )
2015-01-31 18:09:34 +00:00
{
2015-03-29 08:53:10 +00:00
$this -> validateUserAccess ( $entry -> getUser () -> getId (), $this -> getUser () -> getId ());
2015-02-26 08:41:42 +00:00
2015-02-20 19:36:05 +00:00
$json = $this -> get ( 'serializer' ) -> serialize ( $entry -> getTags (), 'json' );
2015-02-20 19:29:33 +00:00
2015-03-29 08:53:10 +00:00
return $this -> renderJsonResponse ( $json );
2015-01-29 15:56:58 +00:00
}
/**
2015-01-30 06:50:52 +00:00
* Add one or more tags to an entry
2015-01-29 15:56:58 +00:00
*
* @ ApiDoc (
* requirements = {
* { " name " = " entry " , " dataType " = " integer " , " requirement " = " \ w+ " , " description " = " The entry ID " }
2015-01-30 06:50:52 +00:00
* },
* parameters = {
* { " name " = " tags " , " dataType " = " string " , " required " = false , " format " = " tag1,tag2,tag3 " , " description " = " a comma-separated list of tags. " },
* }
2015-01-29 15:56:58 +00:00
* )
*/
2015-02-24 21:00:24 +00:00
public function postEntriesTagsAction ( Request $request , Entry $entry )
2015-01-31 18:09:34 +00:00
{
2015-03-29 08:53:10 +00:00
$this -> validateUserAccess ( $entry -> getUser () -> getId (), $this -> getUser () -> getId ());
2015-02-24 21:00:24 +00:00
2015-02-26 13:25:40 +00:00
$tags = $request -> request -> get ( 'tags' , '' );
if ( ! empty ( $tags )) {
$this -> assignTagsToEntry ( $entry , $tags );
}
2015-02-26 08:41:42 +00:00
2015-02-24 21:00:24 +00:00
$em = $this -> getDoctrine () -> getManager ();
$em -> persist ( $entry );
$em -> flush ();
$json = $this -> get ( 'serializer' ) -> serialize ( $entry , 'json' );
2015-03-29 08:53:10 +00:00
return $this -> renderJsonResponse ( $json );
2015-01-29 15:56:58 +00:00
}
/**
2015-01-30 06:50:52 +00:00
* Permanently remove one tag for an entry
2015-01-29 15:56:58 +00:00
*
* @ ApiDoc (
* requirements = {
2015-03-29 08:53:10 +00:00
* { " name " = " tag " , " dataType " = " integer " , " requirement " = " \ w+ " , " description " = " The tag ID " },
2015-01-29 15:56:58 +00:00
* { " name " = " entry " , " dataType " = " integer " , " requirement " = " \ w+ " , " description " = " The entry ID " }
* }
* )
*/
2015-02-06 17:15:19 +00:00
public function deleteEntriesTagsAction ( Entry $entry , Tag $tag )
2015-01-29 15:56:58 +00:00
{
2015-03-29 08:53:10 +00:00
$this -> validateUserAccess ( $entry -> getUser () -> getId (), $this -> getUser () -> getId ());
2015-02-26 08:41:42 +00:00
$entry -> removeTag ( $tag );
$em = $this -> getDoctrine () -> getManager ();
$em -> persist ( $entry );
$em -> flush ();
$json = $this -> get ( 'serializer' ) -> serialize ( $entry , 'json' );
2015-03-29 08:53:10 +00:00
return $this -> renderJsonResponse ( $json );
2015-01-29 15:56:58 +00:00
}
/**
2015-01-30 06:50:52 +00:00
* Retrieve all tags
2015-01-29 15:56:58 +00:00
*
2015-02-26 08:41:42 +00:00
* @ ApiDoc ()
2015-01-29 15:56:58 +00:00
*/
2015-02-26 08:41:42 +00:00
public function getTagsAction ()
2015-01-31 18:09:34 +00:00
{
2015-02-26 08:41:42 +00:00
$json = $this -> get ( 'serializer' ) -> serialize ( $this -> getUser () -> getTags (), 'json' );
2015-03-29 08:53:10 +00:00
return $this -> renderJsonResponse ( $json );
2015-01-29 15:56:58 +00:00
}
/**
2015-01-30 06:50:52 +00:00
* Permanently remove one tag from ** every ** entry
2015-01-29 15:56:58 +00:00
*
* @ ApiDoc (
* requirements = {
2015-03-29 08:53:10 +00:00
* { " name " = " tag " , " dataType " = " integer " , " requirement " = " \ w+ " , " description " = " The tag " }
2015-01-29 15:56:58 +00:00
* }
* )
*/
2015-02-06 17:15:19 +00:00
public function deleteTagAction ( Tag $tag )
2015-01-29 15:56:58 +00:00
{
2015-03-29 08:53:10 +00:00
$this -> validateUserAccess ( $tag -> getUser () -> getId (), $this -> getUser () -> getId ());
2015-02-26 08:41:42 +00:00
$em = $this -> getDoctrine () -> getManager ();
$em -> remove ( $tag );
$em -> flush ();
$json = $this -> get ( 'serializer' ) -> serialize ( $tag , 'json' );
2015-03-29 08:53:10 +00:00
return $this -> renderJsonResponse ( $json );
}
/**
* Validate that the first id is equal to the second one .
* If not , throw exception . It means a user try to access information from an other user
*
* @ param integer $requestUserId User id from the requested source
* @ param integer $currentUserId User id from the retrieved source
*/
private function validateUserAccess ( $requestUserId , $currentUserId )
{
if ( $requestUserId != $currentUserId ) {
throw $this -> createAccessDeniedException ( 'Access forbidden. Entry user id: ' . $requestUserId . ', logged user id: ' . $currentUserId );
}
}
/**
* Send a JSON Response .
* We don ' t use the Symfony JsonRespone , because it takes an array as parameter instead of a JSON string
*
* @ param string $json
*
* @ return Response
*/
private function renderJsonResponse ( $json )
{
2015-02-27 16:51:36 +00:00
return new Response ( $json , 200 , array ( 'application/json' ));
2015-01-29 15:56:58 +00:00
}
2015-01-31 18:09:34 +00:00
}