forked from bwmarrin/discordgo
-
Notifications
You must be signed in to change notification settings - Fork 0
/
restapi.go
656 lines (514 loc) · 20.1 KB
/
restapi.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
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
// Discordgo - Discord bindings for Go
// Available at https://github.com/bwmarrin/discordgo
// Copyright 2015 Bruce Marriner <bruce@sqls.net>. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
// This file contains functions for interacting with the Discord REST/JSON API
// at the lowest level.
package discordgo
import (
"bytes"
"encoding/json"
"fmt"
"io/ioutil"
"net/http"
"net/url"
"strconv"
"time"
)
// Request makes a (GET/POST/...) Requests to Discord REST API.
// All the other Discord REST Calls in this file use this function.
func (s *Session) Request(method, urlStr string, data interface{}) (response []byte, err error) {
if s.Debug {
fmt.Printf("API REQUEST %8s :: %s\n", method, urlStr)
fmt.Println("API REQUEST PAYLOAD :: [" + fmt.Sprintf("%+v", data) + "]")
}
body, err := json.Marshal(data)
if err != nil {
return
}
req, err := http.NewRequest(method, urlStr, bytes.NewBuffer(body))
if err != nil {
return
}
// Not used on initial login..
// TODO: Verify if a login, otherwise complain about no-token
if s.Token != "" {
req.Header.Set("authorization", s.Token)
}
req.Header.Set("Content-Type", "application/json")
// TODO: Make a configurable static variable.
req.Header.Set("User-Agent", fmt.Sprintf("DiscordBot (https://github.com/bwmarrin/discordgo, v%s)", VERSION))
if s.Debug {
for k, v := range req.Header {
fmt.Printf("API REQUEST HEADER :: [%s] = %+v\n", k, v)
}
}
client := &http.Client{Timeout: (20 * time.Second)}
resp, err := client.Do(req)
if err != nil {
return
}
response, err = ioutil.ReadAll(resp.Body)
if err != nil {
return
}
resp.Body.Close()
if s.Debug {
fmt.Printf("API RESPONSE STATUS :: %s\n", resp.Status)
for k, v := range resp.Header {
fmt.Printf("API RESPONSE HEADER :: [%s] = %+v\n", k, v)
}
fmt.Printf("API RESPONSE BODY :: [%s]\n", response)
}
// See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
switch resp.StatusCode {
case 200: // OK
case 204: // No Content
// TODO check for 401 response, invalidate token if we get one.
// TODO check for 429 response, rate-limit when we get one.
default: // Error condition
err = fmt.Errorf("HTTP %d", resp.StatusCode)
return
}
return
}
// ------------------------------------------------------------------------------------------------
// Functions specific to Discord Sessions
// ------------------------------------------------------------------------------------------------
// Login asks the Discord server for an authentication token
func (s *Session) Login(email string, password string) (token string, err error) {
data := struct {
Email string `json:"email"`
Password string `json:"password"`
}{email, password}
response, err := s.Request("POST", LOGIN, data)
var temp map[string]interface{}
err = json.Unmarshal(response, &temp)
token = temp["token"].(string)
return
}
// Logout sends a logout request to Discord.
// This does not seem to actually invalidate the token. So you can still
// make API calls even after a Logout. So, it seems almost pointless to
// even use.
func (s *Session) Logout() (err error) {
// _, err = s.Request("POST", LOGOUT, fmt.Sprintf(`{"token": "%s"}`, s.Token))
return
}
// ------------------------------------------------------------------------------------------------
// Functions specific to Discord Users
// ------------------------------------------------------------------------------------------------
// User returns the user details of the given userID
// userID : A user ID or "@me" which is a shortcut of current user ID
func (s *Session) User(userID string) (st User, err error) {
body, err := s.Request("GET", USER(userID), nil)
err = json.Unmarshal(body, &st)
return
}
// UserUpdate updates a users settings.
// userID : A user ID or "@me" which is a shortcut of current user ID
func (s *Session) UserUpdate(userID, email, password, username, avatar, newPassword string) (st User, err error) {
// NOTE: Avatar must be either the hash/id of existing Avatar or
// data:image/png;base64,BASE64_STRING_OF_NEW_AVATAR_PNG
// to set a new avatar.
// If left blank, avatar will be set to null/blank
data := struct {
Email string `json:"email"`
Password string `json:"password"`
Username string `json:"username"`
Avatar string `json:"avatar,omitempty"`
NewPassword json.Token `json:"new_password,omitempty"`
}{email, password, username, avatar, newPassword}
body, err := s.Request("PATCH", USER(userID), data)
err = json.Unmarshal(body, &st)
return
}
// UserAvatar returns a ?? of a users Avatar
// userID : A user ID or "@me" which is a shortcut of current user ID
func (s *Session) UserAvatar(userID string) (st User, err error) {
u, err := s.User(userID)
_, err = s.Request("GET", USER_AVATAR(userID, u.Avatar), nil)
// TODO need to figure out how to handle returning a file
return
}
// UserSettings returns the settings for a given user
// userID : A user ID or "@me" which is a shortcut of current user ID
// This seems to only return a result for "@me"
func (s *Session) UserSettings(userID string) (st Settings, err error) {
body, err := s.Request("GET", USER_SETTINGS(userID), nil)
err = json.Unmarshal(body, &st)
return
}
// UserChannels returns an array of Channel structures for all private
// channels for a user
// userID : A user ID or "@me" which is a shortcut of current user ID
func (s *Session) UserChannels(userID string) (st []Channel, err error) {
body, err := s.Request("GET", USER_CHANNELS(userID), nil)
err = json.Unmarshal(body, &st)
return
}
// UserChannelCreate creates a new User (Private) Channel with another User
// userID : A user ID or "@me" which is a shortcut of current user ID
// recipientID : A user ID for the user to which this channel is opened with.
func (s *Session) UserChannelCreate(userID, recipientID string) (st Channel, err error) {
data := struct {
RecipientID string `json:"recipient_id"`
}{recipientID}
body, err := s.Request(
"POST",
USER_CHANNELS(userID),
data)
err = json.Unmarshal(body, &st)
return
}
// UserGuilds returns an array of Guild structures for all guilds for a given user
// userID : A user ID or "@me" which is a shortcut of current user ID
func (s *Session) UserGuilds(userID string) (st []Guild, err error) {
body, err := s.Request("GET", USER_GUILDS(userID), nil)
err = json.Unmarshal(body, &st)
return
}
// ------------------------------------------------------------------------------------------------
// Functions specific to Discord Guilds
// ------------------------------------------------------------------------------------------------
// Guild returns a Guild structure of a specific Guild.
// guildID : The ID of a Guild
func (s *Session) Guild(guildID string) (st Guild, err error) {
body, err := s.Request("GET", GUILD(guildID), nil)
err = json.Unmarshal(body, &st)
return
}
// GuildCreate creates a new Guild
// name : A name for the Guild (2-100 characters)
func (s *Session) GuildCreate(name string) (st Guild, err error) {
data := struct {
Name string `json:"name"`
}{name}
body, err := s.Request("POST", GUILDS, data)
err = json.Unmarshal(body, &st)
return
}
// GuildEdit edits a new Guild
// guildID : The ID of a Guild
// name : A name for the Guild (2-100 characters)
func (s *Session) GuildEdit(guildID, name string) (st Guild, err error) {
data := struct {
Name string `json:"name"`
}{name}
body, err := s.Request("POST", GUILD(guildID), data)
err = json.Unmarshal(body, &st)
return
}
// GuildDelete deletes or leaves a Guild.
// guildID : The ID of a Guild
func (s *Session) GuildDelete(guildID string) (st Guild, err error) {
body, err := s.Request("DELETE", GUILD(guildID), nil)
err = json.Unmarshal(body, &st)
return
}
// GuildBans returns an array of User structures for all bans of a
// given guild.
// guildID : The ID of a Guild.
func (s *Session) GuildBans(guildID string) (st []User, err error) {
body, err := s.Request("GET", GUILD_BANS(guildID), nil)
err = json.Unmarshal(body, &st)
return
}
// GuildBanCreate bans the given user from the given guild.
// guildID : The ID of a Guild.
// userID : The ID of a User
// days : The number of days of previous comments to delete.
func (s *Session) GuildBanCreate(guildID, userID string, days int) (err error) {
uri := GUILD_BAN(guildID, userID)
if days > 0 {
uri = fmt.Sprintf("%s?delete-message-days=%d", uri, days)
}
_, err = s.Request("PUT", uri, nil)
return
}
// GuildBanDelete removes the given user from the guild bans
// guildID : The ID of a Guild.
// userID : The ID of a User
func (s *Session) GuildBanDelete(guildID, userID string) (err error) {
_, err = s.Request("DELETE", GUILD_BAN(guildID, userID), nil)
return
}
// GuildMemberDelete removes the given user from the given guild.
// guildID : The ID of a Guild.
// userID : The ID of a User
func (s *Session) GuildMemberDelete(guildID, userID string) (err error) {
_, err = s.Request("DELETE", GUILD_MEMBER_DEL(guildID, userID), nil)
return
}
// GuildChannels returns an array of Channel structures for all channels of a
// given guild.
// guildID : The ID of a Guild.
func (s *Session) GuildChannels(guildID string) (st []Channel, err error) {
body, err := s.Request("GET", GUILD_CHANNELS(guildID), nil)
err = json.Unmarshal(body, &st)
return
}
// GuildChannelCreate creates a new channel in the given guild
// guildID : The ID of a Guild.
// name : Name of the channel (2-100 chars length)
// ctype : Tpye of the channel (voice or text)
func (s *Session) GuildChannelCreate(guildID, name, ctype string) (st Channel, err error) {
data := struct {
Name string `json:"name"`
Type string `json:"type"`
}{name, ctype}
body, err := s.Request("POST", GUILD_CHANNELS(guildID), data)
err = json.Unmarshal(body, &st)
return
}
// GuildInvites returns an array of Invite structures for the given guild
// guildID : The ID of a Guild.
func (s *Session) GuildInvites(guildID string) (st []Invite, err error) {
body, err := s.Request("GET", GUILD_INVITES(guildID), nil)
err = json.Unmarshal(body, &st)
return
}
// GuildInviteCreate creates a new invite for the given guild.
// guildID : The ID of a Guild.
// i : An Invite struct with the values MaxAge, MaxUses, Temporary,
// and XkcdPass defined.
func (s *Session) GuildInviteCreate(guildID string, i Invite) (st Invite, err error) {
data := struct {
MaxAge int `json:"max_age"`
MaxUses int `json:"max_uses"`
Temporary bool `json:"temporary"`
XKCDPass bool `json:"xkcdpass"`
}{i.MaxAge, i.MaxUses, i.Temporary, i.XkcdPass}
body, err := s.Request("POST", GUILD_INVITES(guildID), data)
err = json.Unmarshal(body, &st)
return
}
// GuildRoles returns all roles for a given guild.
func (s *Session) GuildRoles(guildID string) (st []Role, err error) {
body, err := s.Request("GET", GUILD_ROLES(guildID), nil)
err = json.Unmarshal(body, &st)
return // TODO return pointer
}
// GuildRoleCreate returns a new Guild Role
func (s *Session) GuildRoleCreate(guildID string) (st Role, err error) {
body, err := s.Request("POST", GUILD_ROLES(guildID), nil)
err = json.Unmarshal(body, &st)
return
}
// GuildRoleEdit updates an existing Guild Role with new values
func (s *Session) GuildRoleEdit(guildID, roleID, name string, color int, hoist bool, perm int) (st Role, err error) {
data := struct {
Name string `json:"name"` // The color the role should have (as a decimal, not hex)
Color int `json:"color"` // Whether to display the role's users separately
Hoist bool `json:"hoist"` // The role's name (overwrites existing)
Permissions int `json:"permissions"` // The overall permissions number of the role (overwrites existing)
}{name, color, hoist, perm}
body, err := s.Request("PATCH", GUILD_ROLE(guildID, roleID), data)
err = json.Unmarshal(body, &st)
return
}
// GuildRoleReorder reoders guild roles
func (s *Session) GuildRoleReorder(guildID string, roles []Role) (st []Role, err error) {
body, err := s.Request("PATCH", GUILD_ROLES(guildID), roles)
err = json.Unmarshal(body, &st)
return
}
// GuildRoleDelete deletes an existing role.
func (s *Session) GuildRoleDelete(guildID, roleID string) (err error) {
_, err = s.Request("DELETE", GUILD_ROLE(guildID, roleID), nil)
return
}
// ------------------------------------------------------------------------------------------------
// Functions specific to Discord Channels
// ------------------------------------------------------------------------------------------------
// Channel returns a Channel strucutre of a specific Channel.
// channelID : The ID of the Channel you want returend.
func (s *Session) Channel(channelID string) (st Channel, err error) {
body, err := s.Request("GET", CHANNEL(channelID), nil)
err = json.Unmarshal(body, &st)
return
}
// ChannelEdit edits the given channel
// channelID : The ID of a Channel
// name : The new name to assign the channel.
func (s *Session) ChannelEdit(channelID, name string) (st Channel, err error) {
data := struct {
Name string `json:"name"`
}{name}
body, err := s.Request("PATCH", CHANNEL(channelID), data)
err = json.Unmarshal(body, &st)
return
}
// ChannelDelete deletes the given channel
// channelID : The ID of a Channel
func (s *Session) ChannelDelete(channelID string) (st Channel, err error) {
body, err := s.Request("DELETE", CHANNEL(channelID), nil)
err = json.Unmarshal(body, &st)
return
}
// ChannelTyping broadcasts to all members that authenticated user is typing in
// the given channel.
// channelID : The ID of a Channel
func (s *Session) ChannelTyping(channelID string) (err error) {
_, err = s.Request("POST", CHANNEL_TYPING(channelID), nil)
return
}
// ChannelMessages returns an array of Message structures for messaages within
// a given channel.
// channelID : The ID of a Channel.
// limit : The number messages that can be returned.
// beforeID : If provided all messages returned will be before given ID.
// afterID : If provided all messages returned will be after given ID.
func (s *Session) ChannelMessages(channelID string, limit int, beforeID int, afterID int) (st []Message, err error) {
uri := CHANNEL_MESSAGES(channelID)
v := url.Values{}
if limit > 0 {
v.Set("limit", strconv.Itoa(limit))
}
if afterID > 0 {
v.Set("after", strconv.Itoa(afterID))
}
if beforeID > 0 {
v.Set("before", strconv.Itoa(beforeID))
}
if len(v) > 0 {
uri = fmt.Sprintf("%s?%s", uri, v.Encode())
}
body, err := s.Request("GET", uri, nil)
if err != nil {
return
}
err = json.Unmarshal(body, &st)
return
}
// ChannelMessageAck acknowledges and marks the given message as read
// channeld : The ID of a Channel
// messageID : the ID of a Message
func (s *Session) ChannelMessageAck(channelID, messageID string) (err error) {
_, err = s.Request("POST", CHANNEL_MESSAGE_ACK(channelID, messageID), nil)
return
}
// ChannelMessageSend sends a message to the given channel.
// channelID : The ID of a Channel.
// content : The message to send.
// NOTE, mention and tts parameters may be added in 2.x branch.
func (s *Session) ChannelMessageSend(channelID string, content string) (st Message, err error) {
// TODO: nonce string ?
data := struct {
Content string `json:"content"`
TTS bool `json:"tts"`
}{content, false}
// Send the message to the given channel
response, err := s.Request("POST", CHANNEL_MESSAGES(channelID), data)
err = json.Unmarshal(response, &st)
return
}
// ChannelMessageEdit edits an existing message, replacing it entirely with
// the given content.
// channeld : The ID of a Channel
// messageID : the ID of a Message
func (s *Session) ChannelMessageEdit(channelID, messageID, content string) (st Message, err error) {
data := struct {
Content string `json:"content"`
}{content}
response, err := s.Request("PATCH", CHANNEL_MESSAGE(channelID, messageID), data)
err = json.Unmarshal(response, &st)
return
}
// ChannelMessageDelete deletes a message from the Channel.
func (s *Session) ChannelMessageDelete(channelID, messageID string) (err error) {
_, err = s.Request("DELETE", CHANNEL_MESSAGE(channelID, messageID), nil)
return
}
// ChannelInvites returns an array of Invite structures for the given channel
// channelID : The ID of a Channel
func (s *Session) ChannelInvites(channelID string) (st []Invite, err error) {
body, err := s.Request("GET", CHANNEL_INVITES(channelID), nil)
err = json.Unmarshal(body, &st)
return
}
// ChannelInviteCreate creates a new invite for the given channel.
// channelID : The ID of a Channel
// i : An Invite struct with the values MaxAge, MaxUses, Temporary,
// and XkcdPass defined.
func (s *Session) ChannelInviteCreate(channelID string, i Invite) (st Invite, err error) {
data := struct {
MaxAge int `json:"max_age"`
MaxUses int `json:"max_uses"`
Temporary bool `json:"temporary"`
XKCDPass bool `json:"xkcdpass"`
}{i.MaxAge, i.MaxUses, i.Temporary, i.XkcdPass}
body, err := s.Request("POST", CHANNEL_INVITES(channelID), data)
err = json.Unmarshal(body, &st)
return
}
// ChannelPermissionSet creates a Permission Override for the given channel.
// NOTE: This func name may changed. Using Set instead of Create because
// you can both create a new override or update an override with this function.
func (s *Session) ChannelPermissionSet(channelID, targetID, targetType string, allow, deny int) (err error) {
data := struct {
ID string `json:"id"`
Type string `json:"type"`
Allow int `json:"allow"`
Deny int `json:"deny"`
}{targetID, targetType, allow, deny}
_, err = s.Request("PUT", CHANNEL_PERMISSION(channelID, targetID), data)
return
}
// ChannelPermissionDelete deletes a specific permission override for the given channel.
// NOTE: Name of this func may change.
func (s *Session) ChannelPermissionDelete(channelID, targetID string) (err error) {
_, err = s.Request("DELETE", CHANNEL_PERMISSION(channelID, targetID), nil)
return
}
// ------------------------------------------------------------------------------------------------
// Functions specific to Discord Invites
// ------------------------------------------------------------------------------------------------
// Invite returns an Invite structure of the given invite
// inviteID : The invite code (or maybe xkcdpass?)
func (s *Session) Invite(inviteID string) (st Invite, err error) {
body, err := s.Request("GET", INVITE(inviteID), nil)
err = json.Unmarshal(body, &st)
return
}
// InviteDelete deletes an existing invite
// inviteID : the code (or maybe xkcdpass?) of an invite
func (s *Session) InviteDelete(inviteID string) (st Invite, err error) {
body, err := s.Request("DELETE", INVITE(inviteID), nil)
err = json.Unmarshal(body, &st)
return
}
// InviteAccept accepts an Invite to a Guild or Channel
// inviteID : The invite code (or maybe xkcdpass?)
func (s *Session) InviteAccept(inviteID string) (st Invite, err error) {
body, err := s.Request("POST", INVITE(inviteID), nil)
err = json.Unmarshal(body, &st)
return
}
// ------------------------------------------------------------------------------------------------
// Functions specific to Discord Voice
// ------------------------------------------------------------------------------------------------
// VoiceRegions returns the voice server regions
func (s *Session) VoiceRegions() (st []VoiceRegion, err error) {
body, err := s.Request("GET", VOICE_REGIONS, nil)
err = json.Unmarshal(body, &st)
return
}
// VoiceICE returns the voice server ICE information
func (s *Session) VoiceICE() (st VoiceICE, err error) {
body, err := s.Request("GET", VOICE_ICE, nil)
err = json.Unmarshal(body, &st)
return
}
// ------------------------------------------------------------------------------------------------
// Functions specific to Discord Websockets
// ------------------------------------------------------------------------------------------------
// Gateway returns the a websocket Gateway address
func (s *Session) Gateway() (gateway string, err error) {
response, err := s.Request("GET", GATEWAY, nil)
var temp map[string]interface{}
err = json.Unmarshal(response, &temp)
gateway = temp["url"].(string)
return
}