9c484efd36
* add public func to lookup a ChatClient by its clientId * add facility to send a system message directly to a user * add clientId field to UserEvent * implement simple http endpoint to send a message to a user * let mux handle new directSystemMessageToUser endpoint * add ClientId to UserEvents across the codebase * render body of system-message to client * add clientId to Chat-Message * add tests showing how url-parsing should work * add simple rest endpoint helpers for parameter-parsing and easy routing * use newly added rest-endpoint helper to rout to Client-Messaging controller * use safe "ReadRestUrlParameter" to parse ClientId * remove empty HandleFunc in router * set Header directly to prevent built-in (platform-dependent) canonicalization to kick in * fix typo in "Parameter" message * remove debug-logging of HTTP headers in REST-helpers * convert to uint32 to prevent overruns when converting to wraptype uint later on * resolve linter-ouchies * resolve linter potential nil-deref warning * document the SendSystemMessageToClient endpoint in swaggerdoc * remove clientId assignment causing potential nil dereference in userDisabledEvent-case as the clientId isn't relevant here anyway * make findClientById private, so its not accessible outside of core/chat * remove redundant string type hint * Update PR based on linter requirements Co-authored-by: Raffael Rehberger <raffael@rtrace.io> Co-authored-by: Gabe Kangas <gabek@real-ity.com>
224 lines
6.6 KiB
Go
224 lines
6.6 KiB
Go
package admin
|
|
|
|
// this is endpoint logic
|
|
|
|
import (
|
|
"encoding/json"
|
|
"errors"
|
|
"fmt"
|
|
"net/http"
|
|
"strconv"
|
|
|
|
"github.com/owncast/owncast/controllers"
|
|
"github.com/owncast/owncast/core/chat"
|
|
"github.com/owncast/owncast/core/chat/events"
|
|
"github.com/owncast/owncast/core/user"
|
|
"github.com/owncast/owncast/utils"
|
|
log "github.com/sirupsen/logrus"
|
|
)
|
|
|
|
// ExternalUpdateMessageVisibility updates an array of message IDs to have the same visiblity.
|
|
func ExternalUpdateMessageVisibility(integration user.ExternalAPIUser, w http.ResponseWriter, r *http.Request) {
|
|
UpdateMessageVisibility(w, r)
|
|
}
|
|
|
|
// UpdateMessageVisibility updates an array of message IDs to have the same visiblity.
|
|
func UpdateMessageVisibility(w http.ResponseWriter, r *http.Request) {
|
|
type messageVisibilityUpdateRequest struct {
|
|
IDArray []string `json:"idArray"`
|
|
Visible bool `json:"visible"`
|
|
}
|
|
|
|
if r.Method != controllers.POST {
|
|
controllers.WriteSimpleResponse(w, false, r.Method+" not supported")
|
|
return
|
|
}
|
|
|
|
decoder := json.NewDecoder(r.Body)
|
|
var request messageVisibilityUpdateRequest
|
|
|
|
if err := decoder.Decode(&request); err != nil {
|
|
log.Errorln(err)
|
|
controllers.WriteSimpleResponse(w, false, "")
|
|
return
|
|
}
|
|
|
|
if err := chat.SetMessagesVisibility(request.IDArray, request.Visible); err != nil {
|
|
controllers.WriteSimpleResponse(w, false, err.Error())
|
|
return
|
|
}
|
|
|
|
controllers.WriteSimpleResponse(w, true, "changed")
|
|
}
|
|
|
|
// UpdateUserEnabled enable or disable a single user by ID.
|
|
func UpdateUserEnabled(w http.ResponseWriter, r *http.Request) {
|
|
type blockUserRequest struct {
|
|
UserID string `json:"userId"`
|
|
Enabled bool `json:"enabled"`
|
|
}
|
|
|
|
if r.Method != controllers.POST {
|
|
controllers.WriteSimpleResponse(w, false, r.Method+" not supported")
|
|
return
|
|
}
|
|
|
|
decoder := json.NewDecoder(r.Body)
|
|
var request blockUserRequest
|
|
|
|
if err := decoder.Decode(&request); err != nil {
|
|
log.Errorln(err)
|
|
controllers.WriteSimpleResponse(w, false, "")
|
|
return
|
|
}
|
|
|
|
// Disable/enable the user
|
|
if err := user.SetEnabled(request.UserID, request.Enabled); err != nil {
|
|
log.Errorln("error changing user enabled status", err)
|
|
}
|
|
|
|
// Hide/show the user's chat messages if disabling.
|
|
// Leave hidden messages hidden to be safe.
|
|
if !request.Enabled {
|
|
if err := chat.SetMessageVisibilityForUserID(request.UserID, request.Enabled); err != nil {
|
|
log.Errorln("error changing user messages visibility", err)
|
|
}
|
|
}
|
|
|
|
// Forcefully disconnect the user from the chat
|
|
if !request.Enabled {
|
|
chat.DisconnectUser(request.UserID)
|
|
disconnectedUser := user.GetUserByID(request.UserID)
|
|
_ = chat.SendSystemAction(fmt.Sprintf("**%s** has been removed from chat.", disconnectedUser.DisplayName), true)
|
|
}
|
|
|
|
controllers.WriteSimpleResponse(w, true, fmt.Sprintf("%s enabled: %t", request.UserID, request.Enabled))
|
|
}
|
|
|
|
// GetDisabledUsers will return all the disabled users.
|
|
func GetDisabledUsers(w http.ResponseWriter, r *http.Request) {
|
|
w.Header().Set("Content-Type", "application/json")
|
|
|
|
users := user.GetDisabledUsers()
|
|
controllers.WriteResponse(w, users)
|
|
}
|
|
|
|
// GetChatMessages returns all of the chat messages, unfiltered.
|
|
func GetChatMessages(w http.ResponseWriter, r *http.Request) {
|
|
w.Header().Set("Content-Type", "application/json")
|
|
|
|
messages := chat.GetChatModerationHistory()
|
|
controllers.WriteResponse(w, messages)
|
|
}
|
|
|
|
// SendSystemMessage will send an official "SYSTEM" message to chat on behalf of your server.
|
|
func SendSystemMessage(integration user.ExternalAPIUser, w http.ResponseWriter, r *http.Request) {
|
|
w.Header().Set("Content-Type", "application/json")
|
|
|
|
var message events.SystemMessageEvent
|
|
if err := json.NewDecoder(r.Body).Decode(&message); err != nil {
|
|
controllers.InternalErrorHandler(w, err)
|
|
return
|
|
}
|
|
|
|
if err := chat.SendSystemMessage(message.Body, false); err != nil {
|
|
controllers.BadRequestHandler(w, err)
|
|
}
|
|
|
|
controllers.WriteSimpleResponse(w, true, "sent")
|
|
}
|
|
|
|
// SendSystemMessageToConnectedClient will handle incoming requests to send a single message to a single connected client by ID.
|
|
func SendSystemMessageToConnectedClient(integration user.ExternalAPIUser, w http.ResponseWriter, r *http.Request) {
|
|
w.Header().Set("Content-Type", "application/json")
|
|
clientIDText, err := utils.ReadRestURLParameter(r, "clientId")
|
|
if err != nil {
|
|
controllers.BadRequestHandler(w, err)
|
|
return
|
|
}
|
|
|
|
clientIDNumeric, err := strconv.ParseUint(clientIDText, 10, 32)
|
|
if err != nil {
|
|
controllers.BadRequestHandler(w, err)
|
|
return
|
|
}
|
|
|
|
var message events.SystemMessageEvent
|
|
if err := json.NewDecoder(r.Body).Decode(&message); err != nil {
|
|
controllers.InternalErrorHandler(w, err)
|
|
return
|
|
}
|
|
|
|
chat.SendSystemMessageToClient(uint(clientIDNumeric), message.Body)
|
|
controllers.WriteSimpleResponse(w, true, "sent")
|
|
}
|
|
|
|
// SendUserMessage will send a message to chat on behalf of a user. *Depreciated*.
|
|
func SendUserMessage(integration user.ExternalAPIUser, w http.ResponseWriter, r *http.Request) {
|
|
w.Header().Set("Content-Type", "application/json")
|
|
controllers.BadRequestHandler(w, errors.New("no longer supported. see /api/integrations/chat/send"))
|
|
}
|
|
|
|
// SendIntegrationChatMessage will send a chat message on behalf of an external chat integration.
|
|
func SendIntegrationChatMessage(integration user.ExternalAPIUser, w http.ResponseWriter, r *http.Request) {
|
|
w.Header().Set("Content-Type", "application/json")
|
|
|
|
name := integration.DisplayName
|
|
|
|
if name == "" {
|
|
controllers.BadRequestHandler(w, errors.New("unknown integration for provided access token"))
|
|
return
|
|
}
|
|
|
|
var event events.UserMessageEvent
|
|
if err := json.NewDecoder(r.Body).Decode(&event); err != nil {
|
|
controllers.InternalErrorHandler(w, err)
|
|
return
|
|
}
|
|
event.SetDefaults()
|
|
event.RenderBody()
|
|
event.Type = "CHAT"
|
|
|
|
if event.Empty() {
|
|
controllers.BadRequestHandler(w, errors.New("invalid message"))
|
|
return
|
|
}
|
|
|
|
event.User = &user.User{
|
|
ID: integration.ID,
|
|
DisplayName: name,
|
|
DisplayColor: integration.DisplayColor,
|
|
CreatedAt: integration.CreatedAt,
|
|
}
|
|
|
|
if err := chat.Broadcast(&event); err != nil {
|
|
controllers.BadRequestHandler(w, err)
|
|
return
|
|
}
|
|
|
|
chat.SaveUserMessage(event)
|
|
|
|
controllers.WriteSimpleResponse(w, true, "sent")
|
|
}
|
|
|
|
// SendChatAction will send a generic chat action.
|
|
func SendChatAction(integration user.ExternalAPIUser, w http.ResponseWriter, r *http.Request) {
|
|
w.Header().Set("Content-Type", "application/json")
|
|
|
|
var message events.SystemActionEvent
|
|
if err := json.NewDecoder(r.Body).Decode(&message); err != nil {
|
|
controllers.InternalErrorHandler(w, err)
|
|
return
|
|
}
|
|
|
|
message.SetDefaults()
|
|
message.RenderBody()
|
|
|
|
if err := chat.SendSystemAction(message.Body, false); err != nil {
|
|
controllers.BadRequestHandler(w, err)
|
|
return
|
|
}
|
|
|
|
controllers.WriteSimpleResponse(w, true, "sent")
|
|
}
|