mirror of
https://github.com/miniflux/v2.git
synced 2024-09-27 21:02:41 +02:00
41a2b7e58e
A new "shareCode" field is generated for each entry, and allows unlogged users to access the entry through the /shared endpoint. This feature is particularly useful to share articles from miniflux to third-party users without having them to visit the original source. The image proxy is disabled and special cache headers are proposed in the shared page to avoid denial of service.
94 lines
2.6 KiB
Go
94 lines
2.6 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"
|
|
"time"
|
|
)
|
|
|
|
// Entry statuses
|
|
const (
|
|
EntryStatusUnread = "unread"
|
|
EntryStatusRead = "read"
|
|
EntryStatusRemoved = "removed"
|
|
DefaultSortingOrder = "published_at"
|
|
DefaultSortingDirection = "asc"
|
|
)
|
|
|
|
// Entry represents a feed item in the system.
|
|
type Entry struct {
|
|
ID int64 `json:"id"`
|
|
UserID int64 `json:"user_id"`
|
|
FeedID int64 `json:"feed_id"`
|
|
Status string `json:"status"`
|
|
Hash string `json:"hash"`
|
|
Title string `json:"title"`
|
|
URL string `json:"url"`
|
|
CommentsURL string `json:"comments_url"`
|
|
Date time.Time `json:"published_at"`
|
|
Content string `json:"content"`
|
|
Author string `json:"author"`
|
|
ShareCode string `json:"share_code"`
|
|
Starred bool `json:"starred"`
|
|
Enclosures EnclosureList `json:"enclosures,omitempty"`
|
|
Feed *Feed `json:"feed,omitempty"`
|
|
}
|
|
|
|
// Entries represents a list of entries.
|
|
type Entries []*Entry
|
|
|
|
// ValidateEntryStatus makes sure the entry status is valid.
|
|
func ValidateEntryStatus(status string) error {
|
|
switch status {
|
|
case EntryStatusRead, EntryStatusUnread, EntryStatusRemoved:
|
|
return nil
|
|
}
|
|
|
|
return fmt.Errorf(`Invalid entry status, valid status values are: "%s", "%s" and "%s"`, EntryStatusRead, EntryStatusUnread, EntryStatusRemoved)
|
|
}
|
|
|
|
// ValidateEntryOrder makes sure the sorting order is valid.
|
|
func ValidateEntryOrder(order string) error {
|
|
switch order {
|
|
case "id", "status", "changed_at", "published_at", "category_title", "category_id":
|
|
return nil
|
|
}
|
|
|
|
return fmt.Errorf(`Invalid entry order, valid order values are: "id", "status", "changed_at", "published_at", "category_title", "category_id"`)
|
|
}
|
|
|
|
// ValidateDirection makes sure the sorting direction is valid.
|
|
func ValidateDirection(direction string) error {
|
|
switch direction {
|
|
case "asc", "desc":
|
|
return nil
|
|
}
|
|
|
|
return fmt.Errorf(`Invalid direction, valid direction values are: "asc" or "desc"`)
|
|
}
|
|
|
|
// ValidateRange makes sure the offset/limit values are valid.
|
|
func ValidateRange(offset, limit int) error {
|
|
if offset < 0 {
|
|
return fmt.Errorf(`Offset value should be >= 0`)
|
|
}
|
|
|
|
if limit < 0 {
|
|
return fmt.Errorf(`Limit value should be >= 0`)
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// OppositeDirection returns the opposite sorting direction.
|
|
func OppositeDirection(direction string) string {
|
|
if direction == "asc" {
|
|
return "desc"
|
|
}
|
|
|
|
return "asc"
|
|
}
|