mirror of
https://github.com/miniflux/v2.git
synced 2025-08-26 18:21:01 +00:00
ed3bf59356
In general, duration is used as time unit representation. At some places when int is returned, there's no documentation which unit is used. So just convert to time.Duration ASAP.
317 lines
11 KiB
Go
317 lines
11 KiB
Go
// SPDX-FileCopyrightText: Copyright The Miniflux Authors. All rights reserved.
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
package model // import "miniflux.app/v2/internal/model"
|
|
|
|
import (
|
|
"fmt"
|
|
"io"
|
|
"time"
|
|
|
|
"miniflux.app/v2/internal/config"
|
|
)
|
|
|
|
// List of supported schedulers.
|
|
const (
|
|
SchedulerRoundRobin = "round_robin"
|
|
SchedulerEntryFrequency = "entry_frequency"
|
|
// Default settings for the feed query builder
|
|
DefaultFeedSorting = "parsing_error_count"
|
|
DefaultFeedSortingDirection = "desc"
|
|
)
|
|
|
|
// 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"`
|
|
Description string `json:"description"`
|
|
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"`
|
|
BlocklistRules string `json:"blocklist_rules"`
|
|
KeeplistRules string `json:"keeplist_rules"`
|
|
BlockFilterEntryRules string `json:"block_filter_entry_rules"`
|
|
KeepFilterEntryRules string `json:"keep_filter_entry_rules"`
|
|
UrlRewriteRules string `json:"urlrewrite_rules"`
|
|
UserAgent string `json:"user_agent"`
|
|
Cookie string `json:"cookie"`
|
|
Username string `json:"username"`
|
|
Password string `json:"password"`
|
|
Disabled bool `json:"disabled"`
|
|
NoMediaPlayer bool `json:"no_media_player"`
|
|
IgnoreHTTPCache bool `json:"ignore_http_cache"`
|
|
AllowSelfSignedCertificates bool `json:"allow_self_signed_certificates"`
|
|
FetchViaProxy bool `json:"fetch_via_proxy"`
|
|
HideGlobally bool `json:"hide_globally"`
|
|
DisableHTTP2 bool `json:"disable_http2"`
|
|
PushoverEnabled bool `json:"pushover_enabled"`
|
|
NtfyEnabled bool `json:"ntfy_enabled"`
|
|
Crawler bool `json:"crawler"`
|
|
AppriseServiceURLs string `json:"apprise_service_urls"`
|
|
WebhookURL string `json:"webhook_url"`
|
|
NtfyPriority int `json:"ntfy_priority"`
|
|
NtfyTopic string `json:"ntfy_topic"`
|
|
PushoverPriority int `json:"pushover_priority"`
|
|
ProxyURL string `json:"proxy_url"`
|
|
|
|
// Non-persisted attributes
|
|
Category *Category `json:"category,omitempty"`
|
|
Icon *FeedIcon `json:"icon"`
|
|
Entries Entries `json:"entries,omitempty"`
|
|
|
|
// Internal attributes (not exposed in the API and not persisted in the database)
|
|
TTL time.Duration `json:"-"`
|
|
IconURL string `json:"-"`
|
|
UnreadCount int `json:"-"`
|
|
ReadCount int `json:"-"`
|
|
NumberOfVisibleEntries int `json:"-"`
|
|
}
|
|
|
|
type FeedCounters struct {
|
|
ReadCounters map[int64]int `json:"reads"`
|
|
UnreadCounters map[int64]int `json:"unreads"`
|
|
}
|
|
|
|
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,
|
|
)
|
|
}
|
|
|
|
// WithCategoryID initializes the category attribute of the feed.
|
|
func (f *Feed) WithCategoryID(categoryID int64) {
|
|
f.Category = &Category{ID: categoryID}
|
|
}
|
|
|
|
// WithTranslatedErrorMessage adds a new error message and increment the error counter.
|
|
func (f *Feed) WithTranslatedErrorMessage(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, refreshDelay time.Duration) time.Duration {
|
|
// Default to the global config Polling Frequency.
|
|
interval := config.Opts.SchedulerRoundRobinMinInterval()
|
|
|
|
if config.Opts.PollingScheduler() == SchedulerEntryFrequency {
|
|
if weeklyCount <= 0 {
|
|
interval = config.Opts.SchedulerEntryFrequencyMaxInterval()
|
|
} else {
|
|
interval = (7 * 24 * time.Hour) / time.Duration(weeklyCount*config.Opts.SchedulerEntryFrequencyFactor())
|
|
interval = min(interval, config.Opts.SchedulerEntryFrequencyMaxInterval())
|
|
interval = max(interval, config.Opts.SchedulerEntryFrequencyMinInterval())
|
|
}
|
|
}
|
|
|
|
// Use the RSS TTL field, Retry-After, Cache-Control or Expires HTTP headers if defined.
|
|
interval = max(interval, refreshDelay)
|
|
|
|
// Limit the max interval value for misconfigured feeds.
|
|
switch config.Opts.PollingScheduler() {
|
|
case SchedulerRoundRobin:
|
|
interval = min(interval, config.Opts.SchedulerRoundRobinMaxInterval())
|
|
case SchedulerEntryFrequency:
|
|
interval = min(interval, config.Opts.SchedulerEntryFrequencyMaxInterval())
|
|
}
|
|
|
|
f.NextCheckAt = time.Now().Add(interval)
|
|
return interval
|
|
}
|
|
|
|
// FeedCreationRequest represents the request to create a feed.
|
|
type FeedCreationRequest struct {
|
|
FeedURL string `json:"feed_url"`
|
|
CategoryID int64 `json:"category_id"`
|
|
UserAgent string `json:"user_agent"`
|
|
Cookie string `json:"cookie"`
|
|
Username string `json:"username"`
|
|
Password string `json:"password"`
|
|
Crawler bool `json:"crawler"`
|
|
Disabled bool `json:"disabled"`
|
|
NoMediaPlayer bool `json:"no_media_player"`
|
|
IgnoreHTTPCache bool `json:"ignore_http_cache"`
|
|
AllowSelfSignedCertificates bool `json:"allow_self_signed_certificates"`
|
|
FetchViaProxy bool `json:"fetch_via_proxy"`
|
|
HideGlobally bool `json:"hide_globally"`
|
|
DisableHTTP2 bool `json:"disable_http2"`
|
|
ScraperRules string `json:"scraper_rules"`
|
|
RewriteRules string `json:"rewrite_rules"`
|
|
BlocklistRules string `json:"blocklist_rules"`
|
|
KeeplistRules string `json:"keeplist_rules"`
|
|
BlockFilterEntryRules string `json:"block_filter_entry_rules"`
|
|
KeepFilterEntryRules string `json:"keep_filter_entry_rules"`
|
|
UrlRewriteRules string `json:"urlrewrite_rules"`
|
|
ProxyURL string `json:"proxy_url"`
|
|
}
|
|
|
|
type FeedCreationRequestFromSubscriptionDiscovery struct {
|
|
Content io.ReadSeeker
|
|
ETag string
|
|
LastModified string
|
|
|
|
FeedCreationRequest
|
|
}
|
|
|
|
// FeedModificationRequest represents the request to update a feed.
|
|
type FeedModificationRequest struct {
|
|
FeedURL *string `json:"feed_url"`
|
|
SiteURL *string `json:"site_url"`
|
|
Title *string `json:"title"`
|
|
Description *string `json:"description"`
|
|
ScraperRules *string `json:"scraper_rules"`
|
|
RewriteRules *string `json:"rewrite_rules"`
|
|
BlocklistRules *string `json:"blocklist_rules"`
|
|
UrlRewriteRules *string `json:"urlrewrite_rules"`
|
|
KeeplistRules *string `json:"keeplist_rules"`
|
|
BlockFilterEntryRules *string `json:"block_filter_entry_rules"`
|
|
KeepFilterEntryRules *string `json:"keep_filter_entry_rules"`
|
|
Crawler *bool `json:"crawler"`
|
|
UserAgent *string `json:"user_agent"`
|
|
Cookie *string `json:"cookie"`
|
|
Username *string `json:"username"`
|
|
Password *string `json:"password"`
|
|
CategoryID *int64 `json:"category_id"`
|
|
Disabled *bool `json:"disabled"`
|
|
NoMediaPlayer *bool `json:"no_media_player"`
|
|
IgnoreHTTPCache *bool `json:"ignore_http_cache"`
|
|
AllowSelfSignedCertificates *bool `json:"allow_self_signed_certificates"`
|
|
FetchViaProxy *bool `json:"fetch_via_proxy"`
|
|
HideGlobally *bool `json:"hide_globally"`
|
|
DisableHTTP2 *bool `json:"disable_http2"`
|
|
ProxyURL *string `json:"proxy_url"`
|
|
}
|
|
|
|
// Patch updates a feed with modified values.
|
|
func (f *FeedModificationRequest) Patch(feed *Feed) {
|
|
if f.FeedURL != nil && *f.FeedURL != "" {
|
|
feed.FeedURL = *f.FeedURL
|
|
}
|
|
|
|
if f.SiteURL != nil && *f.SiteURL != "" {
|
|
feed.SiteURL = *f.SiteURL
|
|
}
|
|
|
|
if f.Title != nil && *f.Title != "" {
|
|
feed.Title = *f.Title
|
|
}
|
|
|
|
if f.Description != nil && *f.Description != "" {
|
|
feed.Description = *f.Description
|
|
}
|
|
|
|
if f.ScraperRules != nil {
|
|
feed.ScraperRules = *f.ScraperRules
|
|
}
|
|
|
|
if f.RewriteRules != nil {
|
|
feed.RewriteRules = *f.RewriteRules
|
|
}
|
|
|
|
if f.UrlRewriteRules != nil {
|
|
feed.UrlRewriteRules = *f.UrlRewriteRules
|
|
}
|
|
|
|
if f.KeeplistRules != nil {
|
|
feed.KeeplistRules = *f.KeeplistRules
|
|
}
|
|
|
|
if f.BlocklistRules != nil {
|
|
feed.BlocklistRules = *f.BlocklistRules
|
|
}
|
|
|
|
if f.BlockFilterEntryRules != nil {
|
|
feed.BlockFilterEntryRules = *f.BlockFilterEntryRules
|
|
}
|
|
|
|
if f.KeepFilterEntryRules != nil {
|
|
feed.KeepFilterEntryRules = *f.KeepFilterEntryRules
|
|
}
|
|
|
|
if f.Crawler != nil {
|
|
feed.Crawler = *f.Crawler
|
|
}
|
|
|
|
if f.UserAgent != nil {
|
|
feed.UserAgent = *f.UserAgent
|
|
}
|
|
|
|
if f.Cookie != nil {
|
|
feed.Cookie = *f.Cookie
|
|
}
|
|
|
|
if f.Username != nil {
|
|
feed.Username = *f.Username
|
|
}
|
|
|
|
if f.Password != nil {
|
|
feed.Password = *f.Password
|
|
}
|
|
|
|
if f.CategoryID != nil && *f.CategoryID > 0 {
|
|
feed.Category.ID = *f.CategoryID
|
|
}
|
|
|
|
if f.Disabled != nil {
|
|
feed.Disabled = *f.Disabled
|
|
}
|
|
|
|
if f.NoMediaPlayer != nil {
|
|
feed.NoMediaPlayer = *f.NoMediaPlayer
|
|
}
|
|
|
|
if f.IgnoreHTTPCache != nil {
|
|
feed.IgnoreHTTPCache = *f.IgnoreHTTPCache
|
|
}
|
|
|
|
if f.AllowSelfSignedCertificates != nil {
|
|
feed.AllowSelfSignedCertificates = *f.AllowSelfSignedCertificates
|
|
}
|
|
|
|
if f.FetchViaProxy != nil {
|
|
feed.FetchViaProxy = *f.FetchViaProxy
|
|
}
|
|
|
|
if f.HideGlobally != nil {
|
|
feed.HideGlobally = *f.HideGlobally
|
|
}
|
|
|
|
if f.DisableHTTP2 != nil {
|
|
feed.DisableHTTP2 = *f.DisableHTTP2
|
|
}
|
|
|
|
if f.ProxyURL != nil {
|
|
feed.ProxyURL = *f.ProxyURL
|
|
}
|
|
}
|
|
|
|
// Feeds is a list of feed
|
|
type Feeds []*Feed
|