129 lines
4.2 KiB
Go
129 lines
4.2 KiB
Go
// Copyright 2017 Frédéric Guillot. All rights reserved.
|
|
// Use of this source code is governed by the Apache 2.0
|
|
// license that can be found in the LICENSE file.
|
|
|
|
package model // import "miniflux.app/model"
|
|
|
|
import (
|
|
"fmt"
|
|
"math"
|
|
"time"
|
|
|
|
"miniflux.app/config"
|
|
"miniflux.app/http/client"
|
|
)
|
|
|
|
// Feed represents a feed in the application.
|
|
type Feed struct {
|
|
ID int64 `json:"id"`
|
|
UserID int64 `json:"user_id"`
|
|
FeedURL string `json:"feed_url"`
|
|
SiteURL string `json:"site_url"`
|
|
Title string `json:"title"`
|
|
CheckedAt time.Time `json:"checked_at"`
|
|
NextCheckAt time.Time `json:"next_check_at"`
|
|
EtagHeader string `json:"etag_header"`
|
|
LastModifiedHeader string `json:"last_modified_header"`
|
|
ParsingErrorMsg string `json:"parsing_error_message"`
|
|
ParsingErrorCount int `json:"parsing_error_count"`
|
|
ScraperRules string `json:"scraper_rules"`
|
|
RewriteRules string `json:"rewrite_rules"`
|
|
Crawler bool `json:"crawler"`
|
|
BlocklistRules string `json:"blocklist_rules"`
|
|
KeeplistRules string `json:"keeplist_rules"`
|
|
UserAgent string `json:"user_agent"`
|
|
Username string `json:"username"`
|
|
Password string `json:"password"`
|
|
Disabled bool `json:"disabled"`
|
|
IgnoreHTTPCache bool `json:"ignore_http_cache"`
|
|
FetchViaProxy bool `json:"fetch_via_proxy"`
|
|
Category *Category `json:"category,omitempty"`
|
|
Entries Entries `json:"entries,omitempty"`
|
|
Icon *FeedIcon `json:"icon"`
|
|
UnreadCount int `json:"-"`
|
|
ReadCount int `json:"-"`
|
|
}
|
|
|
|
// List of supported schedulers.
|
|
const (
|
|
SchedulerRoundRobin = "round_robin"
|
|
SchedulerEntryFrequency = "entry_frequency"
|
|
)
|
|
|
|
func (f *Feed) String() string {
|
|
return fmt.Sprintf("ID=%d, UserID=%d, FeedURL=%s, SiteURL=%s, Title=%s, Category={%s}",
|
|
f.ID,
|
|
f.UserID,
|
|
f.FeedURL,
|
|
f.SiteURL,
|
|
f.Title,
|
|
f.Category,
|
|
)
|
|
}
|
|
|
|
// WithClientResponse updates feed attributes from an HTTP request.
|
|
func (f *Feed) WithClientResponse(response *client.Response) {
|
|
f.EtagHeader = response.ETag
|
|
f.LastModifiedHeader = response.LastModified
|
|
f.FeedURL = response.EffectiveURL
|
|
}
|
|
|
|
// WithCategoryID initializes the category attribute of the feed.
|
|
func (f *Feed) WithCategoryID(categoryID int64) {
|
|
f.Category = &Category{ID: categoryID}
|
|
}
|
|
|
|
// WithBrowsingParameters defines browsing parameters.
|
|
func (f *Feed) WithBrowsingParameters(crawler bool, userAgent, username, password, scraperRules, rewriteRules, blocklistRules, keeplistRules string, fetchViaProxy bool) {
|
|
f.Crawler = crawler
|
|
f.UserAgent = userAgent
|
|
f.Username = username
|
|
f.Password = password
|
|
f.ScraperRules = scraperRules
|
|
f.RewriteRules = rewriteRules
|
|
f.FetchViaProxy = fetchViaProxy
|
|
f.BlocklistRules = blocklistRules
|
|
f.KeeplistRules = keeplistRules
|
|
}
|
|
|
|
// WithError adds a new error message and increment the error counter.
|
|
func (f *Feed) WithError(message string) {
|
|
f.ParsingErrorCount++
|
|
f.ParsingErrorMsg = message
|
|
}
|
|
|
|
// ResetErrorCounter removes all previous errors.
|
|
func (f *Feed) ResetErrorCounter() {
|
|
f.ParsingErrorCount = 0
|
|
f.ParsingErrorMsg = ""
|
|
}
|
|
|
|
// CheckedNow set attribute values when the feed is refreshed.
|
|
func (f *Feed) CheckedNow() {
|
|
f.CheckedAt = time.Now()
|
|
|
|
if f.SiteURL == "" {
|
|
f.SiteURL = f.FeedURL
|
|
}
|
|
}
|
|
|
|
// ScheduleNextCheck set "next_check_at" of a feed based on the scheduler selected from the configuration.
|
|
func (f *Feed) ScheduleNextCheck(weeklyCount int) {
|
|
switch config.Opts.PollingScheduler() {
|
|
case SchedulerEntryFrequency:
|
|
var intervalMinutes int
|
|
if weeklyCount == 0 {
|
|
intervalMinutes = config.Opts.SchedulerEntryFrequencyMaxInterval()
|
|
} else {
|
|
intervalMinutes = int(math.Round(float64(7*24*60) / float64(weeklyCount)))
|
|
}
|
|
intervalMinutes = int(math.Min(float64(intervalMinutes), float64(config.Opts.SchedulerEntryFrequencyMaxInterval())))
|
|
intervalMinutes = int(math.Max(float64(intervalMinutes), float64(config.Opts.SchedulerEntryFrequencyMinInterval())))
|
|
f.NextCheckAt = time.Now().Add(time.Minute * time.Duration(intervalMinutes))
|
|
default:
|
|
f.NextCheckAt = time.Now()
|
|
}
|
|
}
|
|
|
|
// Feeds is a list of feed
|
|
type Feeds []*Feed
|