mirror of
https://github.com/superseriousbusiness/gotosocial
synced 2024-12-21 10:13:11 +00:00
d10388cc28
* [feature] support Sec-Websocket-Protocol in streaming API * Fix lint problem * Update based on reviews
69 lines
2.2 KiB
Go
69 lines
2.2 KiB
Go
/*
|
|
GoToSocial
|
|
Copyright (C) 2021-2022 GoToSocial Authors admin@gotosocial.org
|
|
|
|
This program is free software: you can redistribute it and/or modify
|
|
it under the terms of the GNU Affero General Public License as published by
|
|
the Free Software Foundation, either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU Affero General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Affero General Public License
|
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
package streaming
|
|
|
|
import (
|
|
"net/http"
|
|
"time"
|
|
|
|
"github.com/superseriousbusiness/gotosocial/internal/api"
|
|
"github.com/superseriousbusiness/gotosocial/internal/processing"
|
|
"github.com/superseriousbusiness/gotosocial/internal/router"
|
|
)
|
|
|
|
const (
|
|
// BasePath is the path for the streaming api
|
|
BasePath = "/api/v1/streaming"
|
|
|
|
// StreamQueryKey is the query key for the type of stream being requested
|
|
StreamQueryKey = "stream"
|
|
|
|
// AccessTokenQueryKey is the query key for an oauth access token that should be passed in streaming requests.
|
|
AccessTokenQueryKey = "access_token"
|
|
// AccessTokenHeader is the header for an oauth access token that can be passed in streaming requests instead of AccessTokenQueryKey
|
|
//nolint:gosec
|
|
AccessTokenHeader = "Sec-Websocket-Protocol"
|
|
)
|
|
|
|
// Module implements the api.ClientModule interface for everything related to streaming
|
|
type Module struct {
|
|
processor processing.Processor
|
|
tickDuration time.Duration
|
|
}
|
|
|
|
// New returns a new streaming module
|
|
func New(processor processing.Processor) api.ClientModule {
|
|
return &Module{
|
|
processor: processor,
|
|
tickDuration: 30 * time.Second,
|
|
}
|
|
}
|
|
|
|
func NewWithTickDuration(processor processing.Processor, tickDuration time.Duration) api.ClientModule {
|
|
return &Module{
|
|
processor: processor,
|
|
tickDuration: tickDuration,
|
|
}
|
|
}
|
|
|
|
// Route attaches all routes from this module to the given router
|
|
func (m *Module) Route(r router.Router) error {
|
|
r.AttachHandler(http.MethodGet, BasePath, m.StreamGETHandler)
|
|
return nil
|
|
}
|