aboutsummaryrefslogtreecommitdiff
path: root/internal/feed/cache_v1.go
blob: 9a6de50921a1b12b216874dced740dd874f8b3ab (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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
package feed

import (
	"crypto/sha256"
	"fmt"
	"strconv"
	"time"

	"github.com/Necoro/feed2imap-go/pkg/log"
	"github.com/Necoro/feed2imap-go/pkg/util"
)

const (
	v1Version   Version = 1
	startFeedId uint64  = 1
)

type feedId uint64

func (id feedId) String() string {
	return strconv.FormatUint(uint64(id), 16)
}

type v1Cache struct {
	Ids    map[feedDescriptor]feedId
	NextId uint64
	Feeds  map[feedId]*cachedFeed
}

type cachedFeed struct {
	id           feedId // not saved, has to be set on loading
	LastCheck    time.Time
	currentCheck time.Time
	NumFailures  int // can't be named `Failures` b/c it'll collide with the interface
	Items        []cachedItem
	newItems     []cachedItem
}

type itemHash [sha256.Size]byte

type cachedItem struct {
	Guid          string
	Title         string
	Link          string
	PublishedDate time.Time
	UpdatedDate   time.Time
	UpdatedCache  time.Time
	Hash          itemHash
	ID            string
}

func (item cachedItem) String() string {
	return fmt.Sprintf(`{
  Title: %q
  Guid: %q
  Link: %q
  Published: %s
  Updated: %s
}`, item.Title, item.Guid, item.Link, util.TimeFormat(item.PublishedDate), util.TimeFormat(item.UpdatedDate))
}

func (cf *cachedFeed) Checked(withFailure bool) {
	cf.currentCheck = time.Now()
	if withFailure {
		cf.NumFailures++
	} else {
		cf.NumFailures = 0
	}
}

func (cf *cachedFeed) Commit() {
	cf.Items = cf.newItems
	cf.newItems = nil
	cf.LastCheck = cf.currentCheck
}

func (cf *cachedFeed) Failures() int {
	return cf.NumFailures
}

func (cf *cachedFeed) Last() time.Time {
	return cf.LastCheck
}

func (cf *cachedFeed) ID() string {
	return cf.id.String()
}

func (cache *v1Cache) Version() Version {
	return v1Version
}

func newV1Cache() *v1Cache {
	cache := v1Cache{
		Ids:    map[feedDescriptor]feedId{},
		Feeds:  map[feedId]*cachedFeed{},
		NextId: startFeedId,
	}
	return &cache
}

func (cache *v1Cache) transformToCurrent() (Cache, error) {
	return cache, nil
}

func (cache *v1Cache) getItem(id feedId) CachedFeed {
	feed, ok := cache.Feeds[id]
	if !ok {
		feed = &cachedFeed{}
		cache.Feeds[id] = feed
	}
	feed.id = id
	return feed
}

func (cache *v1Cache) findItem(feed *Feed) CachedFeed {
	if feed.cached != nil {
		return feed.cached.(*cachedFeed)
	}

	fDescr := feed.descriptor()
	id, ok := cache.Ids[fDescr]
	if !ok {
		var otherId feedDescriptor
		changed := false
		for otherId, id = range cache.Ids {
			if otherId.Name == fDescr.Name {
				log.Warnf("Feed %s seems to have changed URLs: new '%s', old '%s'. Updating.",
					fDescr.Name, fDescr.Url, otherId.Url)
				changed = true
				break
			} else if otherId.Url == fDescr.Url {
				log.Warnf("Feed with URL '%s' seems to have changed its name: new '%s', old '%s'. Updating.",
					fDescr.Url, fDescr.Name, otherId.Name)
				changed = true
				break
			}
		}
		if changed {
			delete(cache.Ids, otherId)
		} else {
			id = feedId(cache.NextId)
			cache.NextId++
		}

		cache.Ids[fDescr] = id
	}

	item := cache.getItem(id)
	feed.cached = item
	return item
}

func (item *item) newCachedItem() cachedItem {
	var ci cachedItem

	ci.ID = item.itemId
	ci.Title = item.Item.Title
	ci.Link = item.Item.Link
	if item.Item.PublishedParsed != nil {
		ci.PublishedDate = *item.Item.PublishedParsed
	}
	if item.Item.UpdatedParsed != nil && !item.Item.UpdatedParsed.Equal(ci.PublishedDate) {
		ci.UpdatedDate = *item.Item.UpdatedParsed
	}
	ci.Guid = item.Item.GUID

	contentByte := []byte(item.Item.Description + item.Item.Content)
	ci.Hash = sha256.Sum256(contentByte)

	return ci
}

func (item *cachedItem) similarTo(other *cachedItem, ignoreHash bool) bool {
	return other.Title == item.Title &&
		other.Link == item.Link &&
		other.PublishedDate.Equal(item.PublishedDate) &&
		(ignoreHash || other.Hash == item.Hash)
}

func (cf *cachedFeed) deleteItem(index int) {
	copy(cf.Items[index:], cf.Items[index+1:])
	cf.Items[len(cf.Items)-1] = cachedItem{}
	cf.Items = cf.Items[:len(cf.Items)-1]
}

func (cf *cachedFeed) filterItems(items []item, ignoreHash, alwaysNew bool) []item {
	if len(items) == 0 {
		return items
	}

	cacheItems := make(map[cachedItem]*item, len(items))
	for idx := range items {
		// remove complete duplicates on the go
		cacheItems[items[idx].newCachedItem()] = &items[idx]
	}
	log.Debugf("%d items after deduplication", len(cacheItems))

	filtered := make([]item, 0, len(items))
	cacheadd := make([]cachedItem, 0, len(items))
	app := func(item *item, ci cachedItem, oldIdx *int) {
		if oldIdx != nil {
			item.updateOnly = true
			prevId := cf.Items[*oldIdx].ID
			ci.ID = prevId
			item.itemId = prevId
			cf.deleteItem(*oldIdx)
		}
		filtered = append(filtered, *item)
		cacheadd = append(cacheadd, ci)
	}

CACHE_ITEMS:
	for ci, item := range cacheItems {
		log.Debugf("Now checking %s", ci)
		if cf.LastCheck.IsZero() || ci.PublishedDate.After(cf.LastCheck) {
			log.Debug("Newer than last check, including.")

			item.addReason("time")
			app(item, ci, nil)
			continue
		}

		if ci.Guid != "" {
			for idx, oldItem := range cf.Items {
				if oldItem.Guid == ci.Guid {
					log.Debugf("Guid matches with: %s", oldItem)
					if !oldItem.similarTo(&ci, ignoreHash) {
						item.addReason("guid (upd)")
						app(item, ci, &idx)
					} else {
						log.Debugf("Similar, ignoring")
					}

					continue CACHE_ITEMS
				}
			}

			log.Debug("Found no matching GUID, including.")
			item.addReason("guid")
			app(item, ci, nil)
			continue
		}

		for idx, oldItem := range cf.Items {
			if oldItem.similarTo(&ci, ignoreHash) {
				log.Debugf("Similarity matches, ignoring: %s", oldItem)
				continue CACHE_ITEMS
			}

			if oldItem.Link == ci.Link {
				if alwaysNew {
					log.Debugf("Link matches, but `always-new`.")
					item.addReason("always-new")
					continue
				}
				log.Debugf("Link matches, updating: %s", oldItem)
				item.addReason("link (upd)")
				app(item, ci, &idx)

				continue CACHE_ITEMS
			}
		}

		log.Debugf("No match found, inserting.")
		item.addReason("new")
		app(item, ci, nil)
	}

	log.Debugf("%d items after filtering", len(filtered))

	cf.newItems = append(cacheadd, cf.Items...)

	return filtered
}