Add RSS Feed for forum

add spatie/laravel-feed for RSS feed generation

fixes #339

Author: fetzi

app/Models/Thread.php

@@ -3,13 +3,16 @@
 namespace App\Models;
 
 use App\Exceptions\CouldNotMarkReplyAsSolution;
-use App\Helpers\HasAuthor;
 use App\Helpers\HasSlug;
 use App\Helpers\HasTags;
-use App\Helpers\HasTimestamps;
+use Spatie\Feed\Feedable;
+use Spatie\Feed\FeedItem;
+use App\Helpers\HasAuthor;
 use App\Helpers\ModelHelpers;
-use App\Helpers\ProvidesSubscriptions;
+use App\Helpers\HasTimestamps;
+use Illuminate\Support\Carbon;
 use App\Helpers\ReceivesReplies;
+use App\Helpers\ProvidesSubscriptions;
 use DB;
 use Exception;
 use Illuminate\Contracts\Pagination\Paginator;
@@ -19,12 +22,14 @@
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use Illuminate\Support\Str;
 
-final class Thread extends Model implements ReplyAble, SubscriptionAble
+final class Thread extends Model implements ReplyAble, SubscriptionAble, Feedable
 {
     use HasAuthor, HasSlug, HasTimestamps, ModelHelpers, ProvidesSubscriptions, ReceivesReplies, HasTags;
 
     const TABLE = 'threads';
 
+    const FEED_PAGE_SIZE = 20;
+
     /**
      * {@inheritdoc}
      */
@@ -109,6 +114,19 @@ public function delete()
         parent::delete();
     }
 
+    public function toFeedItem()
+    {
+        $updatedAt = Carbon::parse($this->latest_creation);
+
+        return FeedItem::create()
+            ->id($this->id)
+            ->title($this->subject)
+            ->summary($this->body)
+            ->updated($updatedAt)
+            ->link(route('thread', $this->slug))
+            ->author($this->author()->name);
+    }
+
     /**
      * @return \App\Models\Thread[]
      */
@@ -173,4 +191,15 @@ public static function resolutionTime()
             return false;
         }
     }
+
+    /**
+     * retrieve 20 feed items with use of page parameter.
+     */
+    public static function getFeedItems()
+    {
+        $page = intval(request('page', 1));
+        $query = static::feedQuery();
+
+        return $query->skip(($page - 1) * static::FEED_PAGE_SIZE)->take(static::FEED_PAGE_SIZE)->get();
+    }
 }

composer.json

@@ -21,6 +21,7 @@
         "ramsey/uuid": "^3.7",
         "roave/security-advisories": "dev-master",
         "spatie/laravel-backup": "^6.4",
+        "spatie/laravel-feed": "^2.0",
         "spatie/laravel-robots-middleware": "^1.0"
     },
     "require-dev": {
@@ -82,4 +83,4 @@
     },
     "minimum-stability": "dev",
     "prefer-stable": true
-}
+}

composer.lock

@@ -0,0 +1,24 @@
+<?php
+
+return [
+    'feeds' => [
+        'forum' => [
+            /*
+             * Here you can specify which class and method will return
+             * the items that should appear in the feed. For example:
+             * 'App\Model@getAllFeedItems'
+             *
+             * You can also pass an argument to that method:
+             * ['App\Model@getAllFeedItems', 'argument']
+             */
+            'items' => ['App\Models\Thread@getFeedItems'],
+
+            /*
+             * The feed will be available on this url.
+             */
+            'url' => '/forum/rss',
+
+            'title' => 'laravel.io Forum RSS Feed',
+        ],
+    ],
+];

config/feed.php

@@ -17,6 +17,7 @@
         window.Laravel = {!! json_encode(['csrfToken' => csrf_token()]) !!};
     </script>
 
+    @include('feed::links')
     @include('layouts._favicons')
     @include('layouts._cookie_consent')
     @include('layouts._google_analytics')

resources/views/layouts/base.blade.php

@@ -0,0 +1,29 @@
+<?=
+    /* Using an echo tag here so the `<? ... ?>` won't get parsed as short tags */
+    '<?xml version="1.0" encoding="UTF-8"?>'.PHP_EOL
+?>
+<feed xmlns="http://www.w3.org/2005/Atom">
+    @foreach($meta as $key => $metaItem)
+        @if($key === 'link')
+            <{{ $key }} href="{{ url($metaItem) }}"></{{ $key }}>
+        @elseif($key === 'title')
+            <{{ $key }}><![CDATA[{{ $metaItem }}]]></{{ $key }}>
+        @else
+            <{{ $key }}>{{ $metaItem }}</{{ $key }}>
+        @endif
+    @endforeach
+    @foreach($items as $item)
+        <entry>
+            <title><![CDATA[{{ $item->title }}]]></title>
+            <link rel="alternate" href="{{ url($item->link) }}" />
+            <id>{{ url($item->id) }}</id>
+            <author>
+                <name> <![CDATA[{{ $item->author }}]]></name>
+            </author>
+            <summary type="html">
+                <![CDATA[{!! $item->summary !!}]]>
+            </summary>
+            <updated>{{ $item->updated->toAtomString() }}</updated>
+        </entry>
+    @endforeach
+</feed>

resources/views/vendor/feed/feed.blade.php

@@ -0,0 +1,3 @@
+@foreach($feeds as $name => $title)
+    <link rel="alternate" type="application/rss+xml" href="{{ route("feeds.{$name}") }}" title="{{ $title }}">
+@endforeach

resources/views/vendor/feed/links.blade.php

@@ -1,5 +1,7 @@
 <?php
 
+Route::feeds();
+
 // Home
 Route::get('/', 'HomeController@show')->name('home');
 Route::get('rules', 'HomeController@rules')->name('rules');