From 1b36e858406ff6b15217229d1abaaabdbeec24e8 Mon Sep 17 00:00:00 2001 From: tobi <31960611+tsmethurst@users.noreply.github.com> Date: Sat, 5 Feb 2022 12:47:38 +0100 Subject: [feature] Rework timeline code to make it useful for more than just statuses (#373) * add preparable and timelineable interfaces * initialize timeline manager within the processor * generic renaming * move status-specific timeline logic into the processor * refactor timeline to make it useful for more than statuses --- internal/processing/statustimeline.go | 321 ++++++++++++++++++++++++++++++++++ 1 file changed, 321 insertions(+) create mode 100644 internal/processing/statustimeline.go (limited to 'internal/processing/statustimeline.go') diff --git a/internal/processing/statustimeline.go b/internal/processing/statustimeline.go new file mode 100644 index 000000000..355825900 --- /dev/null +++ b/internal/processing/statustimeline.go @@ -0,0 +1,321 @@ +/* + GoToSocial + Copyright (C) 2021-2022 GoToSocial Authors admin@gotosocial.org + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . +*/ + +package processing + +import ( + "context" + "errors" + "fmt" + "net/url" + + "github.com/sirupsen/logrus" + "github.com/spf13/viper" + + apimodel "github.com/superseriousbusiness/gotosocial/internal/api/model" + "github.com/superseriousbusiness/gotosocial/internal/config" + "github.com/superseriousbusiness/gotosocial/internal/db" + "github.com/superseriousbusiness/gotosocial/internal/gtserror" + "github.com/superseriousbusiness/gotosocial/internal/gtsmodel" + "github.com/superseriousbusiness/gotosocial/internal/oauth" + "github.com/superseriousbusiness/gotosocial/internal/timeline" + "github.com/superseriousbusiness/gotosocial/internal/typeutils" + "github.com/superseriousbusiness/gotosocial/internal/visibility" +) + +const boostReinsertionDepth = 50 + +// StatusGrabFunction returns a function that satisfies the GrabFunction interface in internal/timeline. +func StatusGrabFunction(database db.DB) timeline.GrabFunction { + return func(ctx context.Context, timelineAccountID string, maxID string, sinceID string, minID string, limit int) ([]timeline.Timelineable, bool, error) { + statuses, err := database.GetHomeTimeline(ctx, timelineAccountID, maxID, sinceID, minID, limit, false) + if err != nil { + if err == db.ErrNoEntries { + return nil, true, nil // we just don't have enough statuses left in the db so return stop = true + } + return nil, false, fmt.Errorf("statusGrabFunction: error getting statuses from db: %s", err) + } + + items := []timeline.Timelineable{} + for _, s := range statuses { + items = append(items, s) + } + + return items, false, nil + } +} + +// StatusFilterFunction returns a function that satisfies the FilterFunction interface in internal/timeline. +func StatusFilterFunction(database db.DB, filter visibility.Filter) timeline.FilterFunction { + return func(ctx context.Context, timelineAccountID string, item timeline.Timelineable) (shouldIndex bool, err error) { + status, ok := item.(*gtsmodel.Status) + if !ok { + return false, errors.New("statusFilterFunction: could not convert item to *gtsmodel.Status") + } + + requestingAccount, err := database.GetAccountByID(ctx, timelineAccountID) + if err != nil { + return false, fmt.Errorf("statusFilterFunction: error getting account with id %s", timelineAccountID) + } + + timelineable, err := filter.StatusHometimelineable(ctx, status, requestingAccount) + if err != nil { + logrus.Warnf("error checking hometimelineability of status %s for account %s: %s", status.ID, timelineAccountID, err) + } + + return timelineable, nil // we don't return the error here because we want to just skip this item if something goes wrong + } +} + +// StatusPrepareFunction returns a function that satisfies the PrepareFunction interface in internal/timeline. +func StatusPrepareFunction(database db.DB, tc typeutils.TypeConverter) timeline.PrepareFunction { + return func(ctx context.Context, timelineAccountID string, itemID string) (timeline.Preparable, error) { + status, err := database.GetStatusByID(ctx, itemID) + if err != nil { + return nil, fmt.Errorf("statusPrepareFunction: error getting status with id %s", itemID) + } + + requestingAccount, err := database.GetAccountByID(ctx, timelineAccountID) + if err != nil { + return nil, fmt.Errorf("statusPrepareFunction: error getting account with id %s", timelineAccountID) + } + + return tc.StatusToAPIStatus(ctx, status, requestingAccount) + } +} + +// StatusSkipInsertFunction returns a function that satisifes the SkipInsertFunction interface in internal/timeline. +func StatusSkipInsertFunction() timeline.SkipInsertFunction { + return func( + ctx context.Context, + newItemID string, + newItemAccountID string, + newItemBoostOfID string, + newItemBoostOfAccountID string, + nextItemID string, + nextItemAccountID string, + nextItemBoostOfID string, + nextItemBoostOfAccountID string, + depth int) (bool, error) { + + // make sure we don't insert a duplicate + if newItemID == nextItemID { + return true, nil + } + + // check if it's a boost + if newItemBoostOfID != "" { + // skip if we've recently put another boost of this status in the timeline + if newItemBoostOfID == nextItemBoostOfID { + if depth < boostReinsertionDepth { + return true, nil + } + } + + // skip if we've recently put the original status in the timeline + if newItemBoostOfID == nextItemID { + if depth < boostReinsertionDepth { + return true, nil + } + } + } + + // insert the item + return false, nil + } +} + +func (p *processor) packageStatusResponse(statuses []*apimodel.Status, path string, nextMaxID string, prevMinID string, limit int) (*apimodel.StatusTimelineResponse, gtserror.WithCode) { + resp := &apimodel.StatusTimelineResponse{ + Statuses: []*apimodel.Status{}, + } + resp.Statuses = statuses + + // prepare the next and previous links + if len(statuses) != 0 { + protocol := viper.GetString(config.Keys.Protocol) + host := viper.GetString(config.Keys.Host) + + nextLink := &url.URL{ + Scheme: protocol, + Host: host, + Path: path, + RawQuery: fmt.Sprintf("limit=%d&max_id=%s", limit, nextMaxID), + } + next := fmt.Sprintf("<%s>; rel=\"next\"", nextLink.String()) + + prevLink := &url.URL{ + Scheme: protocol, + Host: host, + Path: path, + RawQuery: fmt.Sprintf("limit=%d&min_id=%s", limit, prevMinID), + } + prev := fmt.Sprintf("<%s>; rel=\"prev\"", prevLink.String()) + resp.LinkHeader = fmt.Sprintf("%s, %s", next, prev) + } + + return resp, nil +} + +func (p *processor) HomeTimelineGet(ctx context.Context, authed *oauth.Auth, maxID string, sinceID string, minID string, limit int, local bool) (*apimodel.StatusTimelineResponse, gtserror.WithCode) { + preparedItems, err := p.statusTimelines.GetTimeline(ctx, authed.Account.ID, maxID, sinceID, minID, limit, local) + if err != nil { + return nil, gtserror.NewErrorInternalError(err) + } + + if len(preparedItems) == 0 { + return &apimodel.StatusTimelineResponse{ + Statuses: []*apimodel.Status{}, + }, nil + } + + statuses := []*apimodel.Status{} + for _, i := range preparedItems { + status, ok := i.(*apimodel.Status) + if !ok { + return nil, gtserror.NewErrorInternalError(errors.New("error converting prepared timeline entry to api status")) + } + statuses = append(statuses, status) + } + + return p.packageStatusResponse(statuses, "api/v1/timelines/home", statuses[len(preparedItems)-1].ID, statuses[0].ID, limit) +} + +func (p *processor) PublicTimelineGet(ctx context.Context, authed *oauth.Auth, maxID string, sinceID string, minID string, limit int, local bool) (*apimodel.StatusTimelineResponse, gtserror.WithCode) { + statuses, err := p.db.GetPublicTimeline(ctx, authed.Account.ID, maxID, sinceID, minID, limit, local) + if err != nil { + if err == db.ErrNoEntries { + // there are just no entries left + return &apimodel.StatusTimelineResponse{ + Statuses: []*apimodel.Status{}, + }, nil + } + // there's an actual error + return nil, gtserror.NewErrorInternalError(err) + } + + s, err := p.filterPublicStatuses(ctx, authed, statuses) + if err != nil { + return nil, gtserror.NewErrorInternalError(err) + } + + if len(s) == 0 { + return &apimodel.StatusTimelineResponse{ + Statuses: []*apimodel.Status{}, + }, nil + } + + return p.packageStatusResponse(s, "api/v1/timelines/public", s[len(s)-1].ID, s[0].ID, limit) +} + +func (p *processor) FavedTimelineGet(ctx context.Context, authed *oauth.Auth, maxID string, minID string, limit int) (*apimodel.StatusTimelineResponse, gtserror.WithCode) { + statuses, nextMaxID, prevMinID, err := p.db.GetFavedTimeline(ctx, authed.Account.ID, maxID, minID, limit) + if err != nil { + if err == db.ErrNoEntries { + // there are just no entries left + return &apimodel.StatusTimelineResponse{ + Statuses: []*apimodel.Status{}, + }, nil + } + // there's an actual error + return nil, gtserror.NewErrorInternalError(err) + } + + s, err := p.filterFavedStatuses(ctx, authed, statuses) + if err != nil { + return nil, gtserror.NewErrorInternalError(err) + } + + if len(s) == 0 { + return &apimodel.StatusTimelineResponse{ + Statuses: []*apimodel.Status{}, + }, nil + } + + return p.packageStatusResponse(s, "api/v1/favourites", nextMaxID, prevMinID, limit) +} + +func (p *processor) filterPublicStatuses(ctx context.Context, authed *oauth.Auth, statuses []*gtsmodel.Status) ([]*apimodel.Status, error) { + l := logrus.WithField("func", "filterPublicStatuses") + + apiStatuses := []*apimodel.Status{} + for _, s := range statuses { + targetAccount := >smodel.Account{} + if err := p.db.GetByID(ctx, s.AccountID, targetAccount); err != nil { + if err == db.ErrNoEntries { + l.Debugf("filterPublicStatuses: skipping status %s because account %s can't be found in the db", s.ID, s.AccountID) + continue + } + return nil, gtserror.NewErrorInternalError(fmt.Errorf("filterPublicStatuses: error getting status author: %s", err)) + } + + timelineable, err := p.filter.StatusPublictimelineable(ctx, s, authed.Account) + if err != nil { + l.Debugf("filterPublicStatuses: skipping status %s because of an error checking status visibility: %s", s.ID, err) + continue + } + if !timelineable { + continue + } + + apiStatus, err := p.tc.StatusToAPIStatus(ctx, s, authed.Account) + if err != nil { + l.Debugf("filterPublicStatuses: skipping status %s because it couldn't be converted to its api representation: %s", s.ID, err) + continue + } + + apiStatuses = append(apiStatuses, apiStatus) + } + + return apiStatuses, nil +} + +func (p *processor) filterFavedStatuses(ctx context.Context, authed *oauth.Auth, statuses []*gtsmodel.Status) ([]*apimodel.Status, error) { + l := logrus.WithField("func", "filterFavedStatuses") + + apiStatuses := []*apimodel.Status{} + for _, s := range statuses { + targetAccount := >smodel.Account{} + if err := p.db.GetByID(ctx, s.AccountID, targetAccount); err != nil { + if err == db.ErrNoEntries { + l.Debugf("filterFavedStatuses: skipping status %s because account %s can't be found in the db", s.ID, s.AccountID) + continue + } + return nil, gtserror.NewErrorInternalError(fmt.Errorf("filterPublicStatuses: error getting status author: %s", err)) + } + + timelineable, err := p.filter.StatusVisible(ctx, s, authed.Account) + if err != nil { + l.Debugf("filterFavedStatuses: skipping status %s because of an error checking status visibility: %s", s.ID, err) + continue + } + if !timelineable { + continue + } + + apiStatus, err := p.tc.StatusToAPIStatus(ctx, s, authed.Account) + if err != nil { + l.Debugf("filterFavedStatuses: skipping status %s because it couldn't be converted to its api representation: %s", s.ID, err) + continue + } + + apiStatuses = append(apiStatuses, apiStatus) + } + + return apiStatuses, nil +} -- cgit v1.2.3