159 lines
3.1 KiB
Go
159 lines
3.1 KiB
Go
package yp
|
|
|
|
import (
|
|
"bytes"
|
|
"io/ioutil"
|
|
"net/http"
|
|
"net/url"
|
|
"os"
|
|
"time"
|
|
|
|
"encoding/json"
|
|
|
|
"github.com/owncast/owncast/config"
|
|
"github.com/owncast/owncast/models"
|
|
|
|
log "github.com/sirupsen/logrus"
|
|
)
|
|
|
|
const pingInterval = 4 * time.Minute
|
|
|
|
var getStatus func() models.Status
|
|
var _inErrorState = false
|
|
|
|
//YP is a service for handling listing in the Owncast directory.
|
|
type YP struct {
|
|
timer *time.Ticker
|
|
}
|
|
|
|
type ypPingResponse struct {
|
|
Key string `json:"key"`
|
|
Success bool `json:"success"`
|
|
Error string `json:"error"`
|
|
ErrorCode int `json:"errorCode"`
|
|
}
|
|
|
|
type ypPingRequest struct {
|
|
Key string `json:"key"`
|
|
URL string `json:"url"`
|
|
}
|
|
|
|
// NewYP creates a new instance of the YP service handler.
|
|
func NewYP(getStatusFunc func() models.Status) *YP {
|
|
getStatus = getStatusFunc
|
|
return &YP{}
|
|
}
|
|
|
|
// Start is run when a live stream begins to start pinging YP.
|
|
func (yp *YP) Start() {
|
|
yp.timer = time.NewTicker(pingInterval)
|
|
|
|
go func() {
|
|
for {
|
|
select {
|
|
case <-yp.timer.C:
|
|
yp.ping()
|
|
}
|
|
}
|
|
}()
|
|
|
|
yp.ping()
|
|
}
|
|
|
|
// Stop stops the pinging of YP.
|
|
func (yp *YP) Stop() {
|
|
yp.timer.Stop()
|
|
}
|
|
|
|
func (yp *YP) ping() {
|
|
myInstanceURL := config.Config.YP.InstanceURL
|
|
isValidInstanceURL := isUrl(myInstanceURL)
|
|
if myInstanceURL == "" || !isValidInstanceURL {
|
|
if !_inErrorState {
|
|
log.Warnln("YP Error: unable to use", myInstanceURL, "as a public instance URL. Fix this value in your configuration.")
|
|
}
|
|
_inErrorState = true
|
|
return
|
|
}
|
|
|
|
key := yp.getSavedKey()
|
|
|
|
log.Traceln("Pinging YP as: ", config.Config.InstanceDetails.Name)
|
|
|
|
request := ypPingRequest{
|
|
Key: key,
|
|
URL: myInstanceURL,
|
|
}
|
|
|
|
req, err := json.Marshal(request)
|
|
if err != nil {
|
|
log.Errorln(err)
|
|
return
|
|
}
|
|
|
|
pingURL := config.Config.GetYPServiceHost() + "/ping"
|
|
resp, err := http.Post(pingURL, "application/json", bytes.NewBuffer(req))
|
|
if err != nil {
|
|
log.Errorln(err)
|
|
return
|
|
}
|
|
|
|
defer resp.Body.Close()
|
|
body, err := ioutil.ReadAll(resp.Body)
|
|
if err != nil {
|
|
log.Errorln(err)
|
|
}
|
|
|
|
pingResponse := ypPingResponse{}
|
|
json.Unmarshal(body, &pingResponse)
|
|
|
|
if !pingResponse.Success {
|
|
if !_inErrorState {
|
|
log.Warnln("YP Ping error returned from service:", pingResponse.Error)
|
|
}
|
|
_inErrorState = true
|
|
return
|
|
}
|
|
|
|
_inErrorState = false
|
|
|
|
if pingResponse.Key != key {
|
|
yp.writeSavedKey(pingResponse.Key)
|
|
}
|
|
}
|
|
|
|
func (yp *YP) writeSavedKey(key string) {
|
|
f, err := os.Create(".yp.key")
|
|
if err != nil {
|
|
log.Errorln(err)
|
|
return
|
|
}
|
|
defer f.Close()
|
|
|
|
_, err = f.WriteString(key)
|
|
if err != nil {
|
|
log.Errorln(err)
|
|
return
|
|
}
|
|
}
|
|
|
|
func (yp *YP) getSavedKey() string {
|
|
fileBytes, err := ioutil.ReadFile(".yp.key")
|
|
if err != nil {
|
|
return ""
|
|
}
|
|
|
|
return string(fileBytes)
|
|
}
|
|
|
|
// DisplayInstructions will let the user know they are not in the directory by default and
|
|
// how they can enable the feature.
|
|
func DisplayInstructions() {
|
|
text := "Your instance can be listed on the Owncast directory at http://directory.owncast.online by enabling YP in your config. Learn more at https://directory.owncast.online/get-listed."
|
|
log.Debugln(text)
|
|
}
|
|
func isUrl(str string) bool {
|
|
u, err := url.Parse(str)
|
|
return err == nil && u.Scheme != "" && u.Host != ""
|
|
}
|