mirror of
https://github.com/superseriousbusiness/gotosocial
synced 2024-12-08 14:36:32 +01:00
c9c0773f2c
* start replacing client + federator + media workers with new worker + queue types * refactor federatingDB.Delete(), drop queued messages when deleting account / status * move all queue purging to the processor workers * undo toolchain updates * code comments, ensure dereferencer worker pool gets started * update gruf libraries in readme * start the job scheduler separately to the worker pools * reshuffle ordering or server.go + remove duplicate worker start / stop * update go-list version * fix vendoring * move queue invalidation to before wipeing / deletion, to ensure queued work not dropped * add logging to worker processing functions in testrig, don't start workers in unexpected places * update go-structr to add (+then rely on) QueueCtx{} type * ensure more worker pools get started properly in tests * fix remaining broken tests relying on worker queue logic * fix account test suite queue popping logic, ensure noop workers do not pull from queue * move back accidentally shuffled account deletion order * ensure error (non nil!!) gets passed in refactored federatingDB{}.Delete() * silently drop deletes from accounts not permitted to * don't warn log on forwarded deletes * make if else clauses easier to parse * use getFederatorMsg() * improved code comment * improved code comment re: requesting account delete checks * remove boolean result from worker start / stop since false = already running or already stopped * remove optional passed-in http.client * remove worker starting from the admin CLI commands (we don't need to handle side-effects) * update prune cli to start scheduler but not all of the workers * fix rebase issues * remove redundant return statements * i'm sorry sir linter
325 lines
10 KiB
Go
325 lines
10 KiB
Go
// GoToSocial
|
|
// Copyright (C) GoToSocial Authors admin@gotosocial.org
|
|
// SPDX-License-Identifier: AGPL-3.0-or-later
|
|
//
|
|
// 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 <http://www.gnu.org/licenses/>.
|
|
|
|
package media
|
|
|
|
import (
|
|
"bytes"
|
|
"context"
|
|
"io"
|
|
"slices"
|
|
|
|
"codeberg.org/gruf/go-bytesize"
|
|
"codeberg.org/gruf/go-errors/v2"
|
|
"codeberg.org/gruf/go-runners"
|
|
"github.com/h2non/filetype"
|
|
"github.com/superseriousbusiness/gotosocial/internal/config"
|
|
"github.com/superseriousbusiness/gotosocial/internal/gtserror"
|
|
"github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
|
|
"github.com/superseriousbusiness/gotosocial/internal/log"
|
|
"github.com/superseriousbusiness/gotosocial/internal/regexes"
|
|
"github.com/superseriousbusiness/gotosocial/internal/uris"
|
|
"github.com/superseriousbusiness/gotosocial/internal/util"
|
|
)
|
|
|
|
// ProcessingEmoji represents an emoji currently processing. It exposes
|
|
// various functions for retrieving data from the process.
|
|
type ProcessingEmoji struct {
|
|
emoji *gtsmodel.Emoji // processing emoji details
|
|
existing bool // indicates whether this is an existing emoji ID being refreshed / recached
|
|
newPathID string // new emoji path ID to use when being refreshed
|
|
dataFn DataFunc // load-data function, returns media stream
|
|
done bool // done is set when process finishes with non ctx canceled type error
|
|
proc runners.Processor // proc helps synchronize only a singular running processing instance
|
|
err error // error stores permanent error value when done
|
|
mgr *Manager // mgr instance (access to db / storage)
|
|
}
|
|
|
|
// EmojiID returns the ID of the underlying emoji without blocking processing.
|
|
func (p *ProcessingEmoji) EmojiID() string {
|
|
return p.emoji.ID // immutable, safe outside mutex.
|
|
}
|
|
|
|
// LoadEmoji blocks until the static and fullsize image has been processed, and then returns the completed emoji.
|
|
func (p *ProcessingEmoji) LoadEmoji(ctx context.Context) (*gtsmodel.Emoji, error) {
|
|
// Attempt to load synchronously.
|
|
emoji, done, err := p.load(ctx)
|
|
if err == nil {
|
|
// No issue, return media.
|
|
return emoji, nil
|
|
}
|
|
|
|
if !done {
|
|
// Provided context was cancelled, e.g. request cancelled
|
|
// early. Queue this item for asynchronous processing.
|
|
log.Warnf(ctx, "reprocessing emoji %s after canceled ctx", p.emoji.ID)
|
|
p.mgr.state.Workers.Media.Queue.Push(p.Process)
|
|
}
|
|
|
|
return nil, err
|
|
}
|
|
|
|
// Process allows the receiving object to fit the runners.WorkerFunc signature. It performs a (blocking) load and logs on error.
|
|
func (p *ProcessingEmoji) Process(ctx context.Context) {
|
|
if _, _, err := p.load(ctx); err != nil {
|
|
log.Errorf(ctx, "error processing emoji: %v", err)
|
|
}
|
|
}
|
|
|
|
// load performs a concurrency-safe load of ProcessingEmoji, only marking itself as complete when returned error is NOT a context cancel.
|
|
func (p *ProcessingEmoji) load(ctx context.Context) (*gtsmodel.Emoji, bool, error) {
|
|
var (
|
|
done bool
|
|
err error
|
|
)
|
|
|
|
err = p.proc.Process(func() error {
|
|
if p.done {
|
|
// Already proc'd.
|
|
return p.err
|
|
}
|
|
|
|
defer func() {
|
|
// This is only done when ctx NOT cancelled.
|
|
done = err == nil || !errors.IsV2(err,
|
|
context.Canceled,
|
|
context.DeadlineExceeded,
|
|
)
|
|
|
|
if !done {
|
|
return
|
|
}
|
|
|
|
// Store final values.
|
|
p.done = true
|
|
p.err = err
|
|
}()
|
|
|
|
// Attempt to store media and calculate
|
|
// full-size media attachment details.
|
|
if err = p.store(ctx); err != nil {
|
|
return err
|
|
}
|
|
|
|
// Finish processing by reloading media into
|
|
// memory to get dimension and generate a thumb.
|
|
if err = p.finish(ctx); err != nil {
|
|
return err
|
|
}
|
|
|
|
if p.existing {
|
|
// Existing emoji we're updating, so only update.
|
|
err = p.mgr.state.DB.UpdateEmoji(ctx, p.emoji)
|
|
return err
|
|
}
|
|
|
|
// New emoji media, first time caching.
|
|
err = p.mgr.state.DB.PutEmoji(ctx, p.emoji)
|
|
return err
|
|
})
|
|
|
|
if err != nil {
|
|
return nil, done, err
|
|
}
|
|
|
|
return p.emoji, done, nil
|
|
}
|
|
|
|
// store calls the data function attached to p if it hasn't been called yet,
|
|
// and updates the underlying attachment fields as necessary. It will then stream
|
|
// bytes from p's reader directly into storage so that it can be retrieved later.
|
|
func (p *ProcessingEmoji) store(ctx context.Context) error {
|
|
// Load media from provided data fn.
|
|
rc, sz, err := p.dataFn(ctx)
|
|
if err != nil {
|
|
return gtserror.Newf("error executing data function: %w", err)
|
|
}
|
|
|
|
defer func() {
|
|
// Ensure data reader gets closed on return.
|
|
if err := rc.Close(); err != nil {
|
|
log.Errorf(ctx, "error closing data reader: %v", err)
|
|
}
|
|
}()
|
|
|
|
var maxSize bytesize.Size
|
|
|
|
if p.emoji.IsLocal() {
|
|
// this is a local emoji upload
|
|
maxSize = config.GetMediaEmojiLocalMaxSize()
|
|
} else {
|
|
// this is a remote incoming emoji
|
|
maxSize = config.GetMediaEmojiRemoteMaxSize()
|
|
}
|
|
|
|
// Check that provided size isn't beyond max. We check beforehand
|
|
// so that we don't attempt to stream the emoji into storage if not needed.
|
|
if size := bytesize.Size(sz); sz > 0 && size > maxSize {
|
|
return gtserror.Newf("given emoji size %s greater than max allowed %s", size, maxSize)
|
|
}
|
|
|
|
// Prepare to read bytes from
|
|
// file header or magic number.
|
|
fileSize := int(sz)
|
|
hdrBuf := newHdrBuf(fileSize)
|
|
|
|
// Read into buffer as much as possible.
|
|
//
|
|
// UnexpectedEOF means we couldn't read up to the
|
|
// given size, but we may still have read something.
|
|
//
|
|
// EOF means we couldn't read anything at all.
|
|
//
|
|
// Any other error likely means the connection messed up.
|
|
//
|
|
// In other words, rather counterintuitively, we
|
|
// can only proceed on no error or unexpected error!
|
|
n, err := io.ReadFull(rc, hdrBuf)
|
|
if err != nil {
|
|
if err != io.ErrUnexpectedEOF {
|
|
return gtserror.Newf("error reading first bytes of incoming media: %w", err)
|
|
}
|
|
|
|
// Initial file size was misreported, so we didn't read
|
|
// fully into hdrBuf. Reslice it to the size we did read.
|
|
log.Warnf(ctx,
|
|
"recovered from misreported file size; reported %d; read %d",
|
|
fileSize, n,
|
|
)
|
|
hdrBuf = hdrBuf[:n]
|
|
}
|
|
|
|
// Parse file type info from header buffer.
|
|
info, err := filetype.Match(hdrBuf)
|
|
if err != nil {
|
|
return gtserror.Newf("error parsing file type: %w", err)
|
|
}
|
|
|
|
// Ensure supported emoji img type.
|
|
if !slices.Contains(SupportedEmojiMIMETypes, info.MIME.Value) {
|
|
return gtserror.Newf("unsupported emoji filetype: %s", info.Extension)
|
|
}
|
|
|
|
// Recombine header bytes with remaining stream
|
|
r := io.MultiReader(bytes.NewReader(hdrBuf), rc)
|
|
|
|
var pathID string
|
|
if p.newPathID != "" {
|
|
// This is a refreshed emoji with a new
|
|
// path ID that this will be stored under.
|
|
pathID = p.newPathID
|
|
} else {
|
|
// This is a new emoji, simply use provided ID.
|
|
pathID = p.emoji.ID
|
|
}
|
|
|
|
// Determine instance account ID from already generated image static path.
|
|
instanceAccID := regexes.FilePath.FindStringSubmatch(p.emoji.ImageStaticPath)[1]
|
|
|
|
// Calculate emoji file path.
|
|
p.emoji.ImagePath = uris.StoragePathForAttachment(
|
|
instanceAccID,
|
|
string(TypeEmoji),
|
|
string(SizeOriginal),
|
|
pathID,
|
|
info.Extension,
|
|
)
|
|
|
|
// This shouldn't already exist, but we do a check as it's worth logging.
|
|
if have, _ := p.mgr.state.Storage.Has(ctx, p.emoji.ImagePath); have {
|
|
log.Warnf(ctx, "emoji already exists at storage path: %s", p.emoji.ImagePath)
|
|
|
|
// Attempt to remove existing emoji at storage path (might be broken / out-of-date)
|
|
if err := p.mgr.state.Storage.Delete(ctx, p.emoji.ImagePath); err != nil {
|
|
return gtserror.Newf("error removing emoji from storage: %v", err)
|
|
}
|
|
}
|
|
|
|
// Write the final image reader stream to our storage.
|
|
wroteSize, err := p.mgr.state.Storage.PutStream(ctx, p.emoji.ImagePath, r)
|
|
if err != nil {
|
|
return gtserror.Newf("error writing emoji to storage: %w", err)
|
|
}
|
|
|
|
// Once again check size in case none was provided previously.
|
|
if size := bytesize.Size(wroteSize); size > maxSize {
|
|
if err := p.mgr.state.Storage.Delete(ctx, p.emoji.ImagePath); err != nil {
|
|
log.Errorf(ctx, "error removing too-large-emoji from storage: %v", err)
|
|
}
|
|
|
|
return gtserror.Newf("calculated emoji size %s greater than max allowed %s", size, maxSize)
|
|
}
|
|
|
|
// Fill in remaining attachment data now it's stored.
|
|
p.emoji.ImageURL = uris.URIForAttachment(
|
|
instanceAccID,
|
|
string(TypeEmoji),
|
|
string(SizeOriginal),
|
|
pathID,
|
|
info.Extension,
|
|
)
|
|
p.emoji.ImageContentType = info.MIME.Value
|
|
p.emoji.ImageFileSize = int(wroteSize)
|
|
p.emoji.Cached = util.Ptr(true)
|
|
|
|
return nil
|
|
}
|
|
|
|
func (p *ProcessingEmoji) finish(ctx context.Context) error {
|
|
// Fetch a stream to the original file in storage.
|
|
rc, err := p.mgr.state.Storage.GetStream(ctx, p.emoji.ImagePath)
|
|
if err != nil {
|
|
return gtserror.Newf("error loading file from storage: %w", err)
|
|
}
|
|
defer rc.Close()
|
|
|
|
// Decode the image from storage.
|
|
staticImg, err := decodeImage(rc)
|
|
if err != nil {
|
|
return gtserror.Newf("error decoding image: %w", err)
|
|
}
|
|
|
|
// The image should be in-memory by now.
|
|
if err := rc.Close(); err != nil {
|
|
return gtserror.Newf("error closing file: %w", err)
|
|
}
|
|
|
|
// This shouldn't already exist, but we do a check as it's worth logging.
|
|
if have, _ := p.mgr.state.Storage.Has(ctx, p.emoji.ImageStaticPath); have {
|
|
log.Warnf(ctx, "static emoji already exists at storage path: %s", p.emoji.ImagePath)
|
|
|
|
// Attempt to remove static existing emoji at storage path (might be broken / out-of-date)
|
|
if err := p.mgr.state.Storage.Delete(ctx, p.emoji.ImageStaticPath); err != nil {
|
|
return gtserror.Newf("error removing static emoji from storage: %v", err)
|
|
}
|
|
}
|
|
|
|
// Create an emoji PNG encoder stream.
|
|
enc := staticImg.ToPNG()
|
|
|
|
// Stream-encode the PNG static image into storage.
|
|
sz, err := p.mgr.state.Storage.PutStream(ctx, p.emoji.ImageStaticPath, enc)
|
|
if err != nil {
|
|
return gtserror.Newf("error stream-encoding static emoji to storage: %w", err)
|
|
}
|
|
|
|
// Set written image size.
|
|
p.emoji.ImageStaticFileSize = int(sz)
|
|
|
|
return nil
|
|
}
|