This repository has been archived by the owner on Jul 11, 2024. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 70
/
user.go
598 lines (503 loc) · 18 KB
/
user.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
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
package disgord
import (
"context"
"errors"
"fmt"
"net/http"
"strings"
"github.com/andersfylling/disgord/internal/endpoint"
"github.com/andersfylling/disgord/internal/httd"
)
type ClientStatus struct {
Desktop string `json:"desktop"`
Mobile string `json:"mobile"`
Web string `json:"web"`
}
// ActivityParty ...
type ActivityParty struct {
ID string `json:"id,omitempty"` // the id of the party
Size []int `json:"size,omitempty"` // used to show the party's current and maximum size
}
var _ Copier = (*ActivityParty)(nil)
var _ DeepCopier = (*ActivityParty)(nil)
// Limit shows the maximum number of guests/people allowed
func (ap *ActivityParty) Limit() int {
if len(ap.Size) != 2 {
return 0
}
return ap.Size[1]
}
// NumberOfPeople shows the current number of people attending the Party
func (ap *ActivityParty) NumberOfPeople() int {
if len(ap.Size) != 1 {
return 0
}
return ap.Size[0]
}
// ActivityAssets ...
type ActivityAssets struct {
LargeImage string `json:"large_image,omitempty"` // the id for a large asset of the activity, usually a snowflake
LargeText string `json:"large_text,omitempty"` //text displayed when hovering over the large image of the activity
SmallImage string `json:"small_image,omitempty"` // the id for a small asset of the activity, usually a snowflake
SmallText string `json:"small_text,omitempty"` // text displayed when hovering over the small image of the activity
}
var _ Copier = (*ActivityAssets)(nil)
var _ DeepCopier = (*ActivityAssets)(nil)
// ActivitySecrets ...
type ActivitySecrets struct {
Join string `json:"join,omitempty"` // the secret for joining a party
Spectate string `json:"spectate,omitempty"` // the secret for spectating a game
Match string `json:"match,omitempty"` // the secret for a specific instanced match
}
var _ Copier = (*ActivitySecrets)(nil)
var _ DeepCopier = (*ActivitySecrets)(nil)
// ActivityEmoji ...
type ActivityEmoji struct {
Name string `json:"name"`
ID Snowflake `json:"id,omitempty"`
Animated bool `json:"animated,omitempty"`
}
var _ Copier = (*ActivityEmoji)(nil)
var _ DeepCopier = (*ActivityEmoji)(nil)
// ActivityTimestamp ...
type ActivityTimestamp struct {
Start int `json:"start,omitempty"` // unix time (in milliseconds) of when the activity started
End int `json:"end,omitempty"` // unix time (in milliseconds) of when the activity ends
}
var _ Copier = (*ActivityTimestamp)(nil)
var _ DeepCopier = (*ActivityTimestamp)(nil)
// ######################
// ##
// ## Activity
// ##
// ######################
// ActivityType https://discord.com/developers/docs/topics/gateway#activity-object-activity-types
type ActivityType uint
const (
ActivityTypeGame ActivityType = iota
ActivityTypeStreaming
ActivityTypeListening
_
ActivityTypeCustom
ActivityTypeCompeting
)
// ActivityFlag https://discord.com/developers/docs/topics/gateway#activity-object-activity-flags
type ActivityFlag uint
// flags for the Activity object to signify the type of action taken place
const (
ActivityFlagInstance ActivityFlag = 1 << iota
ActivityFlagJoin
ActivityFlagSpectate
ActivityFlagJoinRequest
ActivityFlagSync
ActivityFlagPlay
)
// Activity https://discord.com/developers/docs/topics/gateway#activity-object-activity-structure
type Activity struct {
Name string `json:"name"`
Type ActivityType `json:"type"`
URL string `json:"url,omitempty"`
CreatedAt int `json:"created_at"`
Timestamps *ActivityTimestamp `json:"timestamps,omitempty"`
ApplicationID Snowflake `json:"application_id,omitempty"`
Details string `json:"details,omitempty"`
State string `json:"state,omitempty"`
Emoji *ActivityEmoji `json:"emoji,omitempty"`
Party *ActivityParty `json:"party,omitempty"`
Assets *ActivityAssets `json:"assets,omitempty"`
Secrets *ActivitySecrets `json:"secrets,omitempty"`
Instance bool `json:"instance,omitempty"`
Flags ActivityFlag `json:"flags,omitempty"`
}
var _ Reseter = (*Activity)(nil)
var _ Copier = (*Activity)(nil)
var _ DeepCopier = (*Activity)(nil)
// ---------
type UserFlag uint64
const (
UserFlagNone UserFlag = 0
UserFlagDiscordEmployee UserFlag = 1 << iota
UserFlagDiscordPartner
UserFlagHypeSquadEvents
UserFlagBugHunterLevel1
_
_
UserFlagHouseBravery
UserFlagHouseBrilliance
UserFlagHouseBalance
UserFlagEarlySupporter
UserFlagTeamUser
_
UserFlagSystem
_
UserFlagBugHunterLevel2
_
UserFlagVerifiedBot
UserFlagVerifiedBotDeveloper
UserFlagDiscordCertifiedModerator
)
type PremiumType int
func (p PremiumType) String() (t string) {
switch p {
case PremiumTypeNone:
t = "None"
case PremiumTypeNitroClassic:
t = "Nitro Classic"
case PremiumTypeNitro:
t = "Nitro"
default:
t = ""
}
return t
}
var _ fmt.Stringer = (*PremiumType)(nil)
const (
PremiumTypeNone PremiumType = iota
PremiumTypeNitroClassic
PremiumTypeNitro
)
// User the Discord user object which is reused in most other data structures.
type User struct {
ID Snowflake `json:"id,omitempty"`
Username string `json:"username,omitempty"`
Discriminator Discriminator `json:"discriminator,omitempty"`
Avatar string `json:"avatar"` // data:image/jpeg;base64,BASE64_ENCODED_JPEG_IMAGE_DATA
Bot bool `json:"bot,omitempty"`
System bool `json:"system,omitempty"`
MFAEnabled bool `json:"mfa_enabled,omitempty"`
Locale string `json:"locale,omitempty"`
Verified bool `json:"verified,omitempty"`
Email string `json:"email,omitempty"`
Flags UserFlag `json:"flag,omitempty"`
PremiumType PremiumType `json:"premium_type,omitempty"`
PublicFlags UserFlag `json:"public_flag,omitempty"`
PartialMember *Member `json:"member"` // may be populated by Message
}
var _ Reseter = (*User)(nil)
var _ DeepCopier = (*User)(nil)
var _ Copier = (*User)(nil)
var _ Mentioner = (*User)(nil)
// Mention returns the a string that Discord clients can format into a valid Discord mention
func (u *User) Mention() string {
return "<@" + u.ID.String() + ">"
}
// AvatarURL returns a link to the Users avatar with the given size.
func (u *User) AvatarURL(size int, preferGIF bool) (url string, err error) {
if size > 2048 || size < 16 || (size&(size-1)) > 0 {
return "", errors.New("image size can be any power of two between 16 and 2048")
}
if u.Avatar == "" {
url = fmt.Sprintf("https://cdn.discordapp.com/embed/avatars/%d.png?size=%d", u.Discriminator%5, size)
} else if strings.HasPrefix(u.Avatar, "a_") && preferGIF {
url = fmt.Sprintf("https://cdn.discordapp.com/avatars/%d/%s.gif?size=%d", u.ID, u.Avatar, size)
} else {
url = fmt.Sprintf("https://cdn.discordapp.com/avatars/%d/%s.webp?size=%d", u.ID, u.Avatar, size)
}
return
}
// Tag formats the user to Anders#1234
func (u *User) Tag() string {
return u.Username + "#" + u.Discriminator.String()
}
// String formats the user to Anders#1234{1234567890}
func (u *User) String() string {
return u.Tag() + "{" + u.ID.String() + "}"
}
// SendMsg send a message to a user where you utilize a Message object instead of a string
func (u *User) SendMsg(ctx context.Context, session Session, message *Message) (channel *Channel, msg *Message, err error) {
channel, err = session.User(u.ID).WithContext(ctx).CreateDM()
if err != nil {
return
}
msg, err = session.WithContext(ctx).SendMsg(channel.ID, message)
return
}
// SendMsgString send a message to given user where the message is in the form of a string.
func (u *User) SendMsgString(ctx context.Context, session Session, content string) (channel *Channel, msg *Message, err error) {
channel, msg, err = u.SendMsg(ctx, session, &Message{
Content: content,
})
return
}
// Valid ensure the user object has enough required information to be used in Discord interactions
func (u *User) Valid() bool {
return u.ID > 0
}
// -------
// UserPresence presence info for a guild member or friend/user in a DM
type UserPresence struct {
User *User `json:"user"`
Roles []Snowflake `json:"roles"`
Game *Activity `json:"activity"`
GuildID Snowflake `json:"guild_id"`
Nick string `json:"nick"`
Status string `json:"status"`
}
var _ Copier = (*UserPresence)(nil)
var _ DeepCopier = (*UserPresence)(nil)
func (p *UserPresence) String() string {
return p.Status
}
// UserConnection ...
type UserConnection struct {
ID string `json:"id"` // id of the connection account
Name string `json:"name"` // the username of the connection account
Type string `json:"type"` // the service of the connection (twitch, youtube)
Revoked bool `json:"revoked"` // whether the connection is revoked
Integrations []*IntegrationAccount `json:"integrations"` // an array of partial server integrations
}
var _ Copier = (*UserConnection)(nil)
var _ DeepCopier = (*UserConnection)(nil)
//////////////////////////////////////////////////////
//
// REST Methods
//
//////////////////////////////////////////////////////
// UserQueryBuilder REST interface for all user endpoints
type UserQueryBuilder interface {
WithContext(ctx context.Context) UserQueryBuilder
WithFlags(flags ...Flag) UserQueryBuilder
// Get Returns a user object for a given user Snowflake.
Get() (*User, error)
// CreateDM Create a new DM channel with a user. Returns a DM channel object.
CreateDM() (ret *Channel, err error)
}
// User is used to create a guild query builder.
func (c clientQueryBuilder) User(id Snowflake) UserQueryBuilder {
return &userQueryBuilder{client: c.client, uid: id}
}
// The default guild query builder.
type userQueryBuilder struct {
ctx context.Context
flags Flag
client *Client
uid Snowflake
}
func (c userQueryBuilder) WithContext(ctx context.Context) UserQueryBuilder {
c.ctx = ctx
return &c
}
func (c userQueryBuilder) WithFlags(flags ...Flag) UserQueryBuilder {
c.flags = mergeFlags(flags)
return &c
}
// Get [REST] Returns a user object for a given user Snowflake.
//
// Method GET
// Endpoint /users/{user.id}
// Discord documentation https://discord.com/developers/docs/resources/user#get-user
// Reviewed 2018-06-10
// Comment -
func (c userQueryBuilder) Get() (*User, error) {
if !ignoreCache(c.flags) {
if usr, _ := c.client.cache.GetUser(c.uid); usr != nil {
return usr, nil
}
}
r := c.client.newRESTRequest(&httd.Request{
Endpoint: endpoint.User(c.uid),
Ctx: c.ctx,
}, c.flags)
r.pool = c.client.pool.user
r.factory = userFactory
return getUser(r.Execute)
}
// CreateDM [REST] Create a new DM channel with a user. Returns a DM channel object.
//
// Method POST
// Endpoint /users/@me/channels
// Discord documentation https://discord.com/developers/docs/resources/user#create-dm
// Reviewed 2019-02-23
// Comment -
func (c userQueryBuilder) CreateDM() (ret *Channel, err error) {
r := c.client.newRESTRequest(&httd.Request{
Method: http.MethodPost,
Ctx: c.ctx,
Endpoint: endpoint.UserMeChannels(),
Body: &struct {
RecipientID Snowflake `json:"recipient_id"`
}{c.uid},
ContentType: httd.ContentTypeJSON,
}, c.flags)
r.factory = func() interface{} {
return &Channel{}
}
return getChannel(r.Execute)
}
type CurrentUserQueryBuilder interface {
WithContext(ctx context.Context) CurrentUserQueryBuilder
WithFlags(flags ...Flag) CurrentUserQueryBuilder
// Get Returns the user object of the requester's account. For OAuth2, this requires the identify
// scope, which will return the object without an email, and optionally the email scope, which returns the object
// with an email.
Get() (*User, error)
// GetGuilds Returns a list of partial guild objects the current user is a member of.
// Requires the Guilds OAuth2 scope.
GetGuilds(params *GetCurrentUserGuilds) (ret []*Guild, err error)
Update(params *UpdateUser) (*User, error)
// CreateGroupDM Create a new group DM channel with multiple Users. Returns a DM channel object.
// This endpoint was intended to be used with the now-deprecated GameBridge SDK. DMs created with this
// endpoint will not be shown in the Discord Client
CreateGroupDM(params *CreateGroupDM) (ret *Channel, err error)
// GetConnections Returns a list of connection objects. Requires the connections OAuth2 scope.
GetConnections() (ret []*UserConnection, err error)
}
// CurrentUser is used to create a guild query builder.
func (c clientQueryBuilder) CurrentUser() CurrentUserQueryBuilder {
return ¤tUserQueryBuilder{client: c.client}
}
// The default guild query builder.
type currentUserQueryBuilder struct {
ctx context.Context
flags Flag
client *Client
}
func (c *currentUserQueryBuilder) validate() error {
if c.client == nil {
return ErrMissingClientInstance
}
return nil
}
var _ CurrentUserQueryBuilder = (*currentUserQueryBuilder)(nil)
func (c currentUserQueryBuilder) WithContext(ctx context.Context) CurrentUserQueryBuilder {
c.ctx = ctx
return &c
}
func (c currentUserQueryBuilder) WithFlags(flags ...Flag) CurrentUserQueryBuilder {
c.flags = mergeFlags(flags)
return &c
}
// Get [REST] Returns the user object of the requester's account. For OAuth2, this requires the identify
// scope, which will return the object without an email, and optionally the email scope, which returns the object
// with an email.
//
// Method GET
// Endpoint /users/@me
// Discord documentation https://discord.com/developers/docs/resources/user#get-current-user
// Reviewed 2019-02-23
// Comment -
func (c currentUserQueryBuilder) Get() (user *User, err error) {
if !ignoreCache(c.flags) {
if usr, err := c.client.cache.GetCurrentUser(); err != nil && usr != nil {
return usr, nil
}
}
r := c.client.newRESTRequest(&httd.Request{
Endpoint: endpoint.UserMe(),
Ctx: c.ctx,
}, c.flags)
r.pool = c.client.pool.user
r.factory = userFactory
return getUser(r.Execute)
}
// Update update current user
func (c currentUserQueryBuilder) Update(params *UpdateUser) (*User, error) {
if params == nil {
return nil, ErrMissingRESTParams
}
if err := c.validate(); err != nil {
return nil, err
}
r := c.client.newRESTRequest(&httd.Request{
Method: http.MethodPatch,
Ctx: c.ctx,
Endpoint: endpoint.UserMe(),
ContentType: httd.ContentTypeJSON,
Body: params,
}, c.flags)
r.pool = c.client.pool.user
r.factory = userFactory
return getUser(r.Execute)
}
type UpdateUser struct {
Username *string `json:"username,omitempty"`
Avatar *string `json:"avatar,omitempty"`
}
// GetCurrentUserGuilds JSON params for func GetCurrentUserGuilds
type GetCurrentUserGuilds struct {
Before Snowflake `urlparam:"before,omitempty"`
After Snowflake `urlparam:"after,omitempty"`
Limit int `urlparam:"limit,omitempty"`
}
var _ URLQueryStringer = (*GetCurrentUserGuilds)(nil)
// GetGuilds [REST] Returns a list of partial guild objects the current user is a member of.
// Requires the Guilds OAuth2 scope.
//
// Method GET
// Endpoint /users/@me/guilds
// Discord documentation https://discord.com/developers/docs/resources/user#get-current-user-guilds
// Reviewed 2019-02-18
// Comment This endpoint. returns 100 Guilds by default, which is the maximum number of
// Guilds a non-bot user can join. Therefore, pagination is not needed for
// integrations that need to get a list of Users' Guilds.
func (c currentUserQueryBuilder) GetGuilds(params *GetCurrentUserGuilds) (ret []*Guild, err error) {
r := c.client.newRESTRequest(&httd.Request{
Endpoint: endpoint.UserMeGuilds(),
Ctx: c.ctx,
}, c.flags)
r.factory = func() interface{} {
tmp := make([]*Guild, 0)
return &tmp
}
var vs interface{}
if vs, err = r.Execute(); err != nil {
return nil, err
}
if guilds, ok := vs.(*[]*Guild); ok {
return *guilds, nil
}
return nil, errors.New("unable to cast guild slice")
}
// CreateGroupDM required JSON params for func CreateGroupDM
// https://discord.com/developers/docs/resources/user#create-group-dm
type CreateGroupDM struct {
// AccessTokens access tokens of Users that have granted your app the gdm.join scope
AccessTokens []string `json:"access_tokens"`
// map[UserID] = nickname
Nicks map[Snowflake]string `json:"nicks"`
}
// CreateGroupDM [REST] Create a new group DM channel with multiple Users. Returns a DM channel object.
// This endpoint was intended to be used with the now-deprecated GameBridge SDK. DMs created with this
// endpoint will not be shown in the Discord Client
//
// Method POST
// Endpoint /users/@me/channels
// Discord documentation https://discord.com/developers/docs/resources/user#create-group-dm
// Reviewed 2019-02-19
// Comment -
func (c currentUserQueryBuilder) CreateGroupDM(params *CreateGroupDM) (ret *Channel, err error) {
r := c.client.newRESTRequest(&httd.Request{
Method: http.MethodPost,
Ctx: c.ctx,
Endpoint: endpoint.UserMeChannels(),
Body: params,
ContentType: httd.ContentTypeJSON,
}, c.flags)
r.factory = func() interface{} {
return &Channel{}
}
// TODO: go generate casting func: return getChannel(r.Execute)
return getChannel(r.Execute)
}
// GetConnections https://discord.com/developers/docs/resources/user#get-user-connections
func (c currentUserQueryBuilder) GetConnections() (connections []*UserConnection, err error) {
r := c.client.newRESTRequest(&httd.Request{
Endpoint: endpoint.UserMeConnections(),
Ctx: c.ctx,
}, c.flags)
r.factory = func() interface{} {
tmp := make([]*UserConnection, 0)
return &tmp
}
var vs interface{}
if vs, err = r.Execute(); err != nil {
return nil, err
}
if cons, ok := vs.(*[]*UserConnection); ok {
return *cons, nil
}
return nil, errors.New("unable to cast guild slice")
}
func userFactory() interface{} {
return &User{}
}