Syndication extension (RSS & Atom feeds)

matteocontrini

010101 in beta10 you could replace it with formatContent(), while on beta9 you would need to pass the current HTTP request.

flarum/core1840

arthrfrts

Hi!

I'm using this extension in my forum on FreeFlarum, but unfortunately the feed is not validating because all posts have the same ID (1, but it should be its URL I guess?). Here are the results for the Feed Validator.

I'm using this extension to notify about new posts on Twitter using IFTTT, but the service requires a feed that validates for it to work.

010101

matteocontrini Ha. I'm silly. Turns out this part of this extension works fine. So the fact that it uses contentHtml must be okay. It does in fact display the post content in the feed. I never actually looked. I assumed it wasn't working because in a feed reader I use, it's not coming through. That's a whole different ballgame. I think feed readers aren't reading it right because of what arthrfrts pointed out. It's not a valid feed due to the ID. I bet if I find a way to fix the <id></id> part of the feed, it'll all work fine.

But, it is strange that contentHtml works when you're saying that it was removed from Flarum. All of this stuff sure gets confusing and convoluted.

010101

@matteocontrini

This doesn't fix the issue where the post content is not showing the the atom/rss feed:

                'description' => $this->summary($post->attributes->formatContent),
                'content'     => $post->attributes->formatContent,

Where you see formatContent it used to say contentHtml. There are a few different files in this extension which use contentHTML and so I replaced all instances of that with formatContent. No joy. I'm on beta 10.

matteocontrini

010101 formatContent is a method and it must be called with formatContent()

010101

Ok, all fixed and now both RSS and ATOM feeds are valid. @AmauryPi - If you still come around here, could you please consider making the following updates? If you don't come back and reply here, maybe after a few more weeks to a month, I'll fork this and re-release it. FYI, @arthrfrts. Edit: I went ahead and forked and did a pull request. See this post below.

Here's what you need to do everyone... it's very simple. Edit two files.

atom.blade.php
rss.blade.php
Both are within this extension's views folder.

Replace atom.blade.php's code with:

{!! '<'.'?xml version="1.0" encoding="utf-8"?'.'>' !!}

<feed xmlns="http://www.w3.org/2005/Atom">

    <title><![CDATA[{!! $title !!}]]></title>
    <subtitle><![CDATA[{!! $description !!}]]></subtitle>
    <link href="{{ $self_link }}" rel="self" />
    <link href="{{ $link }}" />
    <id><![CDATA[{!! $link !!}]]></id>
    <updated>{{ $pubDate->format(DateTime::ATOM) }}</updated>

    @foreach ($entries as $entry)
    <entry>
        <title><![CDATA[{!! $entry['title'] !!}]]></title>
        <link rel="alternate" type="text/html" href="{{ $entry['permalink'] }}"/>
        <id>{{ $entry['permalink'] }}</id>
        <updated>{{ $entry['pubdate']->format(DateTime::ATOM) }}</updated>
        <summary><![CDATA[{!! $entry['description'] !!}]]></summary>
        <content type="html"><![CDATA[{!! $entry['content'] !!}]]></content>
        <author>
            <name>{{ $entry['author'] }}</name>
        </author>
    </entry>
    @endforeach

</feed>

Replace rss.blade.php's code with:

{!! '<'.'?xml version="1.0" encoding="utf-8"?'.'>' !!}

<rss version="2.0" xmlns:content="http://purl.org/rss/1.0/modules/content/" xmlns:atom="http://www.w3.org/2005/Atom">

    <channel>
        <title><![CDATA[{!! $title !!}]]></title>
        @if (!empty($description))<description><![CDATA[{!! $description !!}]]></description>@endif
        <link><![CDATA[{!! $link !!}]]></link>
        <pubDate>{{ $pubDate->format(DateTime::RSS) }}</pubDate>
        <atom:link href="{{ $self_link }}" rel="self" type="application/rss+xml" />

        @foreach ($entries as $entry)
        <item>
            <title><![CDATA[{!! $entry['title'] !!}]]></title>
            <description><![CDATA[{!! $entry['description'] !!}]]></description>
            <content:encoded><![CDATA[{!! $entry['content'] !!}]]></content:encoded>
            <guid>{{ $entry['permalink'] }}</guid>
            <pubDate>{{ $entry['pubdate']->format(DateTime::RSS) }}</pubDate>
        </item>
        @endforeach

    </channel>

</rss>

Final tip - up to you if you want to do this. The feeds are more likely to validate if you remove the full content portion of each feed. In other words, the code above includes a description/summary, plus full content with HTML tags. Feed validators don't like certain HTML tags. Plus, maybe you don't want people to be able to subscribe to a feed and see EVERYTHING. If this is the case, then...

In the above atom code remove this line:
<content type="html"><![CDATA[{!! $entry['content'] !!}]]></content>

In the rss code, remove:
<content:encoded><![CDATA[{!! $entry['content'] !!}]]></content:encoded>

Now you will still have all of the important parts of the feeds, including a description or summary of posts, but you won't have the full HTML of the posts.

Edit: @AmauryPi - In the pull request I went with taking the full HTML content portions out. It’s obviously up to you if you want to leave it that way. As you’ll see above, I had feed validation issues when leaving the full HTML content lines in. And so my pull request sticks with the basic text summaries only.

cmcjacob

010101 You may have better odds forking your changes and linking to the repo until/unless you can make a pull request. I didn't read into the changes although your instructions were clear, it just left me thinking a git DIFF would suffice without the expense of your time detailing changes here. easier for people who would just rather clone, update, or not otherwise edit anything manually

tolgaaaltas

010101 Thank you for fixing. Yandex.Turbo Pages users should use this code:

{!! '<'.'?xml version="1.0" encoding="utf-8"?'.'>' !!}

<rss version="2.0" xmlns:content="http://purl.org/rss/1.0/modules/content/" xmlns:atom="http://www.w3.org/2005/Atom" xmlns:turbo="http://turbo.yandex.ru">

    <channel>
        <title><![CDATA[{!! $title !!}]]></title>
        @if (!empty($description))<description><![CDATA[{!! $description !!}]]></description>@endif
        <link><![CDATA[{!! $link !!}]]></link>
        <pubDate>{{ $pubDate->format(DateTime::RSS) }}</pubDate>
        <atom:link href="{{ $self_link }}" rel="self" type="application/rss+xml" />

        @foreach ($entries as $entry)
        <item turbo="true">
            <title><![CDATA[{!! $entry['title'] !!}]]></title>
            <description><![CDATA[{!! $entry['content'] !!}]]></description>
            <turbo:content><![CDATA[{!! $entry['content'] !!}]]></turbo:content>
            <link>{{ $entry['permalink'] }}</link>
            <guid>{{ $entry['permalink'] }}</guid>
            <pubDate>{{ $entry['pubdate']->format(DateTime::RSS) }}</pubDate>
        </item>
        @endforeach

    </channel>

</rss>

Edited for v0.3.1

arthrfrts

010101 Thanks for the fix! I'll wait for @AmauryPi to publish the fix and then ask to FreeFlarum to update it in their platform.

SezginYILDIRIM

010101 I applied to the Google news application, the rss plugin made some bugs and I added your edits. You saved me from a big trouble right now. Thank you.

https://news.google.com/publications/CAAqBwgKMNjvmQswgvqxAw?hl=tr&gl=TR&ceid=TR%3Atr

010101

cmcjacob Good point. 🤔 Done. 👍

Pull request: https://github.com/AmauryCarrade/flarum-ext-syndication/pull/10

Fork:
https://github.com/zerosonesfun/flarum-ext-syndication

Alkir

tolgaaaltas
<yandex:full-text><![CDATA[{!! $entry['content'] !!}]]></yandex:full-text>

Error: This page contains the following errors:
error on line 15 at column 30: Namespace prefix yandex on full-text is not defined
Below is a rendering of the page up to the first error.

AmauryPi

Hey,

as said in the PR, I'll check & test this next week (probably Monday) and publish an update. Thanks for the fix!

tolgaaaltas

Alkir This codes uses only with Yandex Turbo Pages service, so this is mean not a global code. More info here.

AmauryPi

The fix has been published, along with other features:

new translations;
new settings to configure the feeds: extracts or full text; HTML or plain; and number of entries per feed;
compatibility fixes;
improved documentation.

Get it using Bazaar or:

composer require amaurycarrade/flarum-ext-syndication
php flarum cache:clear

Thanks for your patience!

010101

AmauryPi Hey, thanks for all this work and the updates! I haven’t tried it yet, I guess I need to actually try it before asking this but... looking at the code, how does it switch between HTML or plain text? Because the way I’m doing it is swapping out $entry['content'] for $entry['description'] in the rss/atom blade files. But I see you stuck with content and it looks like only the type=html is added or removed by the settings. For me, the magical solution to ensuring a plain text feed which I like (because I want people to visit the actual forum) was using description instead of content.

AmauryPi

010101 The change was made in the controller. The content or description keys were added by my controller, not Flarum itself; now, there is only a content key and the post's content injected into it is truncated if needed in the controller.

The template should only display data, not process it, hence the use of the controller for this.

010101

AmauryPi Cool! I’m learning. I’ll try this out later. 🙂

nitaaikumar

AmauryPi Thanks for such an awesome extension. Now we can finally use Google Feedburner to give an email newsletter subscription of all the new discussions with unlimited subscriber facility for free, even to non-registered members.

There is one issue. The html5 videos which I embed via the autovideo of the Formatting extension are not responsive in the feed. They are getting cut off on the right. This was the css which fixed it:

video { width: 100%; height: auto; }

How can we make this same css work for your feeds so that the videos are fixed in the feeds, email newsletters and on feedly.com reader too?

Also, any plans to add podcast support in the feeds so that we can submit podcast feeds of a Video tag to the Apple directory etc? It should be quite simple to add. Even Wordpress.com feeds have that. I can donate for your time to add podcast functionality please, because our visitors really like a way to listen and watch our meditation podcasts in their default podcast app after downloading them offline in the podcast apps and also be notified about new episodes, and also continue watching from where they left off in their favorite podcast app. We self-host our videos and audios so this will be great blessing for us. Thanks again for updating it.

nitaaikumar

AmauryPi Is it possible to also have a feed for the recent posts in all the discussions just like the comments feed in Wordpress for regular members to keep in touch via the RSS feeds in something like Feedly reader? Thanks.

AmauryPi

nitaaikumar AmauryPi Thanks for such an awesome extension. Now we can finally use Google Feedburner to give an email newsletter subscription of all the new discussions with unlimited subscriber facility for free, even to non-registered members.

Thank you!

nitaaikumar There is one issue. The html5 videos which I embed via the autovideo of the Formatting extension are not responsive in the feed. They are getting cut off on the right. This was the css which fixed it:

video {
width: 100%;
height: auto;
}

How can we make this same css work for your feeds so that the videos are fixed in the feeds, email newsletters and on feedly.com reader too?

I'm afraid we cannot add CSS into the RSS/Atom feeds. Or, you can, but only for users viewing the RSS feed directly in their browsers (and it's less and less supported). If Feedly or FeedBurner can inject CSS, add it there. But there is nothing I can do…

nitaaikumar Also, any plans to add podcast support in the feeds so that we can submit podcast feeds of a Video tag to the Apple directory etc? It should be quite simple to add. Even Wordpress.com feeds have that. I can donate for your time to add podcast functionality please, because our visitors really like a way to listen and watch our meditation podcasts in their default podcast app after downloading them offline in the podcast apps and also be notified about new episodes, and also continue watching from where they left off in their favorite podcast app. We self-host our videos and audios so this will be great blessing for us. Thanks again for updating it.

It was not planned, but it can be done (donations would be appreciated for the time). One thing: in your perspective, from where the podcast file (MP3, MP4, …) should be extracted? Something like the first non-image media in the post?

AmauryPi

Alkir I don't speak russian. But if you provide a translation file (you can use the English language as a template), I'll happily add it to the extension.

Alkir I tried to add it to the root of the extension itself, but after adding to the site, a 500 error occurs

You may have a YAML formatting error. You can check your file here.

010101 If it's only a warning, it will not break any aggregator. In fact, most of the RSS feeds are invalid, so modern aggregators are pretty resilient to errors. A slash won't scare them off. This being said, I may fix this in a close-future update (because I'm a perfectionist). So, thanks for the patch 🙂 .

nitaaikumar AmauryPi Is it possible to also have a feed for the recent posts in all the discussions just like the comments feed in Wordpress for regular members to keep in touch via the RSS feeds in something like Feedly reader? Thanks.

Something like https://your-forum.eu/atom (or /rss)? If I understand correctly, it's already available 🙂 .

010101

Thanks again @AmauryPi! I finally got around to updating this and it works great! The feeds validate. But, there is a warning which is easy to fix. For whatever reason, the feed validators don't like the link to the feed to end in a slash. It likes the other links to end in a slash, but not the feed URL. I have no idea why... and it could even be that the feed validator is wrong. But, to get rid of that warning, here's the fix...

The validator gives me a warning with:

<link href="https://mysite.com/atom/" rel="self" />

If I remove the slash at the end of the URL so that it looks like the following that warning goes away:

<link href="https://mysite.com/atom" rel="self" />

Remove the slash in AbstractFeedController.php on line 124:

'self_link' => rtrim($request->getUri(), " \t\n\r\0\v/") . "/",

End result:

'self_link' => rtrim($request->getUri(), " \t\n\r\0\v/"),

« Previous Page Next Page »