commit caa0cde0e025708a762659758d9de7851745cbfe
parent 62d4d756d3caba5737be0a5e3810f17ca92d7ef8
Author: Adelie Paull <1208865+i-am-a-paull@users.noreply.github.com>
Date: Fri, 20 May 2022 04:34:36 -0400
[feature] implement custom_emojis endpoint (#563)
* implement custom_emojis api endpoint
* add tests for getting custom emoji out of the database and converting to api emoji
* change sort direction of emoji query
* change logging level and initialize array with known length as per kim's suggestions
* add continue to lessen risk of making a malformed struct during conversion from db to api emojis
Diffstat:
11 files changed, 231 insertions(+), 1 deletion(-)
diff --git a/internal/api/client/emoji/emojisget.go b/internal/api/client/emoji/emojisget.go
@@ -14,5 +14,11 @@ func (m *Module) EmojisGETHandler(c *gin.Context) {
return
}
- c.JSON(http.StatusOK, []string{})
+ emojis, errWithCode := m.processor.CustomEmojisGet(c)
+ if errWithCode != nil {
+ c.JSON(errWithCode.Code(), gin.H{"error": errWithCode.Safe()})
+ return
+ }
+
+ c.JSON(http.StatusOK, emojis)
}
diff --git a/internal/db/bundb/bundb.go b/internal/db/bundb/bundb.go
@@ -77,6 +77,7 @@ type bunDBService struct {
db.Admin
db.Basic
db.Domain
+ db.Emoji
db.Instance
db.Media
db.Mention
@@ -168,6 +169,9 @@ func NewBunDBService(ctx context.Context) (db.DB, error) {
Domain: &domainDB{
conn: conn,
},
+ Emoji: &emojiDB{
+ conn: conn,
+ },
Instance: &instanceDB{
conn: conn,
},
diff --git a/internal/db/bundb/emoji.go b/internal/db/bundb/emoji.go
@@ -0,0 +1,46 @@
+/*
+ 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 <http://www.gnu.org/licenses/>.
+*/
+
+package bundb
+
+import (
+ "context"
+
+ "github.com/superseriousbusiness/gotosocial/internal/db"
+ "github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
+)
+
+type emojiDB struct {
+ conn *DBConn
+}
+
+func (e emojiDB) GetCustomEmojis(ctx context.Context) ([]*gtsmodel.Emoji, db.Error) {
+ emojis := []*gtsmodel.Emoji{}
+
+ q := e.conn.
+ NewSelect().
+ Model(&emojis).
+ Where("visible_in_picker = true").
+ Where("disabled = false").
+ Order("shortcode ASC")
+
+ if err := q.Scan(ctx); err != nil {
+ return nil, e.conn.ProcessError(err)
+ }
+ return emojis, nil
+}
diff --git a/internal/db/bundb/emoji_test.go b/internal/db/bundb/emoji_test.go
@@ -0,0 +1,42 @@
+/*
+ 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 <http://www.gnu.org/licenses/>.
+*/
+
+package bundb_test
+
+import (
+ "context"
+ "testing"
+
+ "github.com/stretchr/testify/suite"
+)
+
+type EmojiTestSuite struct {
+ BunDBStandardTestSuite
+}
+
+func (suite *EmojiTestSuite) TestGetCustomEmojis() {
+ emojis, err := suite.db.GetCustomEmojis(context.Background())
+
+ suite.NoError(err)
+ suite.Equal(1, len(emojis))
+ suite.Equal("rainbow", emojis[0].Shortcode)
+}
+
+func TestEmojiTestSuite(t *testing.T) {
+ suite.Run(t, new(EmojiTestSuite))
+}
diff --git a/internal/db/db.go b/internal/db/db.go
@@ -35,6 +35,7 @@ type DB interface {
Admin
Basic
Domain
+ Emoji
Instance
Media
Mention
diff --git a/internal/db/emoji.go b/internal/db/emoji.go
@@ -0,0 +1,31 @@
+/*
+ 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 <http://www.gnu.org/licenses/>.
+*/
+
+package db
+
+import (
+ "context"
+
+ "github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
+)
+
+// Emoji contains functions for getting emoji in the database.
+type Emoji interface {
+ // GetCustomEmojis gets all custom emoji for the instance
+ GetCustomEmojis(ctx context.Context) ([]*gtsmodel.Emoji, Error)
+}
diff --git a/internal/processing/media.go b/internal/processing/media.go
@@ -41,3 +41,7 @@ func (p *processor) MediaUpdate(ctx context.Context, authed *oauth.Auth, mediaAt
func (p *processor) FileGet(ctx context.Context, authed *oauth.Auth, form *apimodel.GetContentRequestForm) (*apimodel.Content, gtserror.WithCode) {
return p.mediaProcessor.GetFile(ctx, authed.Account, form)
}
+
+func (p *processor) CustomEmojisGet(ctx context.Context) ([]*apimodel.Emoji, gtserror.WithCode) {
+ return p.mediaProcessor.GetCustomEmojis(ctx)
+}
diff --git a/internal/processing/media/getemoji.go b/internal/processing/media/getemoji.go
@@ -0,0 +1,50 @@
+/*
+ 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 <http://www.gnu.org/licenses/>.
+*/
+
+package media
+
+import (
+ "context"
+ "fmt"
+
+ "github.com/sirupsen/logrus"
+ apimodel "github.com/superseriousbusiness/gotosocial/internal/api/model"
+ "github.com/superseriousbusiness/gotosocial/internal/db"
+ "github.com/superseriousbusiness/gotosocial/internal/gtserror"
+)
+
+func (p *processor) GetCustomEmojis(ctx context.Context) ([]*apimodel.Emoji, gtserror.WithCode) {
+ emojis, err := p.db.GetCustomEmojis(ctx)
+ if err != nil {
+ if err != db.ErrNoEntries {
+ return nil, gtserror.NewErrorNotFound(fmt.Errorf("db error retrieving custom emojis: %s", err))
+ }
+ }
+
+ apiEmojis := make([]*apimodel.Emoji, 0, len(emojis))
+ for _, gtsEmoji := range emojis {
+ apiEmoji, err := p.tc.EmojiToAPIEmoji(ctx, gtsEmoji)
+ if err != nil {
+ logrus.Errorf("error converting emoji with id %s: %s", gtsEmoji.ID, err)
+ continue
+ }
+ apiEmojis = append(apiEmojis, &apiEmoji)
+ }
+
+ return apiEmojis, nil
+}
diff --git a/internal/processing/media/getemoji_test.go b/internal/processing/media/getemoji_test.go
@@ -0,0 +1,42 @@
+/*
+ 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 <http://www.gnu.org/licenses/>.
+*/
+
+package media_test
+
+import (
+ "context"
+ "testing"
+
+ "github.com/stretchr/testify/suite"
+)
+
+type GetEmojiTestSuite struct {
+ MediaStandardTestSuite
+}
+
+func (suite *GetEmojiTestSuite) TestGetCustomEmojis() {
+ emojis, err := suite.mediaProcessor.GetCustomEmojis(context.Background())
+
+ suite.NoError(err)
+ suite.Equal(1, len(emojis))
+ suite.Equal("rainbow", emojis[0].Shortcode)
+}
+
+func TestGetEmojiTestSuite(t *testing.T) {
+ suite.Run(t, &GetEmojiTestSuite{})
+}
diff --git a/internal/processing/media/media.go b/internal/processing/media/media.go
@@ -39,6 +39,7 @@ type Processor interface {
Delete(ctx context.Context, mediaAttachmentID string) gtserror.WithCode
// GetFile retrieves a file from storage and streams it back to the caller via an io.reader embedded in *apimodel.Content.
GetFile(ctx context.Context, account *gtsmodel.Account, form *apimodel.GetContentRequestForm) (*apimodel.Content, gtserror.WithCode)
+ GetCustomEmojis(ctx context.Context) ([]*apimodel.Emoji, gtserror.WithCode)
GetMedia(ctx context.Context, account *gtsmodel.Account, mediaAttachmentID string) (*apimodel.Attachment, gtserror.WithCode)
Update(ctx context.Context, account *gtsmodel.Account, mediaAttachmentID string, form *apimodel.AttachmentUpdateRequest) (*apimodel.Attachment, gtserror.WithCode)
}
diff --git a/internal/processing/processor.go b/internal/processing/processor.go
@@ -122,6 +122,9 @@ type Processor interface {
// BlocksGet returns a list of accounts blocked by the requesting account.
BlocksGet(ctx context.Context, authed *oauth.Auth, maxID string, sinceID string, limit int) (*apimodel.BlocksResponse, gtserror.WithCode)
+ // CustomEmojisGet returns an array of info about the custom emojis on this server
+ CustomEmojisGet(ctx context.Context) ([]*apimodel.Emoji, gtserror.WithCode)
+
// FileGet handles the fetching of a media attachment file via the fileserver.
FileGet(ctx context.Context, authed *oauth.Auth, form *apimodel.GetContentRequestForm) (*apimodel.Content, gtserror.WithCode)
