129 lines
4.4 KiB
Go
129 lines
4.4 KiB
Go
package engine2
|
|
|
|
// Package engine defines interfaces each supported storage should implement.
|
|
// Includes default implementation with boltdb
|
|
|
|
import (
|
|
"sort"
|
|
"strings"
|
|
"time"
|
|
|
|
"github.com/umputun/remark/backend/app/store"
|
|
)
|
|
|
|
// NOTE: mockery works from linked to go-path and with GOFLAGS='-mod=vendor' go generate
|
|
//go:generate sh -c "mockery -inpkg -name Interface -print > /tmp/engine-mock.tmp && mv /tmp/engine-mock.tmp engine_mock.go"
|
|
|
|
// Interface defines methods provided by low-level storage engine
|
|
type Interface interface {
|
|
Create(comment store.Comment) (commentID string, err error) // create new comment, avoid dups by id
|
|
Update(locator store.Locator, comment store.Comment) error // update comment, mutable parts only
|
|
Get(locator store.Locator, commentID string) (store.Comment, error) // get comment by id
|
|
Find(req FindRequest) ([]store.Comment, error) // find comments for locator or site
|
|
Info(req InfoRequest) ([]store.PostInfo, error) // get post(s) meta info
|
|
Count(req FindRequest) (int, error) // get count for post or user
|
|
Delete(req DeleteRequest) error // delete post(s) by id or by userID
|
|
Flag(req FlagRequest) (bool, error) // set and get flags
|
|
ListFlags(siteID string, flag Flag) ([]interface{}, error) // get list of flagged keys, like blocked & verified user
|
|
Close() error // close storage engine
|
|
}
|
|
|
|
// FindRequest is the input for all find operations
|
|
type FindRequest struct {
|
|
Locator store.Locator // lack of URL means site operation
|
|
UserID string // presence of UserID treated as user-related find
|
|
Sort string // sort order with +/-field syntax
|
|
Since time.Time // time limit for found results
|
|
Limit, Skip int
|
|
}
|
|
|
|
// InfoRequest is the input of Info operation used to get meta data about posts
|
|
type InfoRequest struct {
|
|
Locator store.Locator
|
|
Limit, Skip int
|
|
ReadOnlyAge int
|
|
}
|
|
|
|
type DeleteRequest struct {
|
|
Locator store.Locator // lack of URL means site operation
|
|
CommentID string
|
|
UserID string
|
|
DeleteMode store.DeleteMode
|
|
}
|
|
|
|
// Flag defines type of binary attribute
|
|
type Flag string
|
|
|
|
// FlagStatus represents values of the flag update
|
|
type FlagStatus int
|
|
|
|
// enum of update values
|
|
const (
|
|
FlagNonSet FlagStatus = 0
|
|
FlagTrue FlagStatus = 1
|
|
FlagFalse FlagStatus = -1
|
|
)
|
|
|
|
// Enum of all flags
|
|
const (
|
|
ReadOnly = Flag("readonly")
|
|
Verified = Flag("verified")
|
|
Blocked = Flag("blocked")
|
|
)
|
|
|
|
// FlagRequest is the input for both get/set for flags, like blocked, verified and so on
|
|
type FlagRequest struct {
|
|
Flag Flag // flag type
|
|
Locator store.Locator // post locator
|
|
UserID string // for flags setting user status
|
|
Update FlagStatus // if FlagNonSet it will be get op, if set will set the value
|
|
TTL time.Duration // ttl for time-sensitive flags only, like blocked for some period
|
|
}
|
|
|
|
const (
|
|
// limits
|
|
lastLimit = 1000
|
|
userLimit = 500
|
|
)
|
|
|
|
// SortComments is for engines can't sort data internally
|
|
func SortComments(comments []store.Comment, sortFld string) []store.Comment {
|
|
sort.Slice(comments, func(i, j int) bool {
|
|
switch sortFld {
|
|
case "+time", "-time", "time", "+active", "-active", "active":
|
|
if strings.HasPrefix(sortFld, "-") {
|
|
return comments[i].Timestamp.After(comments[j].Timestamp)
|
|
}
|
|
return comments[i].Timestamp.Before(comments[j].Timestamp)
|
|
|
|
case "+score", "-score", "score":
|
|
if strings.HasPrefix(sortFld, "-") {
|
|
if comments[i].Score == comments[j].Score {
|
|
return comments[i].Timestamp.Before(comments[j].Timestamp)
|
|
}
|
|
return comments[i].Score > comments[j].Score
|
|
}
|
|
if comments[i].Score == comments[j].Score {
|
|
return comments[i].Timestamp.Before(comments[j].Timestamp)
|
|
}
|
|
return comments[i].Score < comments[j].Score
|
|
|
|
case "+controversy", "-controversy", "controversy":
|
|
if strings.HasPrefix(sortFld, "-") {
|
|
if comments[i].Controversy == comments[j].Controversy {
|
|
return comments[i].Timestamp.Before(comments[j].Timestamp)
|
|
}
|
|
return comments[i].Controversy > comments[j].Controversy
|
|
}
|
|
if comments[i].Controversy == comments[j].Controversy {
|
|
return comments[i].Timestamp.Before(comments[j].Timestamp)
|
|
}
|
|
return comments[i].Controversy < comments[j].Controversy
|
|
|
|
default:
|
|
return comments[i].Timestamp.Before(comments[j].Timestamp)
|
|
}
|
|
})
|
|
return comments
|
|
}
|