mirror of
https://github.com/superseriousbusiness/gotosocial.git
synced 2025-10-31 14:52:30 -05:00
424f62dd70* Add ContentType to internal models * Add ContentType to API models StatusSource and StatusEdit * Add helpers to convert between API/internal StatusContentType * Write status content type on create/edit * Add migration * Update API docs go run github.com/go-swagger/go-swagger/cmd/swagger generate spec --scan-models --exclude-deps --output docs/api/swagger.yaml * ensure ContentType is updated anywhere Text is * Update docs, take care of TODOs * Set ContentType in more places where Text is set * We don't actually use ContentType on the API status model * Update StatusSource test * Remove unused helper function I copied * Revert change to StatusContentType swagger annotation I'm going to include this in a follow-on PR instead. * Add test for updating content type in edits * Return a value from processContentType instead of modifying the existing status Fixes an issue that was caught by the test I just added - the recorded edit would be marked with the *new* content type instead of the old one, which is obviously bad * Add test for handling of statuses with no stored content type * repurpose an existing test status instead of adding a new one to avoid breaking other tests * Add test to ensure newly created statuses always have content type saved * Do include content type on status API model actually This is mostly important when deleting and redrafting. The comment on `apimodel.Status.Text` implies that it's not sent except in response to status deletion, but actually this doesn't seem to be the case; it also appears to be present in responses to creations and normal fetches and stuff. So I'm treating `ContentType` the same here. * Update new tests to check content type on API statuses * Check content type of API statuses in all tests where text is checked * update other api tests with status content type field * Add test ensuring text and content type are returned when deleting a status * Convert processContentType to free function and remove unused parameter * check for the correct value in the deletion test * Be explicit about this test status having an empty content type * Use omitempty consistently on API models * clean up the final diff a bit * one more swagger regen for the road * Handle nil statuses in processContentType * Don't pass processContentType the entire edit form, it doesn't need it * Move processContentType to common.go and use for creation as well * Remove unused parameters to ContentTypeToAPIContentType
63 lines
4.1 KiB
Go
63 lines
4.1 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 gtsmodel
|
|
|
|
import "time"
|
|
|
|
// StatusEdit represents a **historical** view of a Status
|
|
// after a received edit. The Status itself will always
|
|
// contain the latest up-to-date information.
|
|
//
|
|
// Note that stored status edits may not exactly match that
|
|
// of the origin server, they are a best-effort by receiver
|
|
// to store version history. There is no AP history endpoint.
|
|
type StatusEdit struct {
|
|
ID string `bun:"type:CHAR(26),pk,nullzero,notnull,unique"` // ID of this item in the database.
|
|
Content string `bun:""` // Content of status at time of edit; likely html-formatted but not guaranteed.
|
|
ContentWarning string `bun:",nullzero"` // Content warning of status at time of edit.
|
|
Text string `bun:""` // Original status text, without formatting, at time of edit.
|
|
ContentType StatusContentType `bun:",nullzero"` // Content type used to process the original text of the status.
|
|
Language string `bun:",nullzero"` // Status language at time of edit.
|
|
Sensitive *bool `bun:",nullzero,notnull,default:false"` // Status sensitive flag at time of edit.
|
|
AttachmentIDs []string `bun:"attachments,array"` // Database IDs of media attachments associated with status at time of edit.
|
|
AttachmentDescriptions []string `bun:",array"` // Previous media descriptions of media attachments associated with status at time of edit.
|
|
Attachments []*MediaAttachment `bun:"-"` // Media attachments relating to .AttachmentIDs field (not always populated).
|
|
PollOptions []string `bun:",array"` // Poll options of status at time of edit, only set if status contains a poll.
|
|
PollVotes []int `bun:",array"` // Poll vote count at time of status edit, only set if poll votes were reset.
|
|
StatusID string `bun:"type:CHAR(26),nullzero,notnull"` // The originating status ID this is a historical edit of.
|
|
CreatedAt time.Time `bun:"type:timestamptz,nullzero,notnull,default:current_timestamp"` // The creation time of this version of the status content (according to receiving server).
|
|
|
|
// We don't bother having a *gtsmodel.Status model here
|
|
// as the StatusEdit is always just attached to a Status,
|
|
// so it doesn't need a self-reference back to it.
|
|
}
|
|
|
|
// AttachmentsPopulated returns whether media attachments
|
|
// are populated according to current AttachmentIDs.
|
|
func (e *StatusEdit) AttachmentsPopulated() bool {
|
|
if len(e.AttachmentIDs) != len(e.Attachments) {
|
|
// this is the quickest indicator.
|
|
return false
|
|
}
|
|
for i, id := range e.AttachmentIDs {
|
|
if e.Attachments[i].ID != id {
|
|
return false
|
|
}
|
|
}
|
|
return true
|
|
}
|