/* GoToSocial Copyright (C) 2021 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 db import ( "context" "errors" "fmt" "net/url" "sync" "github.com/go-fed/activity/pub" "github.com/go-fed/activity/streams/vocab" "github.com/sirupsen/logrus" "github.com/superseriousbusiness/gotosocial/internal/config" "github.com/superseriousbusiness/gotosocial/internal/gtsmodel" "github.com/superseriousbusiness/gotosocial/internal/util" ) // FederatingDB uses the underlying DB interface to implement the go-fed pub.Database interface. // It doesn't care what the underlying implementation of the DB interface is, as long as it works. type federatingDB struct { locks *sync.Map db DB config *config.Config log *logrus.Logger } func NewFederatingDB(db DB, config *config.Config, log *logrus.Logger) pub.Database { return &federatingDB{ locks: new(sync.Map), db: db, config: config, log: log, } } /* GO-FED DB INTERFACE-IMPLEMENTING FUNCTIONS */ // Lock takes a lock for the object at the specified id. If an error // is returned, the lock must not have been taken. // // The lock must be able to succeed for an id that does not exist in // the database. This means acquiring the lock does not guarantee the // entry exists in the database. // // Locks are encouraged to be lightweight and in the Go layer, as some // processes require tight loops acquiring and releasing locks. // // Used to ensure race conditions in multiple requests do not occur. func (f *federatingDB) Lock(c context.Context, id *url.URL) error { // Before any other Database methods are called, the relevant `id` // entries are locked to allow for fine-grained concurrency. // Strategy: create a new lock, if stored, continue. Otherwise, lock the // existing mutex. mu := &sync.Mutex{} mu.Lock() // Optimistically lock if we do store it. i, loaded := f.locks.LoadOrStore(id.String(), mu) if loaded { mu = i.(*sync.Mutex) mu.Lock() } return nil } // Unlock makes the lock for the object at the specified id available. // If an error is returned, the lock must have still been freed. // // Used to ensure race conditions in multiple requests do not occur. func (f *federatingDB) Unlock(c context.Context, id *url.URL) error { // Once Go-Fed is done calling Database methods, the relevant `id` // entries are unlocked. i, ok := f.locks.Load(id.String()) if !ok { return errors.New("missing an id in unlock") } mu := i.(*sync.Mutex) mu.Unlock() return nil } // InboxContains returns true if the OrderedCollection at 'inbox' // contains the specified 'id'. // // The library makes this call only after acquiring a lock first. func (f *federatingDB) InboxContains(c context.Context, inbox, id *url.URL) (contains bool, err error) { if !util.IsInboxPath(inbox) { return false, fmt.Errorf("%s is not an inbox URI", inbox.String()) } if !util.IsStatusesPath(id) { return false, fmt.Errorf("%s is not a status URI", id.String()) } _, statusID, err := util.ParseStatusesPath(inbox) if err != nil { return false, fmt.Errorf("status URI %s was not parseable: %s", id.String(), err) } if err := f.db.GetByID(statusID, >smodel.Status{}); err != nil { if _, ok := err.(ErrNoEntries); ok { // we don't have it return false, nil } // actual error return false, fmt.Errorf("error getting status from db: %s", err) } // we must have it return true, nil } // GetInbox returns the first ordered collection page of the outbox at // the specified IRI, for prepending new items. // // The library makes this call only after acquiring a lock first. func (f *federatingDB) GetInbox(c context.Context, inboxIRI *url.URL) (inbox vocab.ActivityStreamsOrderedCollectionPage, err error) { return nil, nil } // SetInbox saves the inbox value given from GetInbox, with new items // prepended. Note that the new items must not be added as independent // database entries. Separate calls to Create will do that. // // The library makes this call only after acquiring a lock first. func (f *federatingDB) SetInbox(c context.Context, inbox vocab.ActivityStreamsOrderedCollectionPage) error { return nil } // Owns returns true if the IRI belongs to this instance, and if // the database has an entry for the IRI. // The library makes this call only after acquiring a lock first. func (f *federatingDB) Owns(c context.Context, id *url.URL) (bool, error) { // if the id host isn't this instance host, we don't own this IRI if id.Host != f.config.Host { return false, nil } // apparently we own it, so what *is* it? // check if it's a status, eg /users/example_username/statuses/SOME_UUID_OF_A_STATUS if util.IsStatusesPath(id) { _, uid, err := util.ParseStatusesPath(id) if err != nil { return false, fmt.Errorf("error parsing statuses path for url %s: %s", id.String(), err) } if err := f.db.GetWhere("uri", uid, >smodel.Status{}); err != nil { if _, ok := err.(ErrNoEntries); ok { // there are no entries for this status return false, nil } // an actual error happened return false, fmt.Errorf("database error fetching status with id %s: %s", uid, err) } return true, nil } // check if it's a user, eg /users/example_username if util.IsUserPath(id) { username, err := util.ParseUserPath(id) if err != nil { return false, fmt.Errorf("error parsing statuses path for url %s: %s", id.String(), err) } if err := f.db.GetLocalAccountByUsername(username, >smodel.Account{}); err != nil { if _, ok := err.(ErrNoEntries); ok { // there are no entries for this username return false, nil } // an actual error happened return false, fmt.Errorf("database error fetching account with username %s: %s", username, err) } return true, nil } return false, fmt.Errorf("could not match activityID: %s", id.String()) } // ActorForOutbox fetches the actor's IRI for the given outbox IRI. // // The library makes this call only after acquiring a lock first. func (f *federatingDB) ActorForOutbox(c context.Context, outboxIRI *url.URL) (actorIRI *url.URL, err error) { if !util.IsOutboxPath(outboxIRI) { return nil, fmt.Errorf("%s is not an outbox URI", outboxIRI.String()) } acct := >smodel.Account{} if err := f.db.GetWhere("outbox_uri", outboxIRI.String(), acct); err != nil { if _, ok := err.(ErrNoEntries); ok { return nil, fmt.Errorf("no actor found that corresponds to outbox %s", outboxIRI.String()) } return nil, fmt.Errorf("db error searching for actor with outbox %s", outboxIRI.String()) } return url.Parse(acct.URI) } // ActorForInbox fetches the actor's IRI for the given outbox IRI. // // The library makes this call only after acquiring a lock first. func (f *federatingDB) ActorForInbox(c context.Context, inboxIRI *url.URL) (actorIRI *url.URL, err error) { if !util.IsInboxPath(inboxIRI) { return nil, fmt.Errorf("%s is not an inbox URI", inboxIRI.String()) } acct := >smodel.Account{} if err := f.db.GetWhere("inbox_uri", inboxIRI.String(), acct); err != nil { if _, ok := err.(ErrNoEntries); ok { return nil, fmt.Errorf("no actor found that corresponds to inbox %s", inboxIRI.String()) } return nil, fmt.Errorf("db error searching for actor with inbox %s", inboxIRI.String()) } return url.Parse(acct.URI) } // OutboxForInbox fetches the corresponding actor's outbox IRI for the // actor's inbox IRI. // // The library makes this call only after acquiring a lock first. func (f *federatingDB) OutboxForInbox(c context.Context, inboxIRI *url.URL) (outboxIRI *url.URL, err error) { if !util.IsInboxPath(inboxIRI) { return nil, fmt.Errorf("%s is not an inbox URI", inboxIRI.String()) } acct := >smodel.Account{} if err := f.db.GetWhere("inbox_uri", inboxIRI.String(), acct); err != nil { if _, ok := err.(ErrNoEntries); ok { return nil, fmt.Errorf("no actor found that corresponds to inbox %s", inboxIRI.String()) } return nil, fmt.Errorf("db error searching for actor with inbox %s", inboxIRI.String()) } return url.Parse(acct.OutboxURI) } // Exists returns true if the database has an entry for the specified // id. It may not be owned by this application instance. // // The library makes this call only after acquiring a lock first. func (f *federatingDB) Exists(c context.Context, id *url.URL) (exists bool, err error) { return false, nil } // Get returns the database entry for the specified id. // // The library makes this call only after acquiring a lock first. func (f *federatingDB) Get(c context.Context, id *url.URL) (value vocab.Type, err error) { return nil, nil } // Create adds a new entry to the database which must be able to be // keyed by its id. // // Note that Activity values received from federated peers may also be // created in the database this way if the Federating Protocol is // enabled. The client may freely decide to store only the id instead of // the entire value. // // The library makes this call only after acquiring a lock first. // // Under certain conditions and network activities, Create may be called // multiple times for the same ActivityStreams object. func (f *federatingDB) Create(c context.Context, asType vocab.Type) error { return nil } // Update sets an existing entry to the database based on the value's // id. // // Note that Activity values received from federated peers may also be // updated in the database this way if the Federating Protocol is // enabled. The client may freely decide to store only the id instead of // the entire value. // // The library makes this call only after acquiring a lock first. func (f *federatingDB) Update(c context.Context, asType vocab.Type) error { return nil } // Delete removes the entry with the given id. // // Delete is only called for federated objects. Deletes from the Social // Protocol instead call Update to create a Tombstone. // // The library makes this call only after acquiring a lock first. func (f *federatingDB) Delete(c context.Context, id *url.URL) error { return nil } // GetOutbox returns the first ordered collection page of the outbox // at the specified IRI, for prepending new items. // // The library makes this call only after acquiring a lock first. func (f *federatingDB) GetOutbox(c context.Context, outboxIRI *url.URL) (inbox vocab.ActivityStreamsOrderedCollectionPage, err error) { return nil, nil } // SetOutbox saves the outbox value given from GetOutbox, with new items // prepended. Note that the new items must not be added as independent // database entries. Separate calls to Create will do that. // // The library makes this call only after acquiring a lock first. func (f *federatingDB) SetOutbox(c context.Context, outbox vocab.ActivityStreamsOrderedCollectionPage) error { return nil } // NewID creates a new IRI id for the provided activity or object. The // implementation does not need to set the 'id' property and simply // needs to determine the value. // // The go-fed library will handle setting the 'id' property on the // activity or object provided with the value returned. func (f *federatingDB) NewID(c context.Context, t vocab.Type) (id *url.URL, err error) { return nil, nil } // Followers obtains the Followers Collection for an actor with the // given id. // // If modified, the library will then call Update. // // The library makes this call only after acquiring a lock first. func (f *federatingDB) Followers(c context.Context, actorIRI *url.URL) (followers vocab.ActivityStreamsCollection, err error) { return nil, nil } // Following obtains the Following Collection for an actor with the // given id. // // If modified, the library will then call Update. // // The library makes this call only after acquiring a lock first. func (f *federatingDB) Following(c context.Context, actorIRI *url.URL) (followers vocab.ActivityStreamsCollection, err error) { return nil, nil } // Liked obtains the Liked Collection for an actor with the // given id. // // If modified, the library will then call Update. // // The library makes this call only after acquiring a lock first. func (f *federatingDB) Liked(c context.Context, actorIRI *url.URL) (followers vocab.ActivityStreamsCollection, err error) { return nil, nil }