forked from andersfylling/disgord
-
Notifications
You must be signed in to change notification settings - Fork 0
/
emoji.go
223 lines (186 loc) · 5.76 KB
/
emoji.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
package disgord
import (
"context"
"errors"
"fmt"
"strings"
"github.com/andersfylling/disgord/internal/endpoint"
"github.com/andersfylling/disgord/internal/httd"
)
func validEmojiName(name string) bool {
if name == "" {
return false
}
// TODO: what is the allowed format?
// a test showed that using "-" caused regex issues
return !strings.Contains(name, "-")
}
// Emoji ...
type Emoji struct {
ID Snowflake `json:"id"`
Name string `json:"name"`
Roles []Snowflake `json:"roles,omitempty"`
User *User `json:"user,omitempty"` // the user who created the emoji
RequireColons bool `json:"require_colons,omitempty"`
Managed bool `json:"managed,omitempty"`
Animated bool `json:"animated,omitempty"`
// image string // base 64 string, with prefix and everything
guildID Snowflake
}
var _ Reseter = (*Emoji)(nil)
var _ DeepCopier = (*Emoji)(nil)
var _ Copier = (*Emoji)(nil)
var _ discordDeleter = (*Emoji)(nil)
var _ Mentioner = (*Emoji)(nil)
// var _ discordSaver = (*Emoji)(nil) // TODO
var _ fmt.Stringer = (*Emoji)(nil)
func (e *Emoji) String() string {
return "emoji{name:" + e.Name + ", id:" + e.ID.String() + "}"
}
// PartialEmoji see Emoji
type PartialEmoji = Emoji
// SetBase64Image use this before creating the emoji for the first time
//func (e *Emoji) SetBase64Image(img string) {
// e.image = img
//}
// Mention mentions an emoji. Adds the animation prefix, if animated
func (e *Emoji) Mention() string {
prefix := ""
if e.Animated {
prefix = "a:"
}
return "<:" + prefix + e.Name + ":" + e.ID.String() + ">"
}
func (e *Emoji) LinkToGuild(guildID Snowflake) {
e.guildID = guildID
}
// IDReference returns a reference to the emoji usable in REST calls.
func (e *Emoji) IDReference() string {
if e.ID.IsZero() {
return e.Name
}
return e.Name + ":" + e.ID.String()
}
// DeepCopy see interface at struct.go#DeepCopier
func (e *Emoji) DeepCopy() (copy interface{}) {
copy = &Emoji{}
e.CopyOverTo(copy)
return
}
// CopyOverTo see interface at struct.go#Copier
func (e *Emoji) CopyOverTo(other interface{}) (err error) {
var emoji *Emoji
var ok bool
if emoji, ok = other.(*Emoji); !ok {
err = newErrorUnsupportedType("given type is not *Emoji")
return
}
emoji.ID = e.ID
emoji.Name = e.Name
emoji.Roles = e.Roles
emoji.RequireColons = e.RequireColons
emoji.Managed = e.Managed
emoji.Animated = e.Animated
emoji.guildID = e.guildID
if e.User != nil {
emoji.User = e.User.DeepCopy().(*User)
}
return
}
func (e *Emoji) deleteFromDiscord(ctx context.Context, s Session, flags ...Flag) (err error) {
if e.guildID.IsZero() {
err = errors.New("missing guild ID, call Emoji.LinkToGuild")
return
}
if e.ID.IsZero() {
err = errors.New("missing emoji ID, cannot delete a not identified emoji")
return
}
return s.Guild(e.guildID).Emoji(e.ID).WithContext(ctx).Delete(flags...)
}
//////////////////////////////////////////////////////
//
// REST Methods
//
// https://discord.com/developers/docs/resources/emoji#emoji-resource
// Routes for controlling emojis do not follow the normal rate limit conventions.
// These routes are specifically limited on a per-guild basis to prevent abuse.
// This means that the quota returned by our APIs may be inaccurate,
// and you may encounter 429s.
//
//////////////////////////////////////////////////////
type GuildEmojiQueryBuilder interface {
WithContext(ctx context.Context) GuildEmojiQueryBuilder
Get(flags ...Flag) (*Emoji, error)
Update(flags ...Flag) UpdateGuildEmojiBuilder
Delete(flags ...Flag) error
}
func (g guildQueryBuilder) Emoji(emojiID Snowflake) GuildEmojiQueryBuilder {
return &guildEmojiQueryBuilder{client: g.client, gid: g.gid, emojiID: emojiID}
}
type guildEmojiQueryBuilder struct {
ctx context.Context
client *Client
gid Snowflake
emojiID Snowflake
}
func (g guildEmojiQueryBuilder) WithContext(ctx context.Context) GuildEmojiQueryBuilder {
g.ctx = ctx
return &g
}
func (g guildEmojiQueryBuilder) Get(flags ...Flag) (*Emoji, error) {
if emoji, _ := g.client.cache.GetGuildEmoji(g.gid, g.emojiID); emoji != nil {
return emoji, nil
}
r := g.client.newRESTRequest(&httd.Request{
Endpoint: endpoint.GuildEmoji(g.gid, g.emojiID),
Ctx: g.ctx,
}, flags)
r.pool = g.client.pool.emoji
r.factory = func() interface{} {
return &Emoji{}
}
return getEmoji(r.Execute)
}
// UpdateEmoji Modify the given emoji. Requires the 'MANAGE_EMOJIS' permission.
// Returns the updated emoji object on success. Fires a Guild Emojis Update Gateway event.
func (g guildEmojiQueryBuilder) Update(flags ...Flag) UpdateGuildEmojiBuilder {
builder := &updateGuildEmojiBuilder{}
builder.r.itemFactory = func() interface{} {
return &Emoji{guildID: g.gid}
}
builder.r.flags = flags
builder.r.setup(g.client.req, &httd.Request{
Method: httd.MethodPatch,
Ctx: g.ctx,
Endpoint: endpoint.GuildEmoji(g.gid, g.emojiID),
ContentType: httd.ContentTypeJSON,
}, nil)
return builder
}
// DeleteEmoji Delete the given emoji. Requires the 'MANAGE_EMOJIS' permission. Returns 204 No Content on
// success. Fires a Guild Emojis Update Gateway event.
func (g guildEmojiQueryBuilder) Delete(flags ...Flag) (err error) {
r := g.client.newRESTRequest(&httd.Request{
Method: httd.MethodDelete,
Endpoint: endpoint.GuildEmoji(g.gid, g.emojiID),
Ctx: g.ctx,
}, flags)
_, err = r.Execute()
return
}
//////////////////////////////////////////////////////
//
// REST Builders
//
//////////////////////////////////////////////////////
//generate-rest-params: name:string, roles:[]Snowflake,
//generate-rest-basic-execute: emoji:*Emoji,
type updateGuildEmojiBuilder struct {
r RESTBuilder
}
//generate-rest-params: roles:[]Snowflake,
//generate-rest-basic-execute: emoji:*Emoji,
type createGuildEmojiBuilder struct {
r RESTBuilder
}