Add the possibility to override default user agent for each feed

api/feed.go

@@ -47,6 +47,7 @@ func (c *Controller) CreateFeed(w http.ResponseWriter, r *http.Request) {
 		feedInfo.CategoryID,
 		feedInfo.FeedURL,
 		feedInfo.Crawler,
+		feedInfo.UserAgent,
 		feedInfo.Username,
 		feedInfo.Password,
 	)

api/payload.go

@@ -26,15 +26,17 @@ type entriesResponse struct {
 type feedCreation struct {
 	FeedURL    string `json:"feed_url"`
 	CategoryID int64  `json:"category_id"`
+	UserAgent  string `json:"user_agent"`
 	Username   string `json:"username"`
 	Password   string `json:"password"`
 	Crawler    bool   `json:"crawler"`
 }
 
 type subscriptionDiscovery struct {
-	URL      string `json:"url"`
-	Username string `json:"username"`
-	Password string `json:"password"`
+	URL       string `json:"url"`
+	UserAgent string `json:"user_agent"`
+	Username  string `json:"username"`
+	Password  string `json:"password"`
 }
 
 type feedModification struct {
@@ -44,6 +46,7 @@ type feedModification struct {
 	ScraperRules *string `json:"scraper_rules"`
 	RewriteRules *string `json:"rewrite_rules"`
 	Crawler      *bool   `json:"crawler"`
+	UserAgent    *string `json:"user_agent"`
 	Username     *string `json:"username"`
 	Password     *string `json:"password"`
 	CategoryID   *int64  `json:"category_id"`
@@ -74,6 +77,10 @@ func (f *feedModification) Update(feed *model.Feed) {
 		feed.Crawler = *f.Crawler
 	}
 
+	if f.UserAgent != nil {
+		feed.UserAgent = *f.UserAgent
+	}
+
 	if f.Username != nil {
 		feed.Username = *f.Username
 	}

api/subscription.go

@@ -22,6 +22,7 @@ func (c *Controller) GetSubscriptions(w http.ResponseWriter, r *http.Request) {
 
 	subscriptions, err := subscription.FindSubscriptions(
 		subscriptionInfo.URL,
+		subscriptionInfo.UserAgent,
 		subscriptionInfo.Username,
 		subscriptionInfo.Password,
 	)

client/core.go

@@ -91,6 +91,7 @@ type Feed struct {
 	ScraperRules       string    `json:"scraper_rules"`
 	RewriteRules       string    `json:"rewrite_rules"`
 	Crawler            bool      `json:"crawler"`
+	UserAgent          string    `json:"user_agent"`
 	Username           string    `json:"username"`
 	Password           string    `json:"password"`
 	Category           *Category `json:"category,omitempty"`
@@ -105,6 +106,7 @@ type FeedModification struct {
 	ScraperRules *string `json:"scraper_rules"`
 	RewriteRules *string `json:"rewrite_rules"`
 	Crawler      *bool   `json:"crawler"`
+	UserAgent    *string `json:"user_agent"`
 	Username     *string `json:"username"`
 	Password     *string `json:"password"`
 	CategoryID   *int64  `json:"category_id"`

database/migration.go

@@ -12,7 +12,7 @@ import (
 	"miniflux.app/logger"
 )
 
-const schemaVersion = 20
+const schemaVersion = 21
 
 // Migrate executes database migrations.
 func Migrate(db *sql.DB) {

database/sql/schema_version_21.sql

@@ -0,0 +1 @@
+alter table feeds add column user_agent text default '';

http/client/client.go

@@ -33,6 +33,9 @@ const (
 )
 
 var (
+	// DefaultUserAgent sets the User-Agent header used for any requests by miniflux.
+	DefaultUserAgent = "Mozilla/5.0 (compatible; Miniflux/" + version.Version + "; +https://miniflux.app)"
+
 	errInvalidCertificate        = "Invalid SSL certificate (original error: %q)"
 	errTemporaryNetworkOperation = "This website is temporarily unreachable (original error: %q)"
 	errPermanentNetworkOperation = "This website is permanently unreachable (original error: %q)"
@@ -47,6 +50,7 @@ type Client struct {
 	authorizationHeader string
 	username            string
 	password            string
+	userAgent           string
 	Insecure            bool
 }
 
@@ -72,6 +76,14 @@ func (c *Client) WithCacheHeaders(etagHeader, lastModifiedHeader string) *Client
 	return c
 }
 
+// WithUserAgent defines the User-Agent header to use for outgoing requests.
+func (c *Client) WithUserAgent(userAgent string) *Client {
+	if userAgent != "" {
+		c.userAgent = userAgent
+	}
+	return c
+}
+
 // Get execute a GET HTTP request.
 func (c *Client) Get() (*Response, error) {
 	request, err := c.buildRequest(http.MethodGet, nil)
@@ -212,7 +224,7 @@ func (c *Client) buildClient() http.Client {
 
 func (c *Client) buildHeaders() http.Header {
 	headers := make(http.Header)
-	headers.Add("User-Agent", "Mozilla/5.0 (compatible; Miniflux/"+version.Version+"; +https://miniflux.app)")
+	headers.Add("User-Agent", c.userAgent)
 	headers.Add("Accept", "*/*")
 
 	if c.etagHeader != "" {
@@ -233,5 +245,5 @@ func (c *Client) buildHeaders() http.Header {
 
 // New returns a new HTTP client.
 func New(url string) *Client {
-	return &Client{url: url, Insecure: false}
+	return &Client{url: url, userAgent: DefaultUserAgent, Insecure: false}
 }

model/feed.go

@@ -24,6 +24,7 @@ type Feed struct {
 	ScraperRules       string    `json:"scraper_rules"`
 	RewriteRules       string    `json:"rewrite_rules"`
 	Crawler            bool      `json:"crawler"`
+	UserAgent          string    `json:"user_agent"`
 	Username           string    `json:"username"`
 	Password           string    `json:"password"`
 	Category           *Category `json:"category,omitempty"`

reader/feed/handler.go

@@ -37,7 +37,7 @@ type Handler struct {
 }
 
 // CreateFeed fetch, parse and store a new feed.
-func (h *Handler) CreateFeed(userID, categoryID int64, url string, crawler bool, username, password string) (*model.Feed, error) {
+func (h *Handler) CreateFeed(userID, categoryID int64, url string, crawler bool, userAgent, username, password string) (*model.Feed, error) {
 	defer timer.ExecutionTime(time.Now(), fmt.Sprintf("[Handler:CreateFeed] feedUrl=%s", url))
 
 	if !h.store.CategoryExists(userID, categoryID) {
@@ -46,6 +46,7 @@ func (h *Handler) CreateFeed(userID, categoryID int64, url string, crawler bool,
 
 	clt := client.New(url)
 	clt.WithCredentials(username, password)
+	clt.WithUserAgent(userAgent)
 	response, err := clt.Get()
 	if err != nil {
 		if _, ok := err.(*errors.LocalizedError); ok {
@@ -87,6 +88,7 @@ func (h *Handler) CreateFeed(userID, categoryID int64, url string, crawler bool,
 	subscription.FeedURL = response.EffectiveURL
 	subscription.UserID = userID
 	subscription.Crawler = crawler
+	subscription.UserAgent = userAgent
 	subscription.Username = username
 	subscription.Password = password
 
@@ -136,6 +138,7 @@ func (h *Handler) RefreshFeed(userID, feedID int64) error {
 	clt := client.New(originalFeed.FeedURL)
 	clt.WithCredentials(originalFeed.Username, originalFeed.Password)
 	clt.WithCacheHeaders(originalFeed.EtagHeader, originalFeed.LastModifiedHeader)
+	clt.WithUserAgent(originalFeed.UserAgent)
 	response, err := clt.Get()
 	if err != nil {
 		var customErr errors.LocalizedError
@@ -196,6 +199,7 @@ func (h *Handler) RefreshFeed(userID, feedID int64) error {
 
 		feedProcessor := processor.NewFeedProcessor(userID, h.store, subscription)
 		feedProcessor.WithScraperRules(originalFeed.ScraperRules)
+		feedProcessor.WithUserAgent(originalFeed.UserAgent)
 		feedProcessor.WithRewriteRules(originalFeed.RewriteRules)
 		feedProcessor.WithCrawler(originalFeed.Crawler)
 		feedProcessor.Process()

reader/processor/processor.go

@@ -21,6 +21,7 @@ type FeedProcessor struct {
 	scraperRules string
 	rewriteRules string
 	crawler      bool
+	userAgent    string
 }
 
 // WithCrawler enables the crawler.
@@ -33,6 +34,11 @@ func (f *FeedProcessor) WithScraperRules(rules string) {
 	f.scraperRules = rules
 }
 
+// WithUserAgent sets the User-Agent header for fetching article content.
+func (f *FeedProcessor) WithUserAgent(userAgent string) {
+	f.userAgent = userAgent
+}
+
 // WithRewriteRules adds rewrite rules to the processing.
 func (f *FeedProcessor) WithRewriteRules(rules string) {
 	f.rewriteRules = rules
@@ -45,7 +51,7 @@ func (f *FeedProcessor) Process() {
 			if f.store.EntryURLExists(f.userID, entry.URL) {
 				logger.Debug(`[FeedProcessor] Do not crawl existing entry URL: "%s"`, entry.URL)
 			} else {
-				content, err := scraper.Fetch(entry.URL, f.scraperRules)
+				content, err := scraper.Fetch(entry.URL, f.scraperRules, f.userAgent)
 				if err != nil {
 					logger.Error("[FeedProcessor] %v", err)
 				} else {

reader/scraper/scraper.go

@@ -19,8 +19,12 @@ import (
 )
 
 // Fetch downloads a web page a returns relevant contents.
-func Fetch(websiteURL, rules string) (string, error) {
+func Fetch(websiteURL, rules, userAgent string) (string, error) {
 	clt := client.New(websiteURL)
+	if userAgent != "" {
+		clt.WithUserAgent(userAgent)
+	}
+
 	response, err := clt.Get()
 	if err != nil {
 		return "", err

reader/subscription/finder.go

@@ -29,11 +29,12 @@ var (
 )
 
 // FindSubscriptions downloads and try to find one or more subscriptions from an URL.
-func FindSubscriptions(websiteURL, username, password string) (Subscriptions, error) {
+func FindSubscriptions(websiteURL, userAgent, username, password string) (Subscriptions, error) {
 	defer timer.ExecutionTime(time.Now(), fmt.Sprintf("[FindSubscriptions] url=%s", websiteURL))
 
 	clt := client.New(websiteURL)
 	clt.WithCredentials(username, password)
+	clt.WithUserAgent(userAgent)
 	response, err := clt.Get()
 	if err != nil {
 		if _, ok := err.(errors.LocalizedError); ok {

storage/entry_query_builder.go

@@ -192,7 +192,7 @@ func (e *EntryQueryBuilder) GetEntries() (model.Entries, error) {
 		e.id, e.user_id, e.feed_id, e.hash, e.published_at at time zone u.timezone, e.title,
 		e.url, e.comments_url, e.author, e.content, e.status, e.starred,
 		f.title as feed_title, f.feed_url, f.site_url, f.checked_at,
-		f.category_id, c.title as category_title, f.scraper_rules, f.rewrite_rules, f.crawler,
+		f.category_id, c.title as category_title, f.scraper_rules, f.rewrite_rules, f.crawler, f.user_agent,
 		fi.icon_id,
 		u.timezone
 		FROM entries e
@@ -247,6 +247,7 @@ func (e *EntryQueryBuilder) GetEntries() (model.Entries, error) {
 			&entry.Feed.ScraperRules,
 			&entry.Feed.RewriteRules,
 			&entry.Feed.Crawler,
+			&entry.Feed.UserAgent,
 			&iconID,
 			&tz,
 		)

storage/feed.go

@@ -66,7 +66,7 @@ func (s *Storage) Feeds(userID int64) (model.Feeds, error) {
 		f.id, f.feed_url, f.site_url, f.title, f.etag_header, f.last_modified_header,
 		f.user_id, f.checked_at at time zone u.timezone,
 		f.parsing_error_count, f.parsing_error_msg,
-		f.scraper_rules, f.rewrite_rules, f.crawler,
+		f.scraper_rules, f.rewrite_rules, f.crawler, f.user_agent,
 		f.username, f.password,
 		f.category_id, c.title as category_title,
 		fi.icon_id,
@@ -104,6 +104,7 @@ func (s *Storage) Feeds(userID int64) (model.Feeds, error) {
 			&feed.ScraperRules,
 			&feed.RewriteRules,
 			&feed.Crawler,
+			&feed.UserAgent,
 			&feed.Username,
 			&feed.Password,
 			&feed.Category.ID,
@@ -141,7 +142,7 @@ func (s *Storage) FeedByID(userID, feedID int64) (*model.Feed, error) {
 		f.id, f.feed_url, f.site_url, f.title, f.etag_header, f.last_modified_header,
 		f.user_id, f.checked_at at time zone u.timezone,
 		f.parsing_error_count, f.parsing_error_msg,
-		f.scraper_rules, f.rewrite_rules, f.crawler,
+		f.scraper_rules, f.rewrite_rules, f.crawler, f.user_agent,
 		f.username, f.password,
 		f.category_id, c.title as category_title,
 		fi.icon_id,
@@ -166,6 +167,7 @@ func (s *Storage) FeedByID(userID, feedID int64) (*model.Feed, error) {
 		&feed.ScraperRules,
 		&feed.RewriteRules,
 		&feed.Crawler,
+		&feed.UserAgent,
 		&feed.Username,
 		&feed.Password,
 		&feed.Category.ID,
@@ -194,8 +196,8 @@ func (s *Storage) CreateFeed(feed *model.Feed) error {
 	defer timer.ExecutionTime(time.Now(), fmt.Sprintf("[Storage:CreateFeed] feedURL=%s", feed.FeedURL))
 	sql := `
 		INSERT INTO feeds
-		(feed_url, site_url, title, category_id, user_id, etag_header, last_modified_header, crawler, username, password)
-		VALUES ($1, $2, $3, $4, $5, $6, $7, $8, $9, $10)
+		(feed_url, site_url, title, category_id, user_id, etag_header, last_modified_header, crawler, user_agent, username, password)
+		VALUES ($1, $2, $3, $4, $5, $6, $7, $8, $9, $10, $11)
 		RETURNING id
 	`
 
@@ -209,6 +211,7 @@ func (s *Storage) CreateFeed(feed *model.Feed) error {
 		feed.EtagHeader,
 		feed.LastModifiedHeader,
 		feed.Crawler,
+		feed.UserAgent,
 		feed.Username,
 		feed.Password,
 	).Scan(&feed.ID)
@@ -234,9 +237,9 @@ func (s *Storage) UpdateFeed(feed *model.Feed) (err error) {
 
 	query := `UPDATE feeds SET
 		feed_url=$1, site_url=$2, title=$3, category_id=$4, etag_header=$5, last_modified_header=$6, checked_at=$7,
-		parsing_error_msg=$8, parsing_error_count=$9, scraper_rules=$10, rewrite_rules=$11, crawler=$12,
-		username=$13, password=$14
-		WHERE id=$15 AND user_id=$16`
+		parsing_error_msg=$8, parsing_error_count=$9, scraper_rules=$10, rewrite_rules=$11, crawler=$12, user_agent=$13,
+		username=$14, password=$15
+		WHERE id=$16 AND user_id=$17`
 
 	_, err = s.db.Exec(query,
 		feed.FeedURL,
@@ -251,6 +254,7 @@ func (s *Storage) UpdateFeed(feed *model.Feed) (err error) {
 		feed.ScraperRules,
 		feed.RewriteRules,
 		feed.Crawler,
+		feed.UserAgent,
 		feed.Username,
 		feed.Password,
 		feed.ID,

template/html/add_subscription.html

@@ -41,6 +41,9 @@ <h1>{{ t "New Subscription" }}</h1>
 
             <label><input type="checkbox" name="crawler" value="1" {{ if .form.Crawler }}checked{{ end }}> {{ t "Fetch original content" }}</label>
 
+	        <label for="form-user-agent">{{ t "User-Agent" }}</label>
+	        <input type="text" name="user_agent" id="form-user-agent" placeholder="{{ .defaultUserAgent }}" value="{{ .form.UserAgent }}">
+
             <label for="form-feed-username">{{ t "Feed Username" }}</label>
             <input type="text" name="feed_username" id="form-feed-username" value="{{ .form.Username }}">
 

template/html/choose_subscription.html

@@ -19,6 +19,7 @@ <h1>{{ t "New Subscription" }}</h1>
 <form action="{{ route "chooseSubscription" }}" method="POST">
     <input type="hidden" name="csrf" value="{{ .csrf }}">
     <input type="hidden" name="category_id" value="{{ .form.CategoryID }}">
+    <input type="hidden" name="user_agent" value="{{ .form.UserAgent }}">
     <input type="hidden" name="feed_username" value="{{ .form.Username }}">
     <input type="hidden" name="feed_password" value="{{ .form.Password }}">
     {{ if .form.Crawler }}

template/html/edit_feed.html

@@ -58,6 +58,9 @@ <h3>{{ t "Last Parsing Error" }}</h3>
         -->
         <input type="text" name="feed_password" id="form-feed-password" value="{{ .form.Password }}">
 
+	    <label for="form-user-agent">{{ t "User-Agent" }}</label>
+	    <input type="text" name="user_agent" id="form-user-agent" placeholder="{{ .defaultUserAgent }}" value="{{ .form.UserAgent }}">
+
         <label for="form-scraper-rules">{{ t "Scraper Rules" }}</label>
         <input type="text" name="scraper_rules" id="form-scraper-rules" value="{{ .form.ScraperRules }}">