summaryrefslogtreecommitdiff
path: root/services/worker/internal/parser/parser.go
blob: b5307e81dac596da693b3abdc96083035ebc39ea (plain) (blame)
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
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
package parser

import (
	"crypto/sha256"
	"fmt"
	"net/url"
	"strconv"
	"strings"
	"time"
	"unicode/utf8"
	"github.com/Fuwn/asa-news/internal/model"
	"github.com/mmcdole/gofeed"
)

type Parser struct {
	gofeedParser *gofeed.Parser
}

func NewParser() *Parser {
	return &Parser{
		gofeedParser: gofeed.NewParser(),
	}
}

type ParseResult struct {
	Entries             []model.FeedEntry
	FeedTitle           string
	SiteURL             string
	AudioEnclosureRatio float64
}

func (feedParser *Parser) Parse(feedIdentifier string, ownerIdentifier *string, rawFeedContent []byte) (*ParseResult, error) {
	parsedFeed, parseError := feedParser.gofeedParser.ParseString(string(rawFeedContent))

	if parseError != nil {
		return nil, fmt.Errorf("failed to parse feed content: %w", parseError)
	}

	feedEntries := make([]model.FeedEntry, 0, len(parsedFeed.Items))
	audioEnclosureCount := 0

	for _, feedItem := range parsedFeed.Items {
		normalizedEntry := normalizeFeedItem(feedIdentifier, ownerIdentifier, feedItem)

		if normalizedEntry.EnclosureURL != nil {
			audioEnclosureCount++
		}

		feedEntries = append(feedEntries, normalizedEntry)
	}

	audioEnclosureRatio := 0.0

	if len(feedEntries) > 0 {
		audioEnclosureRatio = float64(audioEnclosureCount) / float64(len(feedEntries))
	}

	return &ParseResult{
		Entries:             feedEntries,
		FeedTitle:           strings.TrimSpace(parsedFeed.Title),
		SiteURL:             strings.TrimSpace(parsedFeed.Link),
		AudioEnclosureRatio: audioEnclosureRatio,
	}, nil
}

func normalizeFeedItem(feedIdentifier string, ownerIdentifier *string, feedItem *gofeed.Item) model.FeedEntry {
	globallyUniqueIdentifier := resolveGloballyUniqueIdentifier(feedItem)
	entryURL := stringPointerOrNil(resolveEntryURL(feedItem))
	entryTitle := stringPointerOrNil(strings.TrimSpace(feedItem.Title))
	entrySummary := stringPointerOrNil(strings.TrimSpace(feedItem.Description))
	entryContentHTML := stringPointerOrNil(resolveContentHTML(feedItem))
	entryContentText := resolveContentText(feedItem)
	authorName := stringPointerOrNil(resolveAuthorName(feedItem))
	publishedAt := resolvePublishedDate(feedItem)
	entryImageURL := stringPointerOrNil(resolveImageURL(feedItem))
	wordCount := countWords(entryContentText)
	enclosureURL, enclosureType, enclosureLength := resolveAudioEnclosure(feedItem)

	return model.FeedEntry{
		FeedIdentifier:  feedIdentifier,
		OwnerIdentifier: ownerIdentifier,
		GUID:            globallyUniqueIdentifier,
		URL:             entryURL,
		Title:           entryTitle,
		Author:          authorName,
		Summary:         entrySummary,
		ContentHTML:     entryContentHTML,
		ContentText:     stringPointerOrNil(entryContentText),
		ImageURL:        entryImageURL,
		PublishedAt:     publishedAt,
		WordCount:       wordCount,
		EnclosureURL:    enclosureURL,
		EnclosureType:   enclosureType,
		EnclosureLength: enclosureLength,
	}
}

func stringPointerOrNil(value string) *string {
	if value == "" {
		return nil
	}

	return &value
}

var trackingQueryParameters = map[string]bool{
	"utm_source":   true,
	"utm_medium":   true,
	"utm_campaign": true,
	"utm_term":     true,
	"utm_content":  true,
	"utm_id":       true,
	"ref":          true,
	"fbclid":       true,
	"gclid":        true,
	"mc_cid":       true,
	"mc_eid":       true,
	"_hsenc":       true,
	"_hsmi":        true,
	"source":       true,
	"dest":         true,
}

func normalizeGloballyUniqueIdentifier(rawIdentifier string) string {
	normalized := strings.TrimSpace(rawIdentifier)

	if !strings.HasPrefix(normalized, "http://") && !strings.HasPrefix(normalized, "https://") {
		return normalized
	}

	parsedURL, parseError := url.Parse(normalized)

	if parseError != nil {
		return normalized
	}

	queryParameters := parsedURL.Query()
	filteredParameters := url.Values{}

	for parameterName, parameterValues := range queryParameters {
		loweredName := strings.ToLower(parameterName)

		if !trackingQueryParameters[loweredName] {
			filteredParameters[parameterName] = parameterValues
		}
	}

	parsedURL.RawQuery = canonicalizeQueryString(filteredParameters)
	parsedURL.Fragment = ""

	return parsedURL.String()
}

func canonicalizeQueryString(parameters url.Values) string {
	if len(parameters) == 0 {
		return ""
	}

	return parameters.Encode()
}

func resolveGloballyUniqueIdentifier(feedItem *gofeed.Item) string {
	if feedItem.GUID != "" {
		return normalizeGloballyUniqueIdentifier(feedItem.GUID)
	}

	if feedItem.Link != "" {
		return normalizeGloballyUniqueIdentifier(feedItem.Link)
	}

	hashInput := strings.TrimSpace(feedItem.Title) + strings.TrimSpace(feedItem.Description)
	hashBytes := sha256.Sum256([]byte(hashInput))

	return fmt.Sprintf("sha256:%x", hashBytes)
}

func stripTrackingParameters(rawURL string) string {
	trimmedURL := strings.TrimSpace(rawURL)

	if !strings.HasPrefix(trimmedURL, "http://") && !strings.HasPrefix(trimmedURL, "https://") {
		return trimmedURL
	}

	parsedURL, parseError := url.Parse(trimmedURL)

	if parseError != nil {
		return trimmedURL
	}

	queryParameters := parsedURL.Query()
	filteredParameters := url.Values{}

	for parameterName, parameterValues := range queryParameters {
		loweredName := strings.ToLower(parameterName)

		if !trackingQueryParameters[loweredName] {
			filteredParameters[parameterName] = parameterValues
		}
	}

	parsedURL.RawQuery = canonicalizeQueryString(filteredParameters)

	return parsedURL.String()
}

func resolveEntryURL(feedItem *gofeed.Item) string {
	if feedItem.Link != "" {
		return stripTrackingParameters(feedItem.Link)
	}

	if feedItem.GUID != "" && strings.HasPrefix(feedItem.GUID, "http") {
		return stripTrackingParameters(feedItem.GUID)
	}

	return ""
}

func resolveContentHTML(feedItem *gofeed.Item) string {
	if feedItem.Content != "" {
		return feedItem.Content
	}

	return feedItem.Description
}

func resolveContentText(feedItem *gofeed.Item) string {
	contentSource := feedItem.Content

	if contentSource == "" {
		contentSource = feedItem.Description
	}

	return stripHTMLTags(contentSource)
}

func resolveAuthorName(feedItem *gofeed.Item) string {
	if feedItem.Author != nil && feedItem.Author.Name != "" {
		return feedItem.Author.Name
	}

	if len(feedItem.Authors) > 0 && feedItem.Authors[0].Name != "" {
		return feedItem.Authors[0].Name
	}

	return ""
}

func resolvePublishedDate(feedItem *gofeed.Item) *time.Time {
	if feedItem.PublishedParsed != nil {
		return feedItem.PublishedParsed
	}

	if feedItem.UpdatedParsed != nil {
		return feedItem.UpdatedParsed
	}

	return nil
}

func resolveAudioEnclosure(feedItem *gofeed.Item) (*string, *string, *int64) {
	if feedItem.Enclosures == nil {
		return nil, nil, nil
	}

	for _, enclosure := range feedItem.Enclosures {
		if strings.HasPrefix(enclosure.Type, "audio/") && enclosure.URL != "" {
			enclosureURL := enclosure.URL
			enclosureType := enclosure.Type

			var enclosureLength *int64

			if enclosure.Length != "" {
				if parsedLength, parseError := strconv.ParseInt(enclosure.Length, 10, 64); parseError == nil {
					enclosureLength = &parsedLength
				}
			}

			return &enclosureURL, &enclosureType, enclosureLength
		}
	}

	return nil, nil, nil
}

func resolveImageURL(feedItem *gofeed.Item) string {
	if feedItem.Image != nil && feedItem.Image.URL != "" {
		return feedItem.Image.URL
	}

	return ""
}

func countWords(plainText string) *int {
	if plainText == "" {
		return nil
	}

	count := len(strings.Fields(plainText))

	return &count
}

func stripHTMLTags(htmlContent string) string {
	var resultBuilder strings.Builder

	insideTag := false

	for characterIndex := 0; characterIndex < len(htmlContent); {
		currentRune, runeSize := utf8.DecodeRuneInString(htmlContent[characterIndex:])

		if currentRune == '<' {
			insideTag = true
		} else if currentRune == '>' {
			insideTag = false
		} else if !insideTag {
			resultBuilder.WriteRune(currentRune)
		}

		characterIndex += runeSize
	}

	return strings.TrimSpace(resultBuilder.String())
}