Add RSS pagination

Following https://tools.ietf.org/html/rfc5005#page-4

src/Wallabag/CoreBundle/Controller/RssController.php

@@ -3,12 +3,15 @@
 namespace Wallabag\CoreBundle\Controller;
 
 use Pagerfanta\Adapter\DoctrineORMAdapter;
+use Pagerfanta\Exception\OutOfRangeCurrentPageException;
 use Pagerfanta\Pagerfanta;
 use Sensio\Bundle\FrameworkExtraBundle\Configuration\ParamConverter;
 use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
+use Symfony\Component\HttpFoundation\Request;
 use Symfony\Bundle\FrameworkBundle\Controller\Controller;
 use Wallabag\CoreBundle\Entity\Entry;
 use Wallabag\UserBundle\Entity\User;
+use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
 
 class RssController extends Controller
 {
@@ -20,9 +23,9 @@ class RssController extends Controller
      *
      * @return \Symfony\Component\HttpFoundation\Response
      */
-    public function showUnreadAction(User $user)
+    public function showUnreadAction(Request $request, User $user)
     {
-        return $this->showEntries('unread', $user);
+        return $this->showEntries('unread', $user, $request->query->get('page', 1));
     }
 
     /**
@@ -33,9 +36,9 @@ class RssController extends Controller
      *
      * @return \Symfony\Component\HttpFoundation\Response
      */
-    public function showArchiveAction(User $user)
+    public function showArchiveAction(Request $request, User $user)
     {
-        return $this->showEntries('archive', $user);
+        return $this->showEntries('archive', $user, $request->query->get('page', 1));
     }
 
     /**
@@ -46,9 +49,9 @@ class RssController extends Controller
      *
      * @return \Symfony\Component\HttpFoundation\Response
      */
-    public function showStarredAction(User $user)
+    public function showStarredAction(Request $request, User $user)
     {
-        return $this->showEntries('starred', $user);
+        return $this->showEntries('starred', $user, $request->query->get('page', 1));
     }
 
     /**
@@ -57,10 +60,11 @@ class RssController extends Controller
      *
      * @param string $type Entries type: unread, starred or archive
      * @param User   $user
+     * @param int    $page
      *
      * @return \Symfony\Component\HttpFoundation\Response
      */
-    private function showEntries($type, User $user)
+    private function showEntries($type, User $user, $page = 1)
     {
         $repository = $this->getDoctrine()->getRepository('WallabagCoreBundle:Entry');
 
@@ -87,8 +91,26 @@ class RssController extends Controller
         $perPage = $user->getConfig()->getRssLimit() ?: $this->getParameter('wallabag_core.rss_limit');
         $entries->setMaxPerPage($perPage);
 
+        $url = $this->generateUrl(
+            $type.'_rss',
+            [
+                'username' => $user->getUsername(),
+                'token' => $user->getConfig()->getRssToken(),
+            ],
+            UrlGeneratorInterface::ABSOLUTE_URL
+        );
+
+        try {
+            $entries->setCurrentPage((int) $page);
+        } catch (OutOfRangeCurrentPageException $e) {
+            if ($page > 1) {
+                return $this->redirect($url.'?page='.$entries->getNbPages(), 302);
+            }
+        }
+
         return $this->render('@WallabagCore/themes/common/Entry/entries.xml.twig', [
             'type' => $type,
+            'url' => $url,
             'entries' => $entries,
         ]);
     }

src/Wallabag/CoreBundle/Resources/views/themes/common/Entry/entries.xml.twig

@@ -2,7 +2,15 @@
 <rss version="2.0" xmlns:content="http://purl.org/rss/1.0/modules/content/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:media="http://search.yahoo.com/mrss/">
     <channel>
         <title>wallabag — {{type}} feed</title>
-        <link>{{ url('unread') }}</link>
+        <link>{{ url(type) }}</link>
+        <link rel="self" href="{{ app.request.uri }}"/>
+        {% if entries.hasPreviousPage -%}
+            <link rel="previous" href="{{ url }}?page={{ entries.previousPage }}"/>
+        {% endif -%}
+        {% if entries.hasNextPage -%}
+            <link rel="next" href="{{ url }}?page={{ entries.nextPage }}"/>
+        {% endif -%}
+        <link rel="last" href="{{ url }}?page={{ entries.nbPages }}"/>
         <pubDate>{{ "now"|date('D, d M Y H:i:s') }}</pubDate>
         <generator>wallabag</generator>
         <description>wallabag {{type}} elements</description>

tests/Wallabag/CoreBundle/Controller/RssControllerTest.php

@@ -6,7 +6,7 @@ use Tests\Wallabag\CoreBundle\WallabagCoreTestCase;
 
 class RssControllerTest extends WallabagCoreTestCase
 {
-    public function validateDom($xml, $nb = null)
+    public function validateDom($xml, $type, $nb = null)
     {
         $doc = new \DOMDocument();
         $doc->loadXML($xml);
@@ -22,6 +22,23 @@ class RssControllerTest extends WallabagCoreTestCase
         $this->assertEquals(1, $xpath->query('/rss')->length);
         $this->assertEquals(1, $xpath->query('/rss/channel')->length);
 
+        $this->assertEquals(1, $xpath->query('/rss/channel/title')->length);
+        $this->assertEquals('wallabag — '.$type.' feed', $xpath->query('/rss/channel/title')->item(0)->nodeValue);
+
+        $this->assertEquals(1, $xpath->query('/rss/channel/pubDate')->length);
+
+        $this->assertEquals(1, $xpath->query('/rss/channel/generator')->length);
+        $this->assertEquals('wallabag', $xpath->query('/rss/channel/generator')->item(0)->nodeValue);
+
+        $this->assertEquals(1, $xpath->query('/rss/channel/description')->length);
+        $this->assertEquals('wallabag '.$type.' elements', $xpath->query('/rss/channel/description')->item(0)->nodeValue);
+
+        $this->assertEquals(1, $xpath->query('/rss/channel/link[@rel="self"]')->length);
+        $this->assertContains($type.'.xml', $xpath->query('/rss/channel/link[@rel="self"]')->item(0)->getAttribute('href'));
+
+        $this->assertEquals(1, $xpath->query('/rss/channel/link[@rel="last"]')->length);
+        $this->assertContains($type.'.xml?page=', $xpath->query('/rss/channel/link[@rel="last"]')->item(0)->getAttribute('href'));
+
         foreach ($xpath->query('//item') as $item) {
             $this->assertEquals(1, $xpath->query('title', $item)->length);
             $this->assertEquals(1, $xpath->query('source', $item)->length);
@@ -77,7 +94,7 @@ class RssControllerTest extends WallabagCoreTestCase
 
         $this->assertEquals(200, $client->getResponse()->getStatusCode());
 
-        $this->validateDom($client->getResponse()->getContent(), 2);
+        $this->validateDom($client->getResponse()->getContent(), 'unread', 2);
     }
 
     public function testStarred()
@@ -99,7 +116,7 @@ class RssControllerTest extends WallabagCoreTestCase
 
         $this->assertEquals(200, $client->getResponse()->getStatusCode(), 1);
 
-        $this->validateDom($client->getResponse()->getContent());
+        $this->validateDom($client->getResponse()->getContent(), 'starred');
     }
 
     public function testArchives()
@@ -121,6 +138,38 @@ class RssControllerTest extends WallabagCoreTestCase
 
         $this->assertEquals(200, $client->getResponse()->getStatusCode());
 
-        $this->validateDom($client->getResponse()->getContent());
+        $this->validateDom($client->getResponse()->getContent(), 'archive');
+    }
+
+    public function testPagination()
+    {
+        $client = $this->getClient();
+        $em = $client->getContainer()->get('doctrine.orm.entity_manager');
+        $user = $em
+            ->getRepository('WallabagUserBundle:User')
+            ->findOneByUsername('admin');
+
+        $config = $user->getConfig();
+        $config->setRssToken('SUPERTOKEN');
+        $config->setRssLimit(1);
+        $em->persist($config);
+        $em->flush();
+
+        $client = $this->getClient();
+
+        $client->request('GET', '/admin/SUPERTOKEN/archive.xml');
+        $this->assertEquals(200, $client->getResponse()->getStatusCode());
+        $this->validateDom($client->getResponse()->getContent(), 'archive');
+
+        $client->request('GET', '/admin/SUPERTOKEN/archive.xml?page=2');
+        $this->assertEquals(200, $client->getResponse()->getStatusCode());
+        $this->validateDom($client->getResponse()->getContent(), 'archive');
+
+        $client->request('GET', '/admin/SUPERTOKEN/archive.xml?page=3');
+        $this->assertEquals(200, $client->getResponse()->getStatusCode());
+        $this->validateDom($client->getResponse()->getContent(), 'archive');
+
+        $client->request('GET', '/admin/SUPERTOKEN/archive.xml?page=3000');
+        $this->assertEquals(302, $client->getResponse()->getStatusCode());
     }
 }