aboutsummaryrefslogtreecommitdiff
path: root/internal/feed/feed.go
blob: 014f8b64da60e2a30518b05c91226cc285b82ff6 (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
package feed

import (
	"fmt"
	"net/url"
	"strings"
	"time"

	"github.com/Necoro/gofeed"

	"github.com/Necoro/feed2imap-go/internal/feed/filter"
	"github.com/Necoro/feed2imap-go/pkg/config"
	"github.com/Necoro/feed2imap-go/pkg/log"
)

type Feed struct {
	*config.Feed
	feed   *gofeed.Feed
	filter *filter.Filter
	items  []Item
	Global config.GlobalOptions
	extID  FeedID
}

type FeedID interface {
	String() string
}

type FilterFunc func(items []Item, ignHash, alwaysNew bool) []Item

type Descriptor struct {
	Name string
	Url  string
}

func (feed *Feed) Descriptor() Descriptor {
	var url string
	if feed.Url != "" {
		url = feed.Url
	} else {
		url = "exec://" + strings.Join(feed.Exec, "/")
	}
	return Descriptor{
		Name: feed.Name,
		Url:  url,
	}
}

func (feed *Feed) NeedsUpdate(updateTime time.Time) bool {
	if feed.MinFreq == 0 { // shortcut
		return true
	}
	if !updateTime.IsZero() && int(time.Since(updateTime).Hours()) < feed.MinFreq {
		log.Printf("Feed '%s' does not need updating, skipping.", feed.Name)
		return false
	}
	return true
}

func (feed *Feed) FetchSuccessful() bool {
	return feed.feed != nil
}

func Create(parsedFeed *config.Feed, global config.GlobalOptions) (*Feed, error) {
	var itemFilter *filter.Filter
	var err error
	if parsedFeed.ItemFilter != "" {
		if itemFilter, err = filter.New(parsedFeed.ItemFilter); err != nil {
			return nil, fmt.Errorf("Feed %s: Parsing item-filter: %w", parsedFeed.Name, err)
		}
	}
	return &Feed{Feed: parsedFeed, Global: global, filter: itemFilter}, nil
}

func (feed *Feed) filterItems() []Item {
	if feed.filter == nil {
		return feed.items
	}

	items := make([]Item, 0, len(feed.items))

	for _, item := range feed.items {
		res, err := feed.filter.Run(item.Item)
		if err != nil {
			log.Errorf("Feed %s: Item %s: Error applying item filter: %s", feed.Name, printItem(item.Item), err)
			res = true // include
		}

		if res {
			if log.IsDebug() {
				log.Debugf("Filter '%s' matches for item %s", feed.ItemFilter, printItem(item.Item))
			}
			items = append(items, item)
		} else if log.IsDebug() { // printItem is not for free
			log.Debugf("Filter '%s' does not match for item %s", feed.ItemFilter, printItem(item.Item))
		}
	}
	return items
}

func (feed *Feed) Filter(filter FilterFunc) {
	if len(feed.items) > 0 {
		origLen := len(feed.items)

		log.Debugf("Filtering %s. Starting with %d items", feed.Name, origLen)

		items := feed.filterItems()
		newLen := len(items)
		if newLen < origLen {
			log.Printf("Item filter on %s: Reduced from %d to %d items.", feed.Name, origLen, newLen)
			origLen = newLen
		}

		feed.items = filter(items, feed.IgnHash, feed.AlwaysNew)

		newLen = len(feed.items)
		if newLen < origLen {
			log.Printf("Filtered %s. Reduced from %d to %d items.", feed.Name, origLen, newLen)
		} else {
			log.Printf("Filtered %s, no reduction.", feed.Name)
		}

	} else {
		log.Debugf("No items for %s. No filtering.", feed.Name)
	}
}

func (feed *Feed) SetExtID(extID FeedID) {
	feed.extID = extID
}

func (feed *Feed) id() string {
	if feed.extID == nil {
		return feed.Name
	}
	return feed.extID.String()
}

func (feed *Feed) url() *url.URL {
	var feedUrl *url.URL
	var err error

	if feed.Url != "" {
		feedUrl, err = url.Parse(feed.Url)
		if err != nil {
			panic(fmt.Sprintf("URL '%s' of feed '%s' is not a valid URL. How have we ended up here?", feed.Url, feed.Name))
		}
	} else if feed.feed.Link != "" {
		feedUrl, err = url.Parse(feed.feed.Link)
		if err != nil {
			panic(fmt.Sprintf("Link '%s' of feed '%s' is not a valid URL.", feed.feed.Link, feed.Name))
		}
	}

	return feedUrl
}