aljaz/signal-cli-rest-api
1
0
Fork 0
mirror of https://github.com/aljazceru/signal-cli-rest-api.git synced 2025-12-21 08:34:22 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #176 from filipre/reactions

Browse Source 
Reactions Endpoint Proposal
This commit is contained in:
Bernhard B
2021-11-06 14:54:13 +01:00
committed by GitHub
parent f472e51984 690271c37f
commit a6489ce742
5 changed files with 684 additions and 356 deletions
Download Patch File Download Diff File Expand all files Collapse all files

173
src/api/api.go
View File

@@ -9,8 +9,8 @@ import (
"github.com/gabriel-vasile/mimetype"
"github.com/gin-gonic/gin"
log "github.com/sirupsen/logrus"
"github.com/gorilla/websocket"
log "github.com/sirupsen/logrus"
"github.com/bbernhard/signal-cli-rest-api/client"
utils "github.com/bbernhard/signal-cli-rest-api/utils"
@@ -29,23 +29,23 @@ const (
type GroupPermissions struct {
AddMembers string `json:"add_members" enums:"only-admins,every-member"`
EditGroup string `json:"edit_group" enums:"only-admins,every-member"`
EditGroup string `json:"edit_group" enums:"only-admins,every-member"`
}
type CreateGroupRequest struct {
Name string `json:"name"`
Members []string `json:"members"`
Description string `json:"description"`
Permissions GroupPermissions `json:"permissions"`
GroupLinkState string `json:"group_link" enums:"disabled,enabled,enabled-with-approval"`
Name string `json:"name"`
Members []string `json:"members"`
Description string `json:"description"`
Permissions GroupPermissions `json:"permissions"`
GroupLinkState string `json:"group_link" enums:"disabled,enabled,enabled-with-approval"`
}
type LoggingConfiguration struct {
Level string `json:"Level"`
Level string `json:"Level"`
}
type Configuration struct {
Logging LoggingConfiguration `json:"logging"`
Logging LoggingConfiguration `json:"logging"`
}
type RegisterNumberRequest struct {
@@ -57,6 +57,13 @@ type VerifyNumberSettings struct {
Pin string `json:"pin"`
}
type Reaction struct {
Recipient string `json:"recipient"`
Reaction string `json:"reaction"`
TargetAuthor string `json:"target_author"`
Timestamp int64 `json:"timestamp"`
}
type SendMessageV1 struct {
Number string `json:"number"`
Recipients []string `json:"recipients"`
@@ -80,8 +87,6 @@ type Error struct {
Msg string `json:"error"`
}
type CreateGroupResponse struct {
Id string `json:"id"`
}
@@ -106,12 +111,12 @@ var connectionUpgrader = websocket.Upgrader{
}
type Api struct {
signalClient *client.SignalClient
signalClient *client.SignalClient
}
func NewApi(signalClient *client.SignalClient) *Api {
return &Api{
signalClient: signalClient,
signalClient: signalClient,
}
}
@@ -283,7 +288,6 @@ func (a *Api) SendV2(c *gin.Context) {
c.JSON(201, SendMessageResponse{Timestamp: strconv.FormatInt((*timestamps)[0].Timestamp, 10)})
}
func (a *Api) handleSignalReceive(ws *websocket.Conn, number string) {
for {
data, err := a.signalClient.Receive(number, 0)
@@ -404,7 +408,7 @@ func (a *Api) CreateGroup(c *gin.Context) {
}
if req.GroupLinkState != "" && !utils.StringInSlice(req.GroupLinkState, []string{"enabled", "enabled-with-approval", "disabled"}) {
c.JSON(400, Error{Msg: "Invalid group link provided - only 'enabled', 'enabled-with-approval' and 'disabled' allowed!" })
c.JSON(400, Error{Msg: "Invalid group link provided - only 'enabled', 'enabled-with-approval' and 'disabled' allowed!"})
return
}
@@ -557,18 +561,18 @@ func (a *Api) RemoveAttachment(c *gin.Context) {
err := a.signalClient.RemoveAttachment(attachment)
if err != nil {
switch err.(type) {
case *client.InvalidNameError:
c.JSON(400, Error{Msg: err.Error()})
return
case *client.NotFoundError:
c.JSON(404, Error{Msg: err.Error()})
return
case *client.InternalError:
c.JSON(500, Error{Msg: err.Error()})
return
default:
c.JSON(500, Error{Msg: err.Error()})
return
case *client.InvalidNameError:
c.JSON(400, Error{Msg: err.Error()})
return
case *client.NotFoundError:
c.JSON(404, Error{Msg: err.Error()})
return
case *client.InternalError:
c.JSON(500, Error{Msg: err.Error()})
return
default:
c.JSON(500, Error{Msg: err.Error()})
return
}
}
@@ -589,18 +593,18 @@ func (a *Api) ServeAttachment(c *gin.Context) {
attachmentBytes, err := a.signalClient.GetAttachment(attachment)
if err != nil {
switch err.(type) {
case *client.InvalidNameError:
c.JSON(400, Error{Msg: err.Error()})
return
case *client.NotFoundError:
c.JSON(404, Error{Msg: err.Error()})
return
case *client.InternalError:
c.JSON(500, Error{Msg: err.Error()})
return
default:
c.JSON(500, Error{Msg: err.Error()})
return
case *client.InvalidNameError:
c.JSON(400, Error{Msg: err.Error()})
return
case *client.NotFoundError:
c.JSON(404, Error{Msg: err.Error()})
return
case *client.InternalError:
c.JSON(500, Error{Msg: err.Error()})
return
default:
c.JSON(500, Error{Msg: err.Error()})
return
}
}
@@ -890,6 +894,97 @@ func (a *Api) QuitGroup(c *gin.Context) {
c.Status(http.StatusNoContent)
}
// @Summary Send a reaction.
// @Tags Reactions
// @Description React to a message
// @Accept json
// @Produce json
// @Success 204 {string} OK
// @Failure 400 {object} Error
// @Param data body Reaction true "Reaction"
// @Router /v1/reactions/{number} [post]
func (a *Api) SendReaction(c *gin.Context) {
var req Reaction
err := c.BindJSON(&req)
if err != nil {
c.JSON(400, Error{Msg: "Couldn't process request - invalid request"})
log.Error(err.Error())
return
}
number := c.Param("number")
if req.Recipient == "" {
c.JSON(400, Error{Msg: "Couldn't process request - recipient missing"})
return
}
if req.Reaction == "" {
c.JSON(400, Error{Msg: "Couldn't process request - reaction missing"})
return
}
if req.TargetAuthor == "" {
c.JSON(400, Error{Msg: "Couldn't process request - target_author missing"})
return
}
if req.Timestamp == 0 {
c.JSON(400, Error{Msg: "Couldn't process request - timestamp missing"})
return
}
err = a.signalClient.SendReaction(number, req.Recipient, req.Reaction, req.TargetAuthor, req.Timestamp, false)
if err != nil {
c.JSON(400, Error{Msg: err.Error()})
return
}
c.Status(http.StatusNoContent)
}
// @Summary Remove a reaction.
// @Tags Reactions
// @Description Remove a reaction
// @Accept json
// @Produce json
// @Success 204 {string} OK
// @Failure 400 {object} Error
// @Param data body Reaction true "Reaction"
// @Router /v1/reactions/{number} [delete]
func (a *Api) RemoveReaction(c *gin.Context) {
var req Reaction
err := c.BindJSON(&req)
if err != nil {
c.JSON(400, Error{Msg: "Couldn't process request - invalid request"})
log.Error(err.Error())
return
}
number := c.Param("number")
if req.Recipient == "" {
c.JSON(400, Error{Msg: "Couldn't process request - recipient missing"})
return
}
if req.TargetAuthor == "" {
c.JSON(400, Error{Msg: "Couldn't process request - target_author missing"})
return
}
if req.Timestamp == 0 {
c.JSON(400, Error{Msg: "Couldn't process request - timestamp missing"})
return
}
err = a.signalClient.SendReaction(number, req.Recipient, req.Reaction, req.TargetAuthor, req.Timestamp, true)
if err != nil {
c.JSON(400, Error{Msg: err.Error()})
return
}
c.Status(http.StatusNoContent)
}
// @Summary Show Typing Indicator.
// @Tags Messages
// @Description Show Typing Indicator.

76
src/client/client.go
View File

@@ -14,9 +14,10 @@ import (
"strings"
"time"
"github.com/cyphar/filepath-securejoin"
securejoin "github.com/cyphar/filepath-securejoin"
"github.com/gabriel-vasile/mimetype"
"github.com/h2non/filetype"
//"github.com/sourcegraph/jsonrpc2"//"net/rpc/jsonrpc"
log "github.com/sirupsen/logrus"
@@ -613,8 +614,8 @@ func (s *SignalClient) CreateGroup(number string, name string, members []string,
}
type Response struct {
GroupId string `json:"groupId"`
Timestamp int64 `json:"timestamp"`
GroupId string `json:"groupId"`
Timestamp int64 `json:"timestamp"`
}
var resp Response
json.Unmarshal([]byte(rawData), &resp)
@@ -995,6 +996,69 @@ func (s *SignalClient) QuitGroup(number string, groupId string) error {
return err
}
func (s *SignalClient) SendReaction(number string, recipient string, emoji string, target_author string, timestamp int64, remove bool) error {
// see https://github.com/AsamK/signal-cli/blob/master/man/signal-cli.1.adoc#sendreaction
var err error
recp := recipient
isGroup := false
if strings.HasPrefix(recipient, groupPrefix) {
isGroup = true
recp, err = ConvertGroupIdToInternalGroupId(recipient)
if err != nil {
return errors.New("Invalid group id")
}
}
if remove && emoji == "" {
emoji = "👍" // emoji must not be empty to remove a reaction
}
if s.signalCliMode == JsonRpc {
type Request struct {
Recipient string `json:"recipient,omitempty"`
GroupId string `json:"group-id,omitempty"`
Emoji string `json:"emoji"`
TargetAuthor string `json:"target-author"`
Timestamp int64 `json:"target-timestamp"`
Remove bool `json:"remove,omitempty"`
}
request := Request{}
if !isGroup {
request.Recipient = recp
} else {
request.GroupId = recp
}
request.Emoji = emoji
request.TargetAuthor = target_author
request.Timestamp = timestamp
if remove {
request.Remove = remove
}
jsonRpc2Client, err := s.getJsonRpc2Client(number)
if err != nil {
return err
}
_, err = jsonRpc2Client.getRaw("sendReaction", request)
return err
}
cmd := []string{
"--config", s.signalCliConfig,
"-u", number,
"sendReaction",
}
if !isGroup {
cmd = append(cmd, recp)
} else {
cmd = append(cmd, []string{"-g", recp}...)
}
cmd = append(cmd, []string{"-e", emoji, "-a", target_author, "-t", strconv.FormatInt(timestamp, 10)}...)
if remove {
cmd = append(cmd, "-r")
}
_, err = runSignalCli(true, cmd, "", s.signalCliMode)
return err
}
func (s *SignalClient) SendStartTyping(number string, recipient string) error {
var err error
recp := recipient
@@ -1010,7 +1074,7 @@ func (s *SignalClient) SendStartTyping(number string, recipient string) error {
if s.signalCliMode == JsonRpc {
type Request struct {
Recipient string `json:"recipient,omitempty"`
GroupId string `json:"group-id,omitempty"`
GroupId string `json:"group-id,omitempty"`
}
request := Request{}
if !isGroup {
@@ -1052,8 +1116,8 @@ func (s *SignalClient) SendStopTyping(number string, recipient string) error {
if s.signalCliMode == JsonRpc {
type Request struct {
Recipient string `json:"recipient,omitempty"`
GroupId string `json:"group-id,omitempty"`
Stop bool `json:"stop"`
GroupId string `json:"group-id,omitempty"`
Stop bool `json:"stop"`
}
request := Request{Stop: true}
if !isGroup {

99
src/docs/swagger.json
View File

@@ -679,6 +679,101 @@
}
}
},
"/v1/reactions/{number}": {
"post": {
"description": "React to a message.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Reactions"
],
"summary": "Send a reaction.",
"parameters": [
{
"description": "Reactions",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/api.Reaction"
}
}
],
"responses": {
"204": {
"description": "No Content",
"schema": {
"type": "string"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/api.Error"
}
}
}
},
"delete": {
"description": "Delete a reaction.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Reactions"
],
"summary": "Delete a reaction.",
"parameters": [
{
"description": "Reactions",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/api.Reaction"
}
}
],
"responses": {
"204": {
"description": "No Content",
"schema": {
"type": "string"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/api.Error"
}
}
}
}
},
"api.Reaction": {
"type": "object",
"properties": {
"recipient": {
"type": "string"
},
"reaction": {
"type": "string"
},
"target_author": {
"type": "string"
},
"timestamp": {
"type": "integer"
}
}
},
"/v1/receive/{number}": {
"get": {
"description": "Receives Signal Messages from the Signal Network. If you are running the docker container in normal/native mode, this is a GET endpoint. In json-rpc mode this is a websocket endpoint.",
@@ -1280,6 +1375,10 @@
{
"description": "List and Trust Identities.",
"name": "Identities"
},
{
"description": "React to messages.",
"name": "Reactions"
}
]
}

675
src/docs/swagger.yaml
View File

File diff suppressed because it is too large Load Diff

17
src/main.go
View File

@@ -46,6 +46,9 @@ import (
// @tag.name Identities
// @tag.description List and Trust Identities.
// @tag.name Reactions
// @tag.description React to messages.
// @host 127.0.0.1:8080
// @BasePath /
func main() {
@@ -114,7 +117,6 @@ func main() {
}
}
jsonRpc2ClientConfigPathPath := *signalCliConfig + "/jsonrpc2.yml"
signalClient := client.NewSignalClient(*signalCliConfig, *attachmentTmpDir, *avatarTmpDir, signalCliMode, jsonRpc2ClientConfigPathPath)
err = signalClient.Init()
@@ -196,6 +198,12 @@ func main() {
typingIndicator.PUT(":number", api.SendStartTyping)
typingIndicator.DELETE(":number", api.SendStopTyping)
}
reactions := v1.Group("/reactions")
{
reactions.POST(":number", api.SendReaction)
reactions.DELETE(":number", api.RemoveReaction)
}
}
v2 := router.Group("/v2")
@@ -228,7 +236,7 @@ func main() {
filename := filepath.Base(path)
if strings.HasPrefix(filename, "+") && info.Mode().IsRegular() {
log.Debug("AUTO_RECEIVE_SCHEDULE: Calling receive for number ", filename)
resp, err := http.Get("http://127.0.0.1:" + port + "/v1/receive/"+filename)
resp, err := http.Get("http://127.0.0.1:" + port + "/v1/receive/" + filename)
if err != nil {
log.Error("AUTO_RECEIVE_SCHEDULE: Couldn't call receive for number ", filename, ": ", err.Error())
}
@@ -241,7 +249,7 @@ func main() {
}
type ReceiveResponse struct {
Error string `json:"error"`
Error string `json:"error"`
}
var receiveResponse ReceiveResponse
err = json.Unmarshal(jsonResp, &receiveResponse)
@@ -264,8 +272,5 @@ func main() {
c.Start()
}
router.Run()
}