2021-11-08 19:17:07 +00:00
|
|
|
package twitch
|
|
|
|
|
|
|
|
import (
|
|
|
|
"bytes"
|
|
|
|
"context"
|
|
|
|
"encoding/json"
|
|
|
|
"fmt"
|
|
|
|
"net/http"
|
2022-10-25 16:47:30 +00:00
|
|
|
"net/url"
|
2021-11-08 19:17:07 +00:00
|
|
|
"strings"
|
|
|
|
"time"
|
|
|
|
|
|
|
|
"github.com/mitchellh/hashstructure/v2"
|
|
|
|
"github.com/pkg/errors"
|
|
|
|
log "github.com/sirupsen/logrus"
|
|
|
|
)
|
|
|
|
|
|
|
|
const (
|
2023-10-21 14:43:44 +00:00
|
|
|
EventSubEventTypeChannelAdBreakBegin = "channel.ad_break.begin"
|
2023-02-11 22:00:15 +00:00
|
|
|
EventSubEventTypeChannelFollow = "channel.follow"
|
2021-12-24 23:47:40 +00:00
|
|
|
EventSubEventTypeChannelPointCustomRewardRedemptionAdd = "channel.channel_points_custom_reward_redemption.add"
|
2023-02-11 22:00:15 +00:00
|
|
|
EventSubEventTypeChannelRaid = "channel.raid"
|
2023-03-21 09:51:34 +00:00
|
|
|
EventSubEventTypeChannelShoutoutCreate = "channel.shoutout.create"
|
2023-02-11 22:00:15 +00:00
|
|
|
EventSubEventTypeChannelShoutoutReceive = "channel.shoutout.receive"
|
|
|
|
EventSubEventTypeChannelUpdate = "channel.update"
|
2023-05-21 12:59:06 +00:00
|
|
|
EventSubEventTypeChannelPollBegin = "channel.poll.begin"
|
|
|
|
EventSubEventTypeChannelPollEnd = "channel.poll.end"
|
|
|
|
EventSubEventTypeChannelPollProgress = "channel.poll.progress"
|
2023-02-11 22:00:15 +00:00
|
|
|
EventSubEventTypeStreamOffline = "stream.offline"
|
|
|
|
EventSubEventTypeStreamOnline = "stream.online"
|
|
|
|
EventSubEventTypeUserAuthorizationRevoke = "user.authorization.revoke"
|
2023-02-04 11:25:46 +00:00
|
|
|
|
|
|
|
EventSubTopicVersion1 = "1"
|
|
|
|
EventSubTopicVersion2 = "2"
|
|
|
|
EventSubTopicVersionBeta = "beta"
|
2021-11-08 19:17:07 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
type (
|
|
|
|
EventSubCondition struct {
|
|
|
|
BroadcasterUserID string `json:"broadcaster_user_id,omitempty"`
|
|
|
|
CampaignID string `json:"campaign_id,omitempty"`
|
|
|
|
CategoryID string `json:"category_id,omitempty"`
|
|
|
|
ClientID string `json:"client_id,omitempty"`
|
|
|
|
ExtensionClientID string `json:"extension_client_id,omitempty"`
|
|
|
|
FromBroadcasterUserID string `json:"from_broadcaster_user_id,omitempty"`
|
|
|
|
OrganizationID string `json:"organization_id,omitempty"`
|
|
|
|
RewardID string `json:"reward_id,omitempty"`
|
|
|
|
ToBroadcasterUserID string `json:"to_broadcaster_user_id,omitempty"`
|
|
|
|
UserID string `json:"user_id,omitempty"`
|
2023-02-11 22:00:15 +00:00
|
|
|
ModeratorUserID string `json:"moderator_user_id,omitempty"`
|
2021-11-08 19:17:07 +00:00
|
|
|
}
|
|
|
|
|
2023-10-21 14:43:44 +00:00
|
|
|
EventSubEventAdBreakBegin struct {
|
|
|
|
Duration int64 `json:"duration"`
|
|
|
|
Timestamp time.Time `json:"timestamp"`
|
|
|
|
IsAutomatic bool `json:"is_automatic"`
|
|
|
|
BroadcasterUserID string `json:"broadcaster_user_id"`
|
|
|
|
BroadcasterUserLogin string `json:"broadcaster_user_login"`
|
|
|
|
BroadcasterUserName string `json:"broadcaster_user_name"`
|
|
|
|
RequesterUserID string `json:"requester_user_id"`
|
|
|
|
}
|
|
|
|
|
2021-12-24 23:47:40 +00:00
|
|
|
EventSubEventChannelPointCustomRewardRedemptionAdd struct {
|
|
|
|
ID string `json:"id"`
|
|
|
|
BroadcasterUserID string `json:"broadcaster_user_id"`
|
|
|
|
BroadcasterUserLogin string `json:"broadcaster_user_login"`
|
|
|
|
BroadcasterUserName string `json:"broadcaster_user_name"`
|
|
|
|
UserID string `json:"user_id"`
|
|
|
|
UserLogin string `json:"user_login"`
|
|
|
|
UserName string `json:"user_name"`
|
|
|
|
UserInput string `json:"user_input"`
|
|
|
|
Status string `json:"status"`
|
|
|
|
Reward struct {
|
|
|
|
ID string `json:"id"`
|
|
|
|
Title string `json:"title"`
|
|
|
|
Cost int64 `json:"cost"`
|
|
|
|
Prompt string `json:"prompt"`
|
|
|
|
} `json:"reward"`
|
|
|
|
RedeemedAt time.Time `json:"redeemed_at"`
|
|
|
|
}
|
|
|
|
|
2021-11-08 19:17:07 +00:00
|
|
|
EventSubEventChannelUpdate struct {
|
2023-07-03 22:05:04 +00:00
|
|
|
BroadcasterUserID string `json:"broadcaster_user_id"`
|
|
|
|
BroadcasterUserLogin string `json:"broadcaster_user_login"`
|
|
|
|
BroadcasterUserName string `json:"broadcaster_user_name"`
|
|
|
|
Title string `json:"title"`
|
|
|
|
Language string `json:"language"`
|
|
|
|
CategoryID string `json:"category_id"`
|
|
|
|
CategoryName string `json:"category_name"`
|
|
|
|
ContentClassificationLabels []string `json:"content_classification_labels"`
|
2021-11-08 19:17:07 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
EventSubEventFollow struct {
|
|
|
|
UserID string `json:"user_id"`
|
|
|
|
UserLogin string `json:"user_login"`
|
|
|
|
UserName string `json:"user_name"`
|
|
|
|
BroadcasterUserID string `json:"broadcaster_user_id"`
|
|
|
|
BroadcasterUserLogin string `json:"broadcaster_user_login"`
|
|
|
|
BroadcasterUserName string `json:"broadcaster_user_name"`
|
|
|
|
FollowedAt time.Time `json:"followed_at"`
|
|
|
|
}
|
|
|
|
|
2023-05-21 12:59:06 +00:00
|
|
|
EventSubEventPoll struct {
|
|
|
|
ID string `json:"id"`
|
|
|
|
BroadcasterUserID string `json:"broadcaster_user_id"`
|
|
|
|
BroadcasterUserLogin string `json:"broadcaster_user_login"`
|
|
|
|
BroadcasterUserName string `json:"broadcaster_user_name"`
|
|
|
|
Title string `json:"title"`
|
|
|
|
Choices []struct {
|
|
|
|
ID string `json:"id"`
|
|
|
|
Title string `json:"title"`
|
|
|
|
ChannelPointsVotes int `json:"channel_points_votes"`
|
|
|
|
Votes int `json:"votes"`
|
|
|
|
} `json:"choices"`
|
|
|
|
ChannelPointsVoting struct {
|
|
|
|
IsEnabled bool `json:"is_enabled"`
|
|
|
|
AmountPerVote int `json:"amount_per_vote"`
|
|
|
|
} `json:"channel_points_voting"`
|
|
|
|
|
|
|
|
StartedAt time.Time `json:"started_at"` // begin, progress, end
|
|
|
|
EndsAt time.Time `json:"ends_at,omitempty"` // begin, progress
|
|
|
|
Status string `json:"status,omitempty"` // end -- enum(completed, archived, terminated)
|
|
|
|
EndedAt time.Time `json:"ended_at,omitempty"` // end
|
|
|
|
}
|
|
|
|
|
2022-10-29 13:16:30 +00:00
|
|
|
EventSubEventRaid struct {
|
|
|
|
FromBroadcasterUserID string `json:"from_broadcaster_user_id"`
|
|
|
|
FromBroadcasterUserLogin string `json:"from_broadcaster_user_login"`
|
|
|
|
FromBroadcasterUserName string `json:"from_broadcaster_user_name"`
|
|
|
|
ToBroadcasterUserID string `json:"to_broadcaster_user_id"`
|
|
|
|
ToBroadcasterUserLogin string `json:"to_broadcaster_user_login"`
|
|
|
|
ToBroadcasterUserName string `json:"to_broadcaster_user_name"`
|
|
|
|
Viewers int64 `json:"viewers"`
|
|
|
|
}
|
|
|
|
|
2023-03-21 09:51:34 +00:00
|
|
|
EventSubEventShoutoutCreated struct {
|
|
|
|
BroadcasterUserID string `json:"broadcaster_user_id"`
|
|
|
|
BroadcasterUserLogin string `json:"broadcaster_user_login"`
|
|
|
|
BroadcasterUserName string `json:"broadcaster_user_name"`
|
|
|
|
ModeratorUserID string `json:"moderator_user_id"`
|
|
|
|
ModeratorUserLogin string `json:"moderator_user_login"`
|
|
|
|
ModeratorUserName string `json:"moderator_user_name"`
|
|
|
|
ToBroadcasterUserID string `json:"to_broadcaster_user_id"`
|
|
|
|
ToBroadcasterUserLogin string `json:"to_broadcaster_user_login"`
|
|
|
|
ToBroadcasterUserName string `json:"to_broadcaster_user_name"`
|
|
|
|
ViewerCount int64 `json:"viewer_count"`
|
|
|
|
StartedAt time.Time `json:"started_at"`
|
|
|
|
CooldownEndsAt time.Time `json:"cooldown_ends_at"`
|
|
|
|
TargetCooldownEndsAt time.Time `json:"target_cooldown_ends_at"`
|
|
|
|
}
|
|
|
|
|
2023-02-11 22:00:15 +00:00
|
|
|
EventSubEventShoutoutReceived struct {
|
|
|
|
BroadcasterUserID string `json:"broadcaster_user_id"`
|
|
|
|
BroadcasterUserLogin string `json:"broadcaster_user_login"`
|
|
|
|
BroadcasterUserName string `json:"broadcaster_user_name"`
|
|
|
|
FromBroadcasterUserID string `json:"from_broadcaster_user_id"`
|
|
|
|
FromBroadcasterUserLogin string `json:"from_broadcaster_user_login"`
|
|
|
|
FromBroadcasterUserName string `json:"from_broadcaster_user_name"`
|
|
|
|
ViewerCount int64 `json:"viewer_count"`
|
|
|
|
StartedAt time.Time `json:"started_at"`
|
|
|
|
}
|
|
|
|
|
2021-11-08 19:17:07 +00:00
|
|
|
EventSubEventStreamOffline struct {
|
|
|
|
BroadcasterUserID string `json:"broadcaster_user_id"`
|
|
|
|
BroadcasterUserLogin string `json:"broadcaster_user_login"`
|
|
|
|
BroadcasterUserName string `json:"broadcaster_user_name"`
|
|
|
|
}
|
|
|
|
|
|
|
|
EventSubEventStreamOnline struct {
|
|
|
|
ID string `json:"id"`
|
|
|
|
BroadcasterUserID string `json:"broadcaster_user_id"`
|
|
|
|
BroadcasterUserLogin string `json:"broadcaster_user_login"`
|
|
|
|
BroadcasterUserName string `json:"broadcaster_user_name"`
|
|
|
|
Type string `json:"type"`
|
|
|
|
StartedAt time.Time `json:"started_at"`
|
|
|
|
}
|
|
|
|
|
2021-12-31 12:42:37 +00:00
|
|
|
EventSubEventUserAuthorizationRevoke struct {
|
|
|
|
ClientID string `json:"client_id"`
|
|
|
|
UserID string `json:"user_id"`
|
|
|
|
UserLogin string `json:"user_login"`
|
|
|
|
UserName string `json:"user_name"`
|
|
|
|
}
|
|
|
|
|
2021-11-08 19:17:07 +00:00
|
|
|
eventSubPostMessage struct {
|
|
|
|
Challenge string `json:"challenge"`
|
|
|
|
Subscription eventSubSubscription `json:"subscription"`
|
|
|
|
Event json.RawMessage `json:"event"`
|
|
|
|
}
|
|
|
|
|
|
|
|
eventSubSubscription struct {
|
|
|
|
ID string `json:"id,omitempty"` // READONLY
|
|
|
|
Status string `json:"status,omitempty"` // READONLY
|
|
|
|
Type string `json:"type"`
|
|
|
|
Version string `json:"version"`
|
|
|
|
Cost int64 `json:"cost,omitempty"` // READONLY
|
|
|
|
Condition EventSubCondition `json:"condition"`
|
|
|
|
Transport eventSubTransport `json:"transport"`
|
|
|
|
CreatedAt time.Time `json:"created_at,omitempty"` // READONLY
|
|
|
|
}
|
|
|
|
|
|
|
|
eventSubTransport struct {
|
2023-05-18 13:05:43 +00:00
|
|
|
Method string `json:"method"`
|
|
|
|
Callback string `json:"callback"`
|
|
|
|
Secret string `json:"secret"`
|
|
|
|
SessionID string `json:"session_id"`
|
2021-11-08 19:17:07 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
registeredSubscription struct {
|
|
|
|
Type string
|
|
|
|
Callbacks map[string]func(json.RawMessage) error
|
|
|
|
Subscription eventSubSubscription
|
|
|
|
}
|
|
|
|
)
|
|
|
|
|
|
|
|
func (e EventSubCondition) Hash() (string, error) {
|
|
|
|
h, err := hashstructure.Hash(e, hashstructure.FormatV2, &hashstructure.HashOptions{TagName: "json"})
|
|
|
|
if err != nil {
|
|
|
|
return "", errors.Wrap(err, "hashing struct")
|
|
|
|
}
|
|
|
|
|
|
|
|
return fmt.Sprintf("%x", h), nil
|
|
|
|
}
|
|
|
|
|
2023-05-18 13:05:43 +00:00
|
|
|
func (c *Client) createEventSubSubscriptionWebhook(ctx context.Context, sub eventSubSubscription) (*eventSubSubscription, error) {
|
2023-07-01 14:48:21 +00:00
|
|
|
return c.createEventSubSubscription(ctx, AuthTypeAppAccessToken, sub)
|
2021-11-08 19:17:07 +00:00
|
|
|
}
|
|
|
|
|
2023-05-18 13:05:43 +00:00
|
|
|
func (c *Client) createEventSubSubscriptionWebsocket(ctx context.Context, sub eventSubSubscription) (*eventSubSubscription, error) {
|
2023-07-01 14:48:21 +00:00
|
|
|
return c.createEventSubSubscription(ctx, AuthTypeBearerToken, sub)
|
2021-11-08 19:17:07 +00:00
|
|
|
}
|
|
|
|
|
2023-07-01 14:48:21 +00:00
|
|
|
func (c *Client) createEventSubSubscription(ctx context.Context, auth AuthType, sub eventSubSubscription) (*eventSubSubscription, error) {
|
2022-10-25 16:47:30 +00:00
|
|
|
var (
|
|
|
|
buf = new(bytes.Buffer)
|
|
|
|
resp struct {
|
|
|
|
Total int64 `json:"total"`
|
|
|
|
Data []eventSubSubscription `json:"data"`
|
|
|
|
Pagination struct {
|
|
|
|
Cursor string `json:"cursor"`
|
|
|
|
} `json:"pagination"`
|
|
|
|
}
|
|
|
|
)
|
|
|
|
|
|
|
|
if err := json.NewEncoder(buf).Encode(sub); err != nil {
|
|
|
|
return nil, errors.Wrap(err, "assemble subscribe payload")
|
|
|
|
}
|
|
|
|
|
2023-07-01 14:48:21 +00:00
|
|
|
if err := c.Request(ClientRequestOpts{
|
2023-05-18 13:05:43 +00:00
|
|
|
AuthType: auth,
|
2022-10-25 16:47:30 +00:00
|
|
|
Body: buf,
|
|
|
|
Context: ctx,
|
|
|
|
Method: http.MethodPost,
|
|
|
|
OKStatus: http.StatusAccepted,
|
|
|
|
Out: &resp,
|
|
|
|
URL: "https://api.twitch.tv/helix/eventsub/subscriptions",
|
|
|
|
}); err != nil {
|
|
|
|
return nil, errors.Wrap(err, "executing request")
|
|
|
|
}
|
|
|
|
|
|
|
|
return &resp.Data[0], nil
|
|
|
|
}
|
|
|
|
|
|
|
|
func (c *Client) deleteEventSubSubscription(ctx context.Context, id string) error {
|
2023-07-01 14:48:21 +00:00
|
|
|
return errors.Wrap(c.Request(ClientRequestOpts{
|
|
|
|
AuthType: AuthTypeAppAccessToken,
|
2022-10-25 16:47:30 +00:00
|
|
|
Context: ctx,
|
|
|
|
Method: http.MethodDelete,
|
|
|
|
OKStatus: http.StatusNoContent,
|
|
|
|
URL: fmt.Sprintf("https://api.twitch.tv/helix/eventsub/subscriptions?id=%s", id),
|
|
|
|
}), "executing request")
|
|
|
|
}
|
|
|
|
|
2021-12-31 12:42:37 +00:00
|
|
|
func (e *EventSubClient) fullAPIurl() string {
|
|
|
|
return strings.Join([]string{e.apiURL, e.secretHandle}, "/")
|
|
|
|
}
|
|
|
|
|
2022-10-25 16:47:30 +00:00
|
|
|
func (c *Client) getEventSubSubscriptions(ctx context.Context) ([]eventSubSubscription, error) {
|
|
|
|
var (
|
|
|
|
out []eventSubSubscription
|
|
|
|
params = make(url.Values)
|
|
|
|
resp struct {
|
|
|
|
Total int64 `json:"total"`
|
|
|
|
Data []eventSubSubscription `json:"data"`
|
|
|
|
Pagination struct {
|
|
|
|
Cursor string `json:"cursor"`
|
|
|
|
} `json:"pagination"`
|
|
|
|
}
|
|
|
|
)
|
|
|
|
|
|
|
|
for {
|
2023-07-01 14:48:21 +00:00
|
|
|
if err := c.Request(ClientRequestOpts{
|
|
|
|
AuthType: AuthTypeAppAccessToken,
|
2022-10-25 16:47:30 +00:00
|
|
|
Context: ctx,
|
|
|
|
Method: http.MethodGet,
|
|
|
|
OKStatus: http.StatusOK,
|
|
|
|
Out: &resp,
|
|
|
|
URL: fmt.Sprintf("https://api.twitch.tv/helix/eventsub/subscriptions?%s", params.Encode()),
|
|
|
|
}); err != nil {
|
|
|
|
return nil, errors.Wrap(err, "executing request")
|
|
|
|
}
|
|
|
|
|
|
|
|
out = append(out, resp.Data...)
|
|
|
|
|
|
|
|
if resp.Pagination.Cursor == "" {
|
|
|
|
break
|
|
|
|
}
|
|
|
|
|
|
|
|
params.Set("after", resp.Pagination.Cursor)
|
2022-12-24 16:28:51 +00:00
|
|
|
|
|
|
|
// Clear from struct as struct is reused
|
|
|
|
resp.Data = nil
|
|
|
|
resp.Pagination.Cursor = ""
|
2022-10-25 16:47:30 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
return out, nil
|
|
|
|
}
|
|
|
|
|
2021-11-08 19:17:07 +00:00
|
|
|
func (e *EventSubClient) unregisterCallback(cacheKey, cbKey string) {
|
|
|
|
e.subscriptionsLock.RLock()
|
|
|
|
regSub, ok := e.subscriptions[cacheKey]
|
|
|
|
e.subscriptionsLock.RUnlock()
|
|
|
|
|
|
|
|
if !ok {
|
|
|
|
// That subscription does not exist
|
|
|
|
log.WithField("cache_key", cacheKey).Debug("Subscription does not exist, not unregistering")
|
|
|
|
return
|
|
|
|
}
|
|
|
|
|
|
|
|
if _, ok = regSub.Callbacks[cbKey]; !ok {
|
|
|
|
// That callback does not exist
|
|
|
|
log.WithFields(log.Fields{
|
|
|
|
"cache_key": cacheKey,
|
|
|
|
"callback": cbKey,
|
|
|
|
}).Debug("Callback does not exist, not unregistering")
|
|
|
|
return
|
|
|
|
}
|
|
|
|
|
|
|
|
logger := log.WithField("event", regSub.Type)
|
|
|
|
|
|
|
|
delete(regSub.Callbacks, cbKey)
|
|
|
|
|
|
|
|
if len(regSub.Callbacks) > 0 {
|
|
|
|
// Still callbacks registered, not removing the subscription
|
|
|
|
return
|
|
|
|
}
|
|
|
|
|
|
|
|
ctx, cancel := context.WithTimeout(context.Background(), twitchRequestTimeout)
|
|
|
|
defer cancel()
|
|
|
|
|
2021-12-24 18:59:20 +00:00
|
|
|
if err := e.twitchClient.deleteEventSubSubscription(ctx, regSub.Subscription.ID); err != nil {
|
2021-11-08 19:17:07 +00:00
|
|
|
log.WithError(err).Error("Unable to execute delete subscription request")
|
|
|
|
return
|
|
|
|
}
|
|
|
|
|
|
|
|
e.subscriptionsLock.Lock()
|
|
|
|
defer e.subscriptionsLock.Unlock()
|
|
|
|
|
|
|
|
logger.Debug("Unregistered hook")
|
|
|
|
|
|
|
|
delete(e.subscriptions, cacheKey)
|
|
|
|
}
|