aboutsummaryrefslogtreecommitdiff
path: root/cmds/rss.go
blob: f5f28a9e6b35c2cb9462b65173b53c3379702d33 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
// RSS rendering for the recommendations feed: hand-rolled RSS 2.0 via
// encoding/xml, no feed library. The render source is the runs.jsonl tail;
// items appear newest batch first, kept order within a batch. Guid embeds
// the original Miniflux entry ID (mf:<id>) for traceability.
package cmds

import (
	"encoding/xml"
	"fmt"
	"time"
	"unicode/utf8"

	"fluxrec/core"
)

// Cap on the source-feed name in item titles: feed titles can be
// arbitrarily long, and the suffix must stay compact so list views keep
// showing the article title itself.
const maxFeedTitleRunes = 40

const rssXMLHeader = `<?xml version="1.0" encoding="UTF-8"?>` + "\n"

type rssGUID struct {
	IsPermaLink bool   `xml:"isPermaLink,attr"`
	Value       string `xml:",chardata"`
}

type rssItem struct {
	Title       string  `xml:"title"`
	Link        string  `xml:"link"`
	GUID        rssGUID `xml:"guid"`
	PubDate     string  `xml:"pubDate"`
	Description string  `xml:"description"`
}

type rssChannel struct {
	Title       string    `xml:"title"`
	Description string    `xml:"description"`
	Items       []rssItem `xml:"item"`
}

type rssDocument struct {
	XMLName xml.Name   `xml:"rss"`
	Version string     `xml:"version,attr"`
	Channel rssChannel `xml:"channel"`
}

// RenderRSS renders runs (oldest to newest, as read from runs.jsonl) as an
// RSS 2.0 document. Each item title gets the source feed as a rune-capped
// suffix (readers show the channel title as the source of every item, so
// this is the only in-list provenance), and the description body opens
// with feed + model score + the batch-wide median score as an emphasized
// HTML paragraph (bare newlines collapse where descriptions render as
// HTML). Item content was already cleaned when the run row was written.
func RenderRSS(runs []core.RunRow) ([]byte, error) {
	doc := rssDocument{
		Version: "2.0",
		Channel: rssChannel{
			Title:       "Fluxrecs",
			Description: "Top-scored Miniflux entries, refreshed on a schedule.",
		},
	}
	for i := len(runs) - 1; i >= 0; i-- {
		for _, k := range runs[i].Kept {
			doc.Channel.Items = append(doc.Channel.Items, rssItem{
				Title:       rssItemTitle(k),
				Link:        k.URL,
				GUID:        rssGUID{IsPermaLink: false, Value: fmt.Sprintf("mf:%d", k.EntryID)},
				PubDate:     k.PublishedAt.Format(time.RFC1123Z),
				Description: rssDescription(k, runs[i].ScoreMedian),
			})
		}
	}
	body, err := xml.MarshalIndent(doc, "", "  ")
	if err != nil {
		return nil, fmt.Errorf("marshaling RSS: %w", err)
	}
	return append([]byte(rssXMLHeader), body...), nil
}

// rssItemTitle builds the displayed title: article title first, then the
// (rune-capped) source feed as a suffix so narrow list views truncate the
// provenance, not the title itself.
func rssItemTitle(k core.KeptItem) string {
	feed := truncateRunes(k.FeedTitle, maxFeedTitleRunes)
	if feed == "" {
		return k.Title
	}
	return k.Title + " — " + feed
}

func truncateRunes(s string, max int) string {
	if utf8.RuneCountInString(s) <= max {
		return s
	}
	return string([]rune(s)[:max]) + "…"
}

// rssDescription builds the item body: first a headline with the source
// feed, model score, and batch-wide median (omitted for run rows written
// before the median was logged), then the cleaned content (if any). The
// headline is wrapped in an emphasized HTML paragraph: descriptions render
// as sanitized HTML in most readers, where bare newlines collapse and the
// metadata line would run into the article text. encoding/xml escapes the
// tags on the wire, which is exactly how description-carried HTML is meant
// to be transported.
func rssDescription(k core.KeptItem, median *float64) string {
	head := fmt.Sprintf("score %.2f", k.Score)
	if median != nil {
		head += fmt.Sprintf(" · batch median %.2f", *median)
	}
	if k.FeedTitle != "" {
		head = k.FeedTitle + " · " + head
	}
	body := "<p><em>" + head + "</em></p>"
	if k.Content != "" {
		body += "\n" + k.Content
	}
	return body
}