Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

RSS feeds.Item.id is not a valid URL and is not isPermalink=false #28734

Closed
beaucollins opened this issue Jan 8, 2024 · 3 comments · Fixed by #28860
Closed

RSS feeds.Item.id is not a valid URL and is not isPermalink=false #28734

beaucollins opened this issue Jan 8, 2024 · 3 comments · Fixed by #28860
Labels
type/bug

Comments

@beaucollins
Copy link

beaucollins commented Jan 8, 2024 •
edited
Loading

Description

When creating the RSS feed for releases, the Item.id is set to a db ID value with the url concatenated. Example:

      <guid>316519: https://gitea.com/owner/repo/releases/tag/v2.4.1rc1</guid>

gitea/routers/web/feed/convert.go

Line 308 in f4ea8d9

Id: fmt.Sprintf("%v: %v", strconv.FormatInt(rel.ID, 10), link.Href),

The RSS 2 standard states:

guid stands for globally unique identifier. It's a string that uniquely identifies the item. When present, an aggregator may choose to use this string to determine if an item is new.

There are no rules for the syntax of a guid. Aggregators must view them as a string. It's up to the source of the feed to establish the uniqueness of the string.

If the guid element has an attribute named isPermaLink with a value of true, the reader may assume that it is a permalink to the item, that is, a url that can be opened in a Web browser, that points to the full item described by the element. An example:

isPermaLink is optional, its default value is true. If its value is false, the guid may not be assumed to be a url, or a url to anything in particular.

https://www.rssboard.org/rss-specification#ltguidgtSubelementOfLtitemgt

And since the default value of true indicates this is a valid URL gitea should provide a valid URL or set isPermalink="false".

Gitea's behavior of providing an invalid URL and leaving out the isPermalink="false" it breaks some feed readers that expect the <guid> to abide by the RSS 2.0 specification.

Gitea Version

1.22.0+dev-522-ga04f8c0f8

Can you reproduce the bug on the Gitea demo site?

Yes

Log Gist

No response

Screenshots

No response

Git Version

No response

Operating System

No response

How are you running Gitea?

https://gitea.com/

Database

None
@beaucollins
Copy link
Author

The package Gitea uses to create the RSS feeds does not seem to support setting isPermalink. Relevant issue gorilla/feeds#78

Seems the simplest fix code wise would be to append the id as a URL fragment https://url.com/org/repo/feed#123456 but this would cause all existing feeds to indicate that the feed item is new since the GUID will have changed.

@yardenshoham
Copy link
Member

I mentioned this in #21550 (comment)

@yardenshoham yardenshoham mentioned this issue Jan 10, 2024
Merged
12 tasks
@yardenshoham yardenshoham mentioned this issue Jan 19, 2024
Merged
lunny pushed a commit that referenced this issue Jan 20, 2024
@yardenshoham
Set the isPermaLink attribute to false in the guid sub-element (#…
5574968 
…28860)

Our `guid` is not a valid URL so according to the RSS spec the
`isPermaLink` attribute needs to be set to `false`.

Example:
```diff
<item>
  <title>yardenshoham opened issue &lt;a href=&#34;https://3000-yardenshoham-gitea-jqlxjixsez9.ws-us107.gitpod.io/yardenshoham/test/issues/2&#34;&gt;yardenshoham/test#2&lt;/a&gt;</title>
  <link>https://3000-yardenshoham-gitea-jqlxjixsez9.ws-us107.gitpod.io/yardenshoham/test/issues/2</link>
  <description>2#hey</description>
  <content:encoded><![CDATA[2#hey]]></content:encoded>
  <author>yardenshoham</author>
- <guid>355: https://3000-yardenshoham-gitea-jqlxjixsez9.ws-us107.gitpod.io/yardenshoham/test/issues/2</guid>
+ <guid isPermaLink="false">355: https://3000-yardenshoham-gitea-jqlxjixsez9.ws-us107.gitpod.io/yardenshoham/test/issues/2</guid>
  <pubDate>Tue, 16 Jan 2024 18:54:36 +0000</pubDate>
</item>
```

References:
-
https://www.rssboard.org/rss-specification#ltguidgtSubelementOfLtitemgt
- Fixes #28734
- gorilla/feeds#78
- #21550
- gorilla/feeds#107

Signed-off-by: Yarden Shoham <git@yardenshoham.com>
yardenshoham added a commit to yardenshoham/gitea that referenced this issue Jan 20, 2024
@yardenshoham
Set the isPermaLink attribute to false in the guid sub-element (g…
0f20b83 
…o-gitea#28860)

Our `guid` is not a valid URL so according to the RSS spec the
`isPermaLink` attribute needs to be set to `false`.

Example:
```diff
<item>
  <title>yardenshoham opened issue &lt;a href=&#34;https://3000-yardenshoham-gitea-jqlxjixsez9.ws-us107.gitpod.io/yardenshoham/test/issues/2&#34;&gt;yardenshoham/test#2&lt;/a&gt;</title>
  <link>https://3000-yardenshoham-gitea-jqlxjixsez9.ws-us107.gitpod.io/yardenshoham/test/issues/2</link>
  <description>2#hey</description>
  <content:encoded><![CDATA[2#hey]]></content:encoded>
  <author>yardenshoham</author>
- <guid>355: https://3000-yardenshoham-gitea-jqlxjixsez9.ws-us107.gitpod.io/yardenshoham/test/issues/2</guid>
+ <guid isPermaLink="false">355: https://3000-yardenshoham-gitea-jqlxjixsez9.ws-us107.gitpod.io/yardenshoham/test/issues/2</guid>
  <pubDate>Tue, 16 Jan 2024 18:54:36 +0000</pubDate>
</item>
```

References:
-
https://www.rssboard.org/rss-specification#ltguidgtSubelementOfLtitemgt
- Fixes go-gitea#28734
- gorilla/feeds#78
- go-gitea#21550
- gorilla/feeds#107

Signed-off-by: Yarden Shoham <git@yardenshoham.com>
@yardenshoham yardenshoham mentioned this issue Jan 20, 2024
Closed
henrygoodman pushed a commit to henrygoodman/gitea that referenced this issue Jan 31, 2024
@yardenshoham @henrygoodman
Set the isPermaLink attribute to false in the guid sub-element (g…
9d9a8e6 
…o-gitea#28860)

Our `guid` is not a valid URL so according to the RSS spec the
`isPermaLink` attribute needs to be set to `false`.

Example:
```diff
<item>
  <title>yardenshoham opened issue &lt;a href=&go-gitea#34;https://3000-yardenshoham-gitea-jqlxjixsez9.ws-us107.gitpod.io/yardenshoham/test/issues/2&#34;&gt;yardenshoham/test#2&lt;/a&gt;</title>
  <link>https://3000-yardenshoham-gitea-jqlxjixsez9.ws-us107.gitpod.io/yardenshoham/test/issues/2</link>
  <description>2#hey</description>
  <content:encoded><![CDATA[2#hey]]></content:encoded>
  <author>yardenshoham</author>
- <guid>355: https://3000-yardenshoham-gitea-jqlxjixsez9.ws-us107.gitpod.io/yardenshoham/test/issues/2</guid>
+ <guid isPermaLink="false">355: https://3000-yardenshoham-gitea-jqlxjixsez9.ws-us107.gitpod.io/yardenshoham/test/issues/2</guid>
  <pubDate>Tue, 16 Jan 2024 18:54:36 +0000</pubDate>
</item>
```

References:
-
https://www.rssboard.org/rss-specification#ltguidgtSubelementOfLtitemgt
- Fixes go-gitea#28734
- gorilla/feeds#78
- go-gitea#21550
- gorilla/feeds#107

Signed-off-by: Yarden Shoham <git@yardenshoham.com>
silverwind pushed a commit to silverwind/gitea that referenced this issue Feb 20, 2024
@yardenshoham @silverwind
Set the isPermaLink attribute to false in the guid sub-element (g…
0091d15 
…o-gitea#28860)

Our `guid` is not a valid URL so according to the RSS spec the
`isPermaLink` attribute needs to be set to `false`.

Example:
```diff
<item>
  <title>yardenshoham opened issue &lt;a href=&go-gitea#34;https://3000-yardenshoham-gitea-jqlxjixsez9.ws-us107.gitpod.io/yardenshoham/test/issues/2&#34;&gt;yardenshoham/test#2&lt;/a&gt;</title>
  <link>https://3000-yardenshoham-gitea-jqlxjixsez9.ws-us107.gitpod.io/yardenshoham/test/issues/2</link>
  <description>2#hey</description>
  <content:encoded><![CDATA[2#hey]]></content:encoded>
  <author>yardenshoham</author>
- <guid>355: https://3000-yardenshoham-gitea-jqlxjixsez9.ws-us107.gitpod.io/yardenshoham/test/issues/2</guid>
+ <guid isPermaLink="false">355: https://3000-yardenshoham-gitea-jqlxjixsez9.ws-us107.gitpod.io/yardenshoham/test/issues/2</guid>
  <pubDate>Tue, 16 Jan 2024 18:54:36 +0000</pubDate>
</item>
```

References:
-
https://www.rssboard.org/rss-specification#ltguidgtSubelementOfLtitemgt
- Fixes go-gitea#28734
- gorilla/feeds#78
- go-gitea#21550
- gorilla/feeds#107

Signed-off-by: Yarden Shoham <git@yardenshoham.com>
@github-actions GitHub Actions
Copy link

github-actions bot commented Mar 1, 2024

Automatically locked because of our CONTRIBUTING guidelines

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 1, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
type/bug
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Set the isPermaLink attribute to false in the guid sub-element yardenshoham/gitea
2 participants
@beaucollins @yardenshoham