mirror of
https://github.com/superseriousbusiness/gotosocial.git
synced 2024-06-30 11:00:48 +00:00
5e2bf0bdca
* [chore] Remove years from all license headers Years or year ranges aren't required in license headers. Many projects have removed them in recent years and it avoids a bit of yearly toil. In many cases our copyright claim was also a bit dodgy since we added the 2021-2023 header to files created after 2021 but you can't claim copyright into the past that way. * [chore] Add license header check This ensures a license header is always added to any new file. This avoids maintainers/reviewers needing to remember to check for and ask for it in case a contribution doesn't include it. * [chore] Add missing license headers * [chore] Further updates to license header * Use the more common // indentend comment format * Remove the hack we had for the linter now that we use the // format * Add SPDX license identifier
66 lines
2.2 KiB
Go
66 lines
2.2 KiB
Go
// GoToSocial
|
|
// Copyright (C) GoToSocial Authors admin@gotosocial.org
|
|
// SPDX-License-Identifier: AGPL-3.0-or-later
|
|
//
|
|
// 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/gin-gonic/gin"
|
|
"github.com/gorilla/websocket"
|
|
"github.com/superseriousbusiness/gotosocial/internal/processing"
|
|
)
|
|
|
|
const (
|
|
// BasePath is the path for the streaming api, minus the 'api' prefix
|
|
BasePath = "/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"
|
|
)
|
|
|
|
type Module struct {
|
|
processor *processing.Processor
|
|
dTicker time.Duration
|
|
wsUpgrade websocket.Upgrader
|
|
}
|
|
|
|
func New(processor *processing.Processor, dTicker time.Duration, wsBuf int) *Module {
|
|
return &Module{
|
|
processor: processor,
|
|
dTicker: dTicker,
|
|
wsUpgrade: websocket.Upgrader{
|
|
ReadBufferSize: wsBuf, // we don't expect reads
|
|
WriteBufferSize: wsBuf,
|
|
|
|
// we expect cors requests (via eg., pinafore.social) so be lenient
|
|
CheckOrigin: func(r *http.Request) bool { return true },
|
|
},
|
|
}
|
|
}
|
|
|
|
func (m *Module) Route(attachHandler func(method string, path string, f ...gin.HandlerFunc) gin.IRoutes) {
|
|
attachHandler(http.MethodGet, BasePath, m.StreamGETHandler)
|
|
}
|