restapi.go 33 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279
  1. // Discordgo - Discord bindings for Go
  2. // Available at https://github.com/bwmarrin/discordgo
  3. // Copyright 2015-2016 Bruce Marriner <bruce@sqls.net>. All rights reserved.
  4. // Use of this source code is governed by a BSD-style
  5. // license that can be found in the LICENSE file.
  6. // This file contains functions for interacting with the Discord REST/JSON API
  7. // at the lowest level.
  8. package discordgo
  9. import (
  10. "bytes"
  11. "encoding/json"
  12. "errors"
  13. "fmt"
  14. "image"
  15. _ "image/jpeg" // For JPEG decoding
  16. _ "image/png" // For PNG decoding
  17. "io"
  18. "io/ioutil"
  19. "log"
  20. "mime/multipart"
  21. "net/http"
  22. "net/url"
  23. "strconv"
  24. "strings"
  25. "sync"
  26. "time"
  27. )
  28. // ErrJSONUnmarshal is returned for JSON Unmarshall errors.
  29. var ErrJSONUnmarshal = errors.New("json unmarshal")
  30. // Request makes a (GET/POST/...) Requests to Discord REST API with JSON data.
  31. // All the other Discord REST Calls in this file use this function.
  32. func (s *Session) Request(method, urlStr string, data interface{}) (response []byte, err error) {
  33. var body []byte
  34. if data != nil {
  35. body, err = json.Marshal(data)
  36. if err != nil {
  37. return
  38. }
  39. }
  40. return s.request(method, urlStr, "application/json", body)
  41. }
  42. // request makes a (GET/POST/...) Requests to Discord REST API.
  43. func (s *Session) request(method, urlStr, contentType string, b []byte) (response []byte, err error) {
  44. // rate limit mutex for this url
  45. // TODO: review for performance improvements
  46. // ideally we just ignore endpoints that we've never
  47. // received a 429 on. But this simple method works and
  48. // is a lot less complex :) It also might even be more
  49. // performat due to less checks and maps.
  50. var mu *sync.Mutex
  51. s.rateLimit.Lock()
  52. if s.rateLimit.url == nil {
  53. s.rateLimit.url = make(map[string]*sync.Mutex)
  54. }
  55. bu := strings.Split(urlStr, "?")
  56. mu, _ = s.rateLimit.url[bu[0]]
  57. if mu == nil {
  58. mu = new(sync.Mutex)
  59. s.rateLimit.url[urlStr] = mu
  60. }
  61. s.rateLimit.Unlock()
  62. if s.Debug {
  63. log.Printf("API REQUEST %8s :: %s\n", method, urlStr)
  64. log.Printf("API REQUEST PAYLOAD :: [%s]\n", string(b))
  65. }
  66. req, err := http.NewRequest(method, urlStr, bytes.NewBuffer(b))
  67. if err != nil {
  68. return
  69. }
  70. // Not used on initial login..
  71. // TODO: Verify if a login, otherwise complain about no-token
  72. if s.Token != "" {
  73. req.Header.Set("authorization", s.Token)
  74. }
  75. req.Header.Set("Content-Type", contentType)
  76. // TODO: Make a configurable static variable.
  77. req.Header.Set("User-Agent", fmt.Sprintf("DiscordBot (https://github.com/bwmarrin/discordgo, v%s)", VERSION))
  78. if s.Debug {
  79. for k, v := range req.Header {
  80. log.Printf("API REQUEST HEADER :: [%s] = %+v\n", k, v)
  81. }
  82. }
  83. client := &http.Client{Timeout: (20 * time.Second)}
  84. mu.Lock()
  85. resp, err := client.Do(req)
  86. mu.Unlock()
  87. if err != nil {
  88. return
  89. }
  90. defer func() {
  91. err := resp.Body.Close()
  92. if err != nil {
  93. log.Println("error closing resp body")
  94. }
  95. }()
  96. response, err = ioutil.ReadAll(resp.Body)
  97. if err != nil {
  98. return
  99. }
  100. if s.Debug {
  101. log.Printf("API RESPONSE STATUS :: %s\n", resp.Status)
  102. for k, v := range resp.Header {
  103. log.Printf("API RESPONSE HEADER :: [%s] = %+v\n", k, v)
  104. }
  105. log.Printf("API RESPONSE BODY :: [%s]\n\n\n", response)
  106. }
  107. switch resp.StatusCode {
  108. case http.StatusOK:
  109. case http.StatusCreated:
  110. case http.StatusNoContent:
  111. // TODO check for 401 response, invalidate token if we get one.
  112. case 429: // TOO MANY REQUESTS - Rate limiting
  113. rl := TooManyRequests{}
  114. err = json.Unmarshal(response, &rl)
  115. if err != nil {
  116. s.log(LogError, "rate limit unmarshal error, %s", err)
  117. return
  118. }
  119. s.log(LogInformational, "Rate Limiting %s, retry in %d", urlStr, rl.RetryAfter)
  120. s.handle(RateLimit{TooManyRequests: &rl, URL: urlStr})
  121. mu.Lock()
  122. time.Sleep(rl.RetryAfter)
  123. mu.Unlock()
  124. // we can make the above smarter
  125. // this method can cause longer delays then required
  126. response, err = s.request(method, urlStr, contentType, b)
  127. default: // Error condition
  128. err = fmt.Errorf("HTTP %s, %s", resp.Status, response)
  129. }
  130. return
  131. }
  132. func unmarshal(data []byte, v interface{}) error {
  133. err := json.Unmarshal(data, v)
  134. if err != nil {
  135. return ErrJSONUnmarshal
  136. }
  137. return nil
  138. }
  139. // ------------------------------------------------------------------------------------------------
  140. // Functions specific to Discord Sessions
  141. // ------------------------------------------------------------------------------------------------
  142. // Login asks the Discord server for an authentication token.
  143. func (s *Session) Login(email, password string) (err error) {
  144. data := struct {
  145. Email string `json:"email"`
  146. Password string `json:"password"`
  147. }{email, password}
  148. response, err := s.Request("POST", LOGIN, data)
  149. if err != nil {
  150. return
  151. }
  152. temp := struct {
  153. Token string `json:"token"`
  154. }{}
  155. err = unmarshal(response, &temp)
  156. if err != nil {
  157. return
  158. }
  159. s.Token = temp.Token
  160. return
  161. }
  162. // Register sends a Register request to Discord, and returns the authentication token
  163. // Note that this account is temporary and should be verified for future use.
  164. // Another option is to save the authentication token external, but this isn't recommended.
  165. func (s *Session) Register(username string) (token string, err error) {
  166. data := struct {
  167. Username string `json:"username"`
  168. }{username}
  169. response, err := s.Request("POST", REGISTER, data)
  170. if err != nil {
  171. return
  172. }
  173. temp := struct {
  174. Token string `json:"token"`
  175. }{}
  176. err = unmarshal(response, &temp)
  177. if err != nil {
  178. return
  179. }
  180. token = temp.Token
  181. return
  182. }
  183. // Logout sends a logout request to Discord.
  184. // This does not seem to actually invalidate the token. So you can still
  185. // make API calls even after a Logout. So, it seems almost pointless to
  186. // even use.
  187. func (s *Session) Logout() (err error) {
  188. // _, err = s.Request("POST", LOGOUT, fmt.Sprintf(`{"token": "%s"}`, s.Token))
  189. if s.Token == "" {
  190. return
  191. }
  192. data := struct {
  193. Token string `json:"token"`
  194. }{s.Token}
  195. _, err = s.Request("POST", LOGOUT, data)
  196. return
  197. }
  198. // ------------------------------------------------------------------------------------------------
  199. // Functions specific to Discord Users
  200. // ------------------------------------------------------------------------------------------------
  201. // User returns the user details of the given userID
  202. // userID : A user ID or "@me" which is a shortcut of current user ID
  203. func (s *Session) User(userID string) (st *User, err error) {
  204. body, err := s.Request("GET", USER(userID), nil)
  205. if err != nil {
  206. return
  207. }
  208. err = unmarshal(body, &st)
  209. return
  210. }
  211. // UserAvatar returns an image.Image of a users Avatar.
  212. // userID : A user ID or "@me" which is a shortcut of current user ID
  213. func (s *Session) UserAvatar(userID string) (img image.Image, err error) {
  214. u, err := s.User(userID)
  215. if err != nil {
  216. return
  217. }
  218. body, err := s.Request("GET", USER_AVATAR(userID, u.Avatar), nil)
  219. if err != nil {
  220. return
  221. }
  222. img, _, err = image.Decode(bytes.NewReader(body))
  223. return
  224. }
  225. // UserUpdate updates a users settings.
  226. func (s *Session) UserUpdate(email, password, username, avatar, newPassword string) (st *User, err error) {
  227. // NOTE: Avatar must be either the hash/id of existing Avatar or
  228. // data:image/png;base64,BASE64_STRING_OF_NEW_AVATAR_PNG
  229. // to set a new avatar.
  230. // If left blank, avatar will be set to null/blank
  231. data := struct {
  232. Email string `json:"email"`
  233. Password string `json:"password"`
  234. Username string `json:"username"`
  235. Avatar string `json:"avatar,omitempty"`
  236. NewPassword string `json:"new_password,omitempty"`
  237. }{email, password, username, avatar, newPassword}
  238. body, err := s.Request("PATCH", USER("@me"), data)
  239. if err != nil {
  240. return
  241. }
  242. err = unmarshal(body, &st)
  243. return
  244. }
  245. // UserSettings returns the settings for a given user
  246. func (s *Session) UserSettings() (st *Settings, err error) {
  247. body, err := s.Request("GET", USER_SETTINGS("@me"), nil)
  248. if err != nil {
  249. return
  250. }
  251. err = unmarshal(body, &st)
  252. return
  253. }
  254. // UserChannels returns an array of Channel structures for all private
  255. // channels.
  256. func (s *Session) UserChannels() (st []*Channel, err error) {
  257. body, err := s.Request("GET", USER_CHANNELS("@me"), nil)
  258. if err != nil {
  259. return
  260. }
  261. err = unmarshal(body, &st)
  262. return
  263. }
  264. // UserChannelCreate creates a new User (Private) Channel with another User
  265. // recipientID : A user ID for the user to which this channel is opened with.
  266. func (s *Session) UserChannelCreate(recipientID string) (st *Channel, err error) {
  267. data := struct {
  268. RecipientID string `json:"recipient_id"`
  269. }{recipientID}
  270. body, err := s.Request("POST", USER_CHANNELS("@me"), data)
  271. if err != nil {
  272. return
  273. }
  274. err = unmarshal(body, &st)
  275. return
  276. }
  277. // UserGuilds returns an array of Guild structures for all guilds.
  278. func (s *Session) UserGuilds() (st []*Guild, err error) {
  279. body, err := s.Request("GET", USER_GUILDS("@me"), nil)
  280. if err != nil {
  281. return
  282. }
  283. err = unmarshal(body, &st)
  284. return
  285. }
  286. // UserChannelPermissions returns the permission of a user in a channel.
  287. // userID : The ID of the user to calculate permissions for.
  288. // channelID : The ID of the channel to calculate permission for.
  289. func (s *Session) UserChannelPermissions(userID, channelID string) (apermissions int, err error) {
  290. channel, err := s.Channel(channelID)
  291. if err != nil {
  292. return
  293. }
  294. guild, err := s.Guild(channel.GuildID)
  295. if err != nil {
  296. return
  297. }
  298. if userID == guild.OwnerID {
  299. apermissions = PermissionAll
  300. return
  301. }
  302. member, err := s.GuildMember(guild.ID, userID)
  303. if err != nil {
  304. return
  305. }
  306. for _, role := range guild.Roles {
  307. for _, roleID := range member.Roles {
  308. if role.ID == roleID {
  309. apermissions |= role.Permissions
  310. break
  311. }
  312. }
  313. }
  314. if apermissions&PermissionManageRoles > 0 {
  315. apermissions |= PermissionAll
  316. }
  317. // Member overwrites can override role overrides, so do two passes
  318. for _, overwrite := range channel.PermissionOverwrites {
  319. for _, roleID := range member.Roles {
  320. if overwrite.Type == "role" && roleID == overwrite.ID {
  321. apermissions &= ^overwrite.Deny
  322. apermissions |= overwrite.Allow
  323. break
  324. }
  325. }
  326. }
  327. for _, overwrite := range channel.PermissionOverwrites {
  328. if overwrite.Type == "member" && overwrite.ID == userID {
  329. apermissions &= ^overwrite.Deny
  330. apermissions |= overwrite.Allow
  331. break
  332. }
  333. }
  334. if apermissions&PermissionManageRoles > 0 {
  335. apermissions |= PermissionAllChannel
  336. }
  337. return
  338. }
  339. // ------------------------------------------------------------------------------------------------
  340. // Functions specific to Discord Guilds
  341. // ------------------------------------------------------------------------------------------------
  342. // Guild returns a Guild structure of a specific Guild.
  343. // guildID : The ID of a Guild
  344. func (s *Session) Guild(guildID string) (st *Guild, err error) {
  345. if s.StateEnabled {
  346. // Attempt to grab the guild from State first.
  347. st, err = s.State.Guild(guildID)
  348. if err == nil {
  349. return
  350. }
  351. }
  352. body, err := s.Request("GET", GUILD(guildID), nil)
  353. if err != nil {
  354. return
  355. }
  356. err = unmarshal(body, &st)
  357. return
  358. }
  359. // GuildCreate creates a new Guild
  360. // name : A name for the Guild (2-100 characters)
  361. func (s *Session) GuildCreate(name string) (st *Guild, err error) {
  362. data := struct {
  363. Name string `json:"name"`
  364. }{name}
  365. body, err := s.Request("POST", GUILDS, data)
  366. if err != nil {
  367. return
  368. }
  369. err = unmarshal(body, &st)
  370. return
  371. }
  372. // GuildEdit edits a new Guild
  373. // guildID : The ID of a Guild
  374. // g : A GuildParams struct with the values Name, Region and VerificationLevel defined.
  375. func (s *Session) GuildEdit(guildID string, g GuildParams) (st *Guild, err error) {
  376. // Bounds checking for VerificationLevel, interval: [0, 3]
  377. if g.VerificationLevel != nil {
  378. val := *g.VerificationLevel
  379. if val < 0 || val > 3 {
  380. err = errors.New("VerificationLevel out of bounds, should be between 0 and 3")
  381. return
  382. }
  383. }
  384. //Bounds checking for regions
  385. if g.Region != "" {
  386. isValid := false
  387. regions, _ := s.VoiceRegions()
  388. for _, r := range regions {
  389. if g.Region == r.ID {
  390. isValid = true
  391. }
  392. }
  393. if !isValid {
  394. var valid []string
  395. for _, r := range regions {
  396. valid = append(valid, r.ID)
  397. }
  398. err = fmt.Errorf("Region not a valid region (%q)", valid)
  399. return
  400. }
  401. }
  402. data := struct {
  403. Name string `json:"name,omitempty"`
  404. Region string `json:"region,omitempty"`
  405. VerificationLevel *VerificationLevel `json:"verification_level,omitempty"`
  406. }{g.Name, g.Region, g.VerificationLevel}
  407. body, err := s.Request("PATCH", GUILD(guildID), data)
  408. if err != nil {
  409. return
  410. }
  411. err = unmarshal(body, &st)
  412. return
  413. }
  414. // GuildDelete deletes a Guild.
  415. // guildID : The ID of a Guild
  416. func (s *Session) GuildDelete(guildID string) (st *Guild, err error) {
  417. body, err := s.Request("DELETE", GUILD(guildID), nil)
  418. if err != nil {
  419. return
  420. }
  421. err = unmarshal(body, &st)
  422. return
  423. }
  424. // GuildLeave leaves a Guild.
  425. // guildID : The ID of a Guild
  426. func (s *Session) GuildLeave(guildID string) (err error) {
  427. _, err = s.Request("DELETE", USER_GUILD("@me", guildID), nil)
  428. return
  429. }
  430. // GuildBans returns an array of User structures for all bans of a
  431. // given guild.
  432. // guildID : The ID of a Guild.
  433. func (s *Session) GuildBans(guildID string) (st []*User, err error) {
  434. body, err := s.Request("GET", GUILD_BANS(guildID), nil)
  435. if err != nil {
  436. return
  437. }
  438. err = unmarshal(body, &st)
  439. return
  440. }
  441. // GuildBanCreate bans the given user from the given guild.
  442. // guildID : The ID of a Guild.
  443. // userID : The ID of a User
  444. // days : The number of days of previous comments to delete.
  445. func (s *Session) GuildBanCreate(guildID, userID string, days int) (err error) {
  446. uri := GUILD_BAN(guildID, userID)
  447. if days > 0 {
  448. uri = fmt.Sprintf("%s?delete-message-days=%d", uri, days)
  449. }
  450. _, err = s.Request("PUT", uri, nil)
  451. return
  452. }
  453. // GuildBanDelete removes the given user from the guild bans
  454. // guildID : The ID of a Guild.
  455. // userID : The ID of a User
  456. func (s *Session) GuildBanDelete(guildID, userID string) (err error) {
  457. _, err = s.Request("DELETE", GUILD_BAN(guildID, userID), nil)
  458. return
  459. }
  460. // GuildMembers returns a list of members for a guild.
  461. // guildID : The ID of a Guild.
  462. // offset : A number of members to skip
  463. // limit : max number of members to return (max 1000)
  464. func (s *Session) GuildMembers(guildID string, offset, limit int) (st []*Member, err error) {
  465. uri := GUILD_MEMBERS(guildID)
  466. v := url.Values{}
  467. if offset > 0 {
  468. v.Set("offset", strconv.Itoa(offset))
  469. }
  470. if limit > 0 {
  471. v.Set("limit", strconv.Itoa(limit))
  472. }
  473. if len(v) > 0 {
  474. uri = fmt.Sprintf("%s?%s", uri, v.Encode())
  475. }
  476. body, err := s.Request("GET", uri, nil)
  477. if err != nil {
  478. return
  479. }
  480. err = unmarshal(body, &st)
  481. return
  482. }
  483. // GuildMember returns a member of a guild.
  484. // guildID : The ID of a Guild.
  485. // userID : The ID of a User
  486. func (s *Session) GuildMember(guildID, userID string) (st *Member, err error) {
  487. body, err := s.Request("GET", GUILD_MEMBER(guildID, userID), nil)
  488. if err != nil {
  489. return
  490. }
  491. err = unmarshal(body, &st)
  492. return
  493. }
  494. // GuildMemberDelete removes the given user from the given guild.
  495. // guildID : The ID of a Guild.
  496. // userID : The ID of a User
  497. func (s *Session) GuildMemberDelete(guildID, userID string) (err error) {
  498. _, err = s.Request("DELETE", GUILD_MEMBER(guildID, userID), nil)
  499. return
  500. }
  501. // GuildMemberEdit edits the roles of a member.
  502. // guildID : The ID of a Guild.
  503. // userID : The ID of a User.
  504. // roles : A list of role ID's to set on the member.
  505. func (s *Session) GuildMemberEdit(guildID, userID string, roles []string) (err error) {
  506. data := struct {
  507. Roles []string `json:"roles"`
  508. }{roles}
  509. _, err = s.Request("PATCH", GUILD_MEMBER(guildID, userID), data)
  510. if err != nil {
  511. return
  512. }
  513. return
  514. }
  515. // GuildMemberMove moves a guild member from one voice channel to another/none
  516. // guildID : The ID of a Guild.
  517. // userID : The ID of a User.
  518. // channelID : The ID of a channel to move user to, or null?
  519. // NOTE : I am not entirely set on the name of this function and it may change
  520. // prior to the final 1.0.0 release of Discordgo
  521. func (s *Session) GuildMemberMove(guildID, userID, channelID string) (err error) {
  522. data := struct {
  523. ChannelID string `json:"channel_id"`
  524. }{channelID}
  525. _, err = s.Request("PATCH", GUILD_MEMBER(guildID, userID), data)
  526. if err != nil {
  527. return
  528. }
  529. return
  530. }
  531. // GuildChannels returns an array of Channel structures for all channels of a
  532. // given guild.
  533. // guildID : The ID of a Guild.
  534. func (s *Session) GuildChannels(guildID string) (st []*Channel, err error) {
  535. body, err := s.Request("GET", GUILD_CHANNELS(guildID), nil)
  536. if err != nil {
  537. return
  538. }
  539. err = unmarshal(body, &st)
  540. return
  541. }
  542. // GuildChannelCreate creates a new channel in the given guild
  543. // guildID : The ID of a Guild.
  544. // name : Name of the channel (2-100 chars length)
  545. // ctype : Tpye of the channel (voice or text)
  546. func (s *Session) GuildChannelCreate(guildID, name, ctype string) (st *Channel, err error) {
  547. data := struct {
  548. Name string `json:"name"`
  549. Type string `json:"type"`
  550. }{name, ctype}
  551. body, err := s.Request("POST", GUILD_CHANNELS(guildID), data)
  552. if err != nil {
  553. return
  554. }
  555. err = unmarshal(body, &st)
  556. return
  557. }
  558. // GuildInvites returns an array of Invite structures for the given guild
  559. // guildID : The ID of a Guild.
  560. func (s *Session) GuildInvites(guildID string) (st []*Invite, err error) {
  561. body, err := s.Request("GET", GUILD_INVITES(guildID), nil)
  562. if err != nil {
  563. return
  564. }
  565. err = unmarshal(body, &st)
  566. return
  567. }
  568. // GuildRoles returns all roles for a given guild.
  569. // guildID : The ID of a Guild.
  570. func (s *Session) GuildRoles(guildID string) (st []*Role, err error) {
  571. body, err := s.Request("GET", GUILD_ROLES(guildID), nil)
  572. if err != nil {
  573. return
  574. }
  575. err = unmarshal(body, &st)
  576. return // TODO return pointer
  577. }
  578. // GuildRoleCreate returns a new Guild Role.
  579. // guildID: The ID of a Guild.
  580. func (s *Session) GuildRoleCreate(guildID string) (st *Role, err error) {
  581. body, err := s.Request("POST", GUILD_ROLES(guildID), nil)
  582. if err != nil {
  583. return
  584. }
  585. err = unmarshal(body, &st)
  586. return
  587. }
  588. // GuildRoleEdit updates an existing Guild Role with new values
  589. // guildID : The ID of a Guild.
  590. // roleID : The ID of a Role.
  591. // name : The name of the Role.
  592. // color : The color of the role (decimal, not hex).
  593. // hoist : Whether to display the role's users separately.
  594. // perm : The permissions for the role.
  595. func (s *Session) GuildRoleEdit(guildID, roleID, name string, color int, hoist bool, perm int) (st *Role, err error) {
  596. // Prevent sending a color int that is too big.
  597. if color > 0xFFFFFF {
  598. err = fmt.Errorf("color value cannot be larger than 0xFFFFFF")
  599. }
  600. data := struct {
  601. Name string `json:"name"` // The color the role should have (as a decimal, not hex)
  602. Color int `json:"color"` // Whether to display the role's users separately
  603. Hoist bool `json:"hoist"` // The role's name (overwrites existing)
  604. Permissions int `json:"permissions"` // The overall permissions number of the role (overwrites existing)
  605. }{name, color, hoist, perm}
  606. body, err := s.Request("PATCH", GUILD_ROLE(guildID, roleID), data)
  607. if err != nil {
  608. return
  609. }
  610. err = unmarshal(body, &st)
  611. return
  612. }
  613. // GuildRoleReorder reoders guild roles
  614. // guildID : The ID of a Guild.
  615. // roles : A list of ordered roles.
  616. func (s *Session) GuildRoleReorder(guildID string, roles []*Role) (st []*Role, err error) {
  617. body, err := s.Request("PATCH", GUILD_ROLES(guildID), roles)
  618. if err != nil {
  619. return
  620. }
  621. err = unmarshal(body, &st)
  622. return
  623. }
  624. // GuildRoleDelete deletes an existing role.
  625. // guildID : The ID of a Guild.
  626. // roleID : The ID of a Role.
  627. func (s *Session) GuildRoleDelete(guildID, roleID string) (err error) {
  628. _, err = s.Request("DELETE", GUILD_ROLE(guildID, roleID), nil)
  629. return
  630. }
  631. // GuildIntegrations returns an array of Integrations for a guild.
  632. // guildID : The ID of a Guild.
  633. func (s *Session) GuildIntegrations(guildID string) (st []*GuildIntegration, err error) {
  634. body, err := s.Request("GET", GUILD_INTEGRATIONS(guildID), nil)
  635. if err != nil {
  636. return
  637. }
  638. err = unmarshal(body, &st)
  639. return
  640. }
  641. // GuildIntegrationCreate creates a Guild Integration.
  642. // guildID : The ID of a Guild.
  643. // integrationType : The Integration type.
  644. // integrationID : The ID of an integration.
  645. func (s *Session) GuildIntegrationCreate(guildID, integrationType, integrationID string) (err error) {
  646. data := struct {
  647. Type string `json:"type"`
  648. Id string `json:"id"`
  649. }{integrationType, integrationID}
  650. _, err = s.Request("POST", GUILD_INTEGRATIONS(guildID), data)
  651. return
  652. }
  653. // GuildIntegrationEdit edits a Guild Integration.
  654. // guildID : The ID of a Guild.
  655. // integrationType : The Integration type.
  656. // integrationID : The ID of an integration.
  657. // expireBehavior : The behavior when an integration subscription lapses (see the integration object documentation).
  658. // expireGracePeriod : Period (in seconds) where the integration will ignore lapsed subscriptions.
  659. // enableEmoticons : Whether emoticons should be synced for this integration (twitch only currently).
  660. func (s *Session) GuildIntegrationEdit(guildID, integrationID string, expireBehavior, expireGracePeriod int, enableEmoticons bool) (err error) {
  661. data := struct {
  662. ExpireBehavior int `json:"expire_behavior"`
  663. ExpireGracePeriod int `json:"expire_grace_period"`
  664. EnableEmoticons bool `json:"enable_emoticons"`
  665. }{expireBehavior, expireGracePeriod, enableEmoticons}
  666. _, err = s.Request("PATCH", GUILD_INTEGRATION(guildID, integrationID), data)
  667. return
  668. }
  669. // GuildIntegrationDelete removes the given integration from the Guild.
  670. // guildID : The ID of a Guild.
  671. // integrationID : The ID of an integration.
  672. func (s *Session) GuildIntegrationDelete(guildID, integrationID string) (err error) {
  673. _, err = s.Request("DELETE", GUILD_INTEGRATION(guildID, integrationID), nil)
  674. return
  675. }
  676. // GuildIntegrationSync syncs an integration.
  677. // guildID : The ID of a Guild.
  678. // integrationID : The ID of an integration.
  679. func (s *Session) GuildIntegrationSync(guildID, integrationID string) (err error) {
  680. _, err = s.Request("POST", GUILD_INTEGRATION_SYNC(guildID, integrationID), nil)
  681. return
  682. }
  683. // GuildIcon returns an image.Image of a guild icon.
  684. // guildID : The ID of a Guild.
  685. func (s *Session) GuildIcon(guildID string) (img image.Image, err error) {
  686. g, err := s.Guild(guildID)
  687. if err != nil {
  688. return
  689. }
  690. if g.Icon == "" {
  691. err = errors.New("Guild does not have an icon set.")
  692. return
  693. }
  694. body, err := s.Request("GET", GUILD_ICON(guildID, g.Icon), nil)
  695. if err != nil {
  696. return
  697. }
  698. img, _, err = image.Decode(bytes.NewReader(body))
  699. return
  700. }
  701. // GuildSplash returns an image.Image of a guild splash image.
  702. // guildID : The ID of a Guild.
  703. func (s *Session) GuildSplash(guildID string) (img image.Image, err error) {
  704. g, err := s.Guild(guildID)
  705. if err != nil {
  706. return
  707. }
  708. if g.Splash == "" {
  709. err = errors.New("Guild does not have a splash set.")
  710. return
  711. }
  712. body, err := s.Request("GET", GUILD_SPLASH(guildID, g.Splash), nil)
  713. if err != nil {
  714. return
  715. }
  716. img, _, err = image.Decode(bytes.NewReader(body))
  717. return
  718. }
  719. // GuildEmbed returns the embed for a Guild.
  720. // guildID : The ID of a Guild.
  721. func (s *Session) GuildEmbed(guildID string) (st *GuildEmbed, err error) {
  722. body, err := s.Request("GET", GUILD_EMBED(guildID), nil)
  723. if err != nil {
  724. return
  725. }
  726. err = unmarshal(body, &st)
  727. return
  728. }
  729. // GuildEmbedEdit returns the embed for a Guild.
  730. // guildID : The ID of a Guild.
  731. func (s *Session) GuildEmbedEdit(guildID string, enabled bool, channelID string) (err error) {
  732. data := GuildEmbed{enabled, channelID}
  733. _, err = s.Request("PATCH", GUILD_EMBED(guildID), data)
  734. return
  735. }
  736. // ------------------------------------------------------------------------------------------------
  737. // Functions specific to Discord Channels
  738. // ------------------------------------------------------------------------------------------------
  739. // Channel returns a Channel strucutre of a specific Channel.
  740. // channelID : The ID of the Channel you want returned.
  741. func (s *Session) Channel(channelID string) (st *Channel, err error) {
  742. body, err := s.Request("GET", CHANNEL(channelID), nil)
  743. if err != nil {
  744. return
  745. }
  746. err = unmarshal(body, &st)
  747. return
  748. }
  749. // ChannelEdit edits the given channel
  750. // channelID : The ID of a Channel
  751. // name : The new name to assign the channel.
  752. func (s *Session) ChannelEdit(channelID, name string) (st *Channel, err error) {
  753. data := struct {
  754. Name string `json:"name"`
  755. }{name}
  756. body, err := s.Request("PATCH", CHANNEL(channelID), data)
  757. if err != nil {
  758. return
  759. }
  760. err = unmarshal(body, &st)
  761. return
  762. }
  763. // ChannelDelete deletes the given channel
  764. // channelID : The ID of a Channel
  765. func (s *Session) ChannelDelete(channelID string) (st *Channel, err error) {
  766. body, err := s.Request("DELETE", CHANNEL(channelID), nil)
  767. if err != nil {
  768. return
  769. }
  770. err = unmarshal(body, &st)
  771. return
  772. }
  773. // ChannelTyping broadcasts to all members that authenticated user is typing in
  774. // the given channel.
  775. // channelID : The ID of a Channel
  776. func (s *Session) ChannelTyping(channelID string) (err error) {
  777. _, err = s.Request("POST", CHANNEL_TYPING(channelID), nil)
  778. return
  779. }
  780. // ChannelMessages returns an array of Message structures for messages within
  781. // a given channel.
  782. // channelID : The ID of a Channel.
  783. // limit : The number messages that can be returned. (max 100)
  784. // beforeID : If provided all messages returned will be before given ID.
  785. // afterID : If provided all messages returned will be after given ID.
  786. func (s *Session) ChannelMessages(channelID string, limit int, beforeID, afterID string) (st []*Message, err error) {
  787. uri := CHANNEL_MESSAGES(channelID)
  788. v := url.Values{}
  789. if limit > 0 {
  790. v.Set("limit", strconv.Itoa(limit))
  791. }
  792. if afterID != "" {
  793. v.Set("after", afterID)
  794. }
  795. if beforeID != "" {
  796. v.Set("before", beforeID)
  797. }
  798. if len(v) > 0 {
  799. uri = fmt.Sprintf("%s?%s", uri, v.Encode())
  800. }
  801. body, err := s.Request("GET", uri, nil)
  802. if err != nil {
  803. return
  804. }
  805. err = unmarshal(body, &st)
  806. return
  807. }
  808. // ChannelMessageAck acknowledges and marks the given message as read
  809. // channeld : The ID of a Channel
  810. // messageID : the ID of a Message
  811. func (s *Session) ChannelMessageAck(channelID, messageID string) (err error) {
  812. _, err = s.request("POST", CHANNEL_MESSAGE_ACK(channelID, messageID), "", nil)
  813. return
  814. }
  815. // channelMessageSend sends a message to the given channel.
  816. // channelID : The ID of a Channel.
  817. // content : The message to send.
  818. // tts : Whether to send the message with TTS.
  819. func (s *Session) channelMessageSend(channelID, content string, tts bool) (st *Message, err error) {
  820. // TODO: nonce string ?
  821. data := struct {
  822. Content string `json:"content"`
  823. TTS bool `json:"tts"`
  824. }{content, tts}
  825. // Send the message to the given channel
  826. response, err := s.Request("POST", CHANNEL_MESSAGES(channelID), data)
  827. if err != nil {
  828. return
  829. }
  830. err = unmarshal(response, &st)
  831. return
  832. }
  833. // ChannelMessageSend sends a message to the given channel.
  834. // channelID : The ID of a Channel.
  835. // content : The message to send.
  836. func (s *Session) ChannelMessageSend(channelID string, content string) (st *Message, err error) {
  837. return s.channelMessageSend(channelID, content, false)
  838. }
  839. // ChannelMessageSendTTS sends a message to the given channel with Text to Speech.
  840. // channelID : The ID of a Channel.
  841. // content : The message to send.
  842. func (s *Session) ChannelMessageSendTTS(channelID string, content string) (st *Message, err error) {
  843. return s.channelMessageSend(channelID, content, true)
  844. }
  845. // ChannelMessageEdit edits an existing message, replacing it entirely with
  846. // the given content.
  847. // channeld : The ID of a Channel
  848. // messageID : the ID of a Message
  849. func (s *Session) ChannelMessageEdit(channelID, messageID, content string) (st *Message, err error) {
  850. data := struct {
  851. Content string `json:"content"`
  852. }{content}
  853. response, err := s.Request("PATCH", CHANNEL_MESSAGE(channelID, messageID), data)
  854. if err != nil {
  855. return
  856. }
  857. err = unmarshal(response, &st)
  858. return
  859. }
  860. // ChannelMessageDelete deletes a message from the Channel.
  861. func (s *Session) ChannelMessageDelete(channelID, messageID string) (err error) {
  862. _, err = s.Request("DELETE", CHANNEL_MESSAGE(channelID, messageID), nil)
  863. return
  864. }
  865. // ChannelFileSend sends a file to the given channel.
  866. // channelID : The ID of a Channel.
  867. // io.Reader : A reader for the file contents.
  868. func (s *Session) ChannelFileSend(channelID, name string, r io.Reader) (st *Message, err error) {
  869. body := &bytes.Buffer{}
  870. bodywriter := multipart.NewWriter(body)
  871. writer, err := bodywriter.CreateFormFile("file", name)
  872. if err != nil {
  873. return nil, err
  874. }
  875. _, err = io.Copy(writer, r)
  876. if err != nil {
  877. return
  878. }
  879. err = bodywriter.Close()
  880. if err != nil {
  881. return
  882. }
  883. response, err := s.request("POST", CHANNEL_MESSAGES(channelID), bodywriter.FormDataContentType(), body.Bytes())
  884. if err != nil {
  885. return
  886. }
  887. err = unmarshal(response, &st)
  888. return
  889. }
  890. // ChannelInvites returns an array of Invite structures for the given channel
  891. // channelID : The ID of a Channel
  892. func (s *Session) ChannelInvites(channelID string) (st []*Invite, err error) {
  893. body, err := s.Request("GET", CHANNEL_INVITES(channelID), nil)
  894. if err != nil {
  895. return
  896. }
  897. err = unmarshal(body, &st)
  898. return
  899. }
  900. // ChannelInviteCreate creates a new invite for the given channel.
  901. // channelID : The ID of a Channel
  902. // i : An Invite struct with the values MaxAge, MaxUses, Temporary,
  903. // and XkcdPass defined.
  904. func (s *Session) ChannelInviteCreate(channelID string, i Invite) (st *Invite, err error) {
  905. data := struct {
  906. MaxAge int `json:"max_age"`
  907. MaxUses int `json:"max_uses"`
  908. Temporary bool `json:"temporary"`
  909. XKCDPass string `json:"xkcdpass"`
  910. }{i.MaxAge, i.MaxUses, i.Temporary, i.XkcdPass}
  911. body, err := s.Request("POST", CHANNEL_INVITES(channelID), data)
  912. if err != nil {
  913. return
  914. }
  915. err = unmarshal(body, &st)
  916. return
  917. }
  918. // ChannelPermissionSet creates a Permission Override for the given channel.
  919. // NOTE: This func name may changed. Using Set instead of Create because
  920. // you can both create a new override or update an override with this function.
  921. func (s *Session) ChannelPermissionSet(channelID, targetID, targetType string, allow, deny int) (err error) {
  922. data := struct {
  923. ID string `json:"id"`
  924. Type string `json:"type"`
  925. Allow int `json:"allow"`
  926. Deny int `json:"deny"`
  927. }{targetID, targetType, allow, deny}
  928. _, err = s.Request("PUT", CHANNEL_PERMISSION(channelID, targetID), data)
  929. return
  930. }
  931. // ChannelPermissionDelete deletes a specific permission override for the given channel.
  932. // NOTE: Name of this func may change.
  933. func (s *Session) ChannelPermissionDelete(channelID, targetID string) (err error) {
  934. _, err = s.Request("DELETE", CHANNEL_PERMISSION(channelID, targetID), nil)
  935. return
  936. }
  937. // ------------------------------------------------------------------------------------------------
  938. // Functions specific to Discord Invites
  939. // ------------------------------------------------------------------------------------------------
  940. // Invite returns an Invite structure of the given invite
  941. // inviteID : The invite code (or maybe xkcdpass?)
  942. func (s *Session) Invite(inviteID string) (st *Invite, err error) {
  943. body, err := s.Request("GET", INVITE(inviteID), nil)
  944. if err != nil {
  945. return
  946. }
  947. err = unmarshal(body, &st)
  948. return
  949. }
  950. // InviteDelete deletes an existing invite
  951. // inviteID : the code (or maybe xkcdpass?) of an invite
  952. func (s *Session) InviteDelete(inviteID string) (st *Invite, err error) {
  953. body, err := s.Request("DELETE", INVITE(inviteID), nil)
  954. if err != nil {
  955. return
  956. }
  957. err = unmarshal(body, &st)
  958. return
  959. }
  960. // InviteAccept accepts an Invite to a Guild or Channel
  961. // inviteID : The invite code (or maybe xkcdpass?)
  962. func (s *Session) InviteAccept(inviteID string) (st *Invite, err error) {
  963. body, err := s.Request("POST", INVITE(inviteID), nil)
  964. if err != nil {
  965. return
  966. }
  967. err = unmarshal(body, &st)
  968. return
  969. }
  970. // ------------------------------------------------------------------------------------------------
  971. // Functions specific to Discord Voice
  972. // ------------------------------------------------------------------------------------------------
  973. // VoiceRegions returns the voice server regions
  974. func (s *Session) VoiceRegions() (st []*VoiceRegion, err error) {
  975. body, err := s.Request("GET", VOICE_REGIONS, nil)
  976. if err != nil {
  977. return
  978. }
  979. err = unmarshal(body, &st)
  980. return
  981. }
  982. // VoiceICE returns the voice server ICE information
  983. func (s *Session) VoiceICE() (st *VoiceICE, err error) {
  984. body, err := s.Request("GET", VOICE_ICE, nil)
  985. if err != nil {
  986. return
  987. }
  988. err = unmarshal(body, &st)
  989. return
  990. }
  991. // ------------------------------------------------------------------------------------------------
  992. // Functions specific to Discord Websockets
  993. // ------------------------------------------------------------------------------------------------
  994. // Gateway returns the a websocket Gateway address
  995. func (s *Session) Gateway() (gateway string, err error) {
  996. response, err := s.Request("GET", GATEWAY, nil)
  997. if err != nil {
  998. return
  999. }
  1000. temp := struct {
  1001. URL string `json:"url"`
  1002. }{}
  1003. err = unmarshal(response, &temp)
  1004. if err != nil {
  1005. return
  1006. }
  1007. gateway = temp.URL
  1008. return
  1009. }