mirror of
https://github.com/diamondburned/arikawa.git
synced 2024-09-12 05:06:28 +00:00
165 lines
3.9 KiB
Go
165 lines
3.9 KiB
Go
// Package session abstracts around the REST API and the Gateway, managing both
|
|
// at once. It offers a handler interface similar to that in discordgo for
|
|
// Gateway events.
|
|
package session
|
|
|
|
import (
|
|
"context"
|
|
"sync"
|
|
|
|
"github.com/pkg/errors"
|
|
|
|
"github.com/diamondburned/arikawa/v2/api"
|
|
"github.com/diamondburned/arikawa/v2/gateway"
|
|
"github.com/diamondburned/arikawa/v2/utils/handler"
|
|
)
|
|
|
|
var ErrMFA = errors.New("account has 2FA enabled")
|
|
|
|
// Closed is an event that's sent to Session's command handler. This works by
|
|
// using (*Gateway).AfterClose. If the user sets this callback, no Closed events
|
|
// would be sent.
|
|
//
|
|
// Usage
|
|
//
|
|
// ses.AddHandler(func(*session.Closed) {})
|
|
//
|
|
type Closed struct {
|
|
Error error
|
|
}
|
|
|
|
// Session manages both the API and Gateway. As such, Session inherits all of
|
|
// API's methods, as well has the Handler used for Gateway.
|
|
type Session struct {
|
|
*api.Client
|
|
Gateway *gateway.Gateway
|
|
|
|
// Command handler with inherited methods.
|
|
*handler.Handler
|
|
|
|
// internal state to not be copied around.
|
|
*sessionState
|
|
}
|
|
|
|
// sessionState contains fields crucial for controlling the state of session. It
|
|
// should not be copied around.
|
|
type sessionState struct {
|
|
hstop chan struct{}
|
|
wstop sync.Once
|
|
}
|
|
|
|
func (state *sessionState) Reset() {
|
|
state.hstop = make(chan struct{})
|
|
state.wstop = sync.Once{}
|
|
}
|
|
|
|
func NewWithIntents(token string, intents ...gateway.Intents) (*Session, error) {
|
|
g, err := gateway.NewGatewayWithIntents(token, intents...)
|
|
if err != nil {
|
|
return nil, errors.Wrap(err, "failed to connect to Gateway")
|
|
}
|
|
|
|
return NewWithGateway(g), nil
|
|
}
|
|
|
|
// New creates a new session from a given token. Most bots should be using
|
|
// NewWithIntents instead.
|
|
func New(token string) (*Session, error) {
|
|
// Create a gateway
|
|
g, err := gateway.NewGateway(token)
|
|
if err != nil {
|
|
return nil, errors.Wrap(err, "failed to connect to Gateway")
|
|
}
|
|
|
|
return NewWithGateway(g), nil
|
|
}
|
|
|
|
// Login tries to log in as a normal user account; MFA is optional.
|
|
func Login(email, password, mfa string) (*Session, error) {
|
|
// Make a scratch HTTP client without a token
|
|
client := api.NewClient("")
|
|
|
|
// Try to login without TOTP
|
|
l, err := client.Login(email, password)
|
|
if err != nil {
|
|
return nil, errors.Wrap(err, "failed to login")
|
|
}
|
|
|
|
if l.Token != "" && !l.MFA {
|
|
// We got the token, return with a new Session.
|
|
return New(l.Token)
|
|
}
|
|
|
|
// Discord requests MFA, so we need the MFA token.
|
|
if mfa == "" {
|
|
return nil, ErrMFA
|
|
}
|
|
|
|
// Retry logging in with a 2FA token
|
|
l, err = client.TOTP(mfa, l.Ticket)
|
|
if err != nil {
|
|
return nil, errors.Wrap(err, "failed to login with 2FA")
|
|
}
|
|
|
|
return New(l.Token)
|
|
}
|
|
|
|
func NewWithGateway(gw *gateway.Gateway) *Session {
|
|
return &Session{
|
|
Gateway: gw,
|
|
// Nab off gateway's token
|
|
Client: api.NewClient(gw.Identifier.Token),
|
|
Handler: handler.New(),
|
|
sessionState: &sessionState{},
|
|
}
|
|
}
|
|
|
|
func (s *Session) Open() error {
|
|
// Start the handler beforehand so no events are missed.
|
|
s.sessionState.Reset()
|
|
go s.startHandler()
|
|
|
|
// Set the AfterClose's handler.
|
|
s.Gateway.AfterClose = func(err error) {
|
|
s.Handler.Call(&Closed{
|
|
Error: err,
|
|
})
|
|
}
|
|
|
|
if err := s.Gateway.Open(); err != nil {
|
|
return errors.Wrap(err, "failed to start gateway")
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// WithContext returns a shallow copy of Session with the context replaced in
|
|
// the API client. All methods called on the returned Session will use this
|
|
// given context.
|
|
//
|
|
// This method is thread-safe only after Open and before Close are called. Open
|
|
// and Close should not be called on the returned Session.
|
|
func (s *Session) WithContext(ctx context.Context) *Session {
|
|
cpy := *s
|
|
cpy.Client = s.Client.WithContext(ctx)
|
|
return &cpy
|
|
}
|
|
|
|
func (s *Session) startHandler() {
|
|
for {
|
|
select {
|
|
case <-s.hstop:
|
|
return
|
|
case ev := <-s.Gateway.Events:
|
|
s.Call(ev)
|
|
}
|
|
}
|
|
}
|
|
|
|
func (s *Session) Close() error {
|
|
// Stop the event handler
|
|
s.wstop.Do(func() { close(s.hstop) })
|
|
// Close the websocket
|
|
return s.Gateway.Close()
|
|
}
|