mirror of
https://github.com/pushbits/server.git
synced 2025-04-30 18:57:17 +02:00
add coloring option for title
This commit is contained in:
parent
567c814968
commit
fe1cbdf79e
7 changed files with 102 additions and 24 deletions
20
README.md
20
README.md
|
@ -114,6 +114,26 @@ You can retrieve the token using [pbcli](https://github.com/PushBits/cli) by run
|
||||||
pbcli application show $PB_APPLICATION --url https://pushbits.example.com --username $PB_USERNAME
|
pbcli application show $PB_APPLICATION --url https://pushbits.example.com --username $PB_USERNAME
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Message options
|
||||||
|
|
||||||
|
Messages are supporting thre different syntaxes:
|
||||||
|
|
||||||
|
* text/plain
|
||||||
|
* text/html
|
||||||
|
* text/markdown
|
||||||
|
|
||||||
|
To set a specific syntax you need to set the `extras`:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl \
|
||||||
|
--header "Content-Type: application/json" \
|
||||||
|
--request POST \
|
||||||
|
--data '{"message":"my message with\n\n**Markdown** _support_.","title":"my title","extras":{"client::display":{"contentType": "text/html"}}}' \
|
||||||
|
"https://pushbits.example.com/message?token=$PB_TOKEN"
|
||||||
|
```
|
||||||
|
|
||||||
|
HTML-Content might not be fully rendered in your Matrix-Client - see the corresponding [Matrix specs](https://spec.matrix.org/unstable/client-server-api/#mroommessage-msgtypes). This also holds for Markdown, as it is transfered to the corresponding HTML-syntax.
|
||||||
|
|
||||||
## Acknowledgments
|
## Acknowledgments
|
||||||
|
|
||||||
The idea for this software and most parts of the initial source are heavily inspired by [Gotify](https://gotify.net/).
|
The idea for this software and most parts of the initial source are heavily inspired by [Gotify](https://gotify.net/).
|
||||||
|
|
|
@ -47,7 +47,7 @@ func main() {
|
||||||
log.Fatal(err)
|
log.Fatal(err)
|
||||||
}
|
}
|
||||||
|
|
||||||
dp, err := dispatcher.Create(db, c.Matrix.Homeserver, c.Matrix.Username, c.Matrix.Password)
|
dp, err := dispatcher.Create(db, c.Matrix.Homeserver, c.Matrix.Username, c.Matrix.Password, c.Message)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
log.Fatal(err)
|
log.Fatal(err)
|
||||||
}
|
}
|
||||||
|
|
|
@ -56,3 +56,7 @@ crypto:
|
||||||
parallelism: 4
|
parallelism: 4
|
||||||
saltlength: 16
|
saltlength: 16
|
||||||
keylength: 32
|
keylength: 32
|
||||||
|
|
||||||
|
message:
|
||||||
|
# add coloring to the title according to syslog priorities
|
||||||
|
# coloredtitle: true
|
||||||
|
|
|
@ -30,6 +30,7 @@ type NotificationHandler struct {
|
||||||
// CreateNotification is used to create a new notification for a user.
|
// CreateNotification is used to create a new notification for a user.
|
||||||
func (h *NotificationHandler) CreateNotification(ctx *gin.Context) {
|
func (h *NotificationHandler) CreateNotification(ctx *gin.Context) {
|
||||||
var notification model.Notification
|
var notification model.Notification
|
||||||
|
notification.Priority = 8 // set a default value
|
||||||
|
|
||||||
if err := ctx.Bind(¬ification); err != nil {
|
if err := ctx.Bind(¬ification); err != nil {
|
||||||
return
|
return
|
||||||
|
|
|
@ -42,7 +42,8 @@ type Configuration struct {
|
||||||
Security struct {
|
Security struct {
|
||||||
CheckHIBP bool `default:"false"`
|
CheckHIBP bool `default:"false"`
|
||||||
}
|
}
|
||||||
Crypto CryptoConfig
|
Crypto CryptoConfig
|
||||||
|
Message map[string]interface{}
|
||||||
}
|
}
|
||||||
|
|
||||||
func configFiles() []string {
|
func configFiles() []string {
|
||||||
|
|
|
@ -16,12 +16,13 @@ type Database interface {
|
||||||
|
|
||||||
// Dispatcher holds information for sending notifications to clients.
|
// Dispatcher holds information for sending notifications to clients.
|
||||||
type Dispatcher struct {
|
type Dispatcher struct {
|
||||||
db Database
|
db Database
|
||||||
client *gomatrix.Client
|
client *gomatrix.Client
|
||||||
|
settings map[string]interface{}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Create instanciates a dispatcher connection.
|
// Create instanciates a dispatcher connection.
|
||||||
func Create(db Database, homeserver, username, password string) (*Dispatcher, error) {
|
func Create(db Database, homeserver, username, password string, settings map[string]interface{}) (*Dispatcher, error) {
|
||||||
log.Println("Setting up dispatcher.")
|
log.Println("Setting up dispatcher.")
|
||||||
|
|
||||||
client, err := gomatrix.NewClient(homeserver, "", "")
|
client, err := gomatrix.NewClient(homeserver, "", "")
|
||||||
|
@ -40,7 +41,7 @@ func Create(db Database, homeserver, username, password string) (*Dispatcher, er
|
||||||
|
|
||||||
client.SetCredentials(response.UserID, response.AccessToken)
|
client.SetCredentials(response.UserID, response.AccessToken)
|
||||||
|
|
||||||
return &Dispatcher{client: client}, nil
|
return &Dispatcher{client: client, settings: settings}, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// Close closes the dispatcher connection.
|
// Close closes the dispatcher connection.
|
||||||
|
|
|
@ -14,10 +14,39 @@ import (
|
||||||
func (d *Dispatcher) SendNotification(a *model.Application, n *model.Notification) error {
|
func (d *Dispatcher) SendNotification(a *model.Application, n *model.Notification) error {
|
||||||
log.Printf("Sending notification to room %s.", a.MatrixID)
|
log.Printf("Sending notification to room %s.", a.MatrixID)
|
||||||
|
|
||||||
plainTitle := strings.TrimSpace(n.Title)
|
|
||||||
plainMessage := strings.TrimSpace(n.Message)
|
plainMessage := strings.TrimSpace(n.Message)
|
||||||
escapedTitle := html.EscapeString(plainTitle)
|
plainTitle := strings.TrimSpace(n.Title)
|
||||||
message := html.EscapeString(plainMessage) // default to text/plain
|
message := d.getFormattedMessage(n)
|
||||||
|
title := d.getFormattedTitle(n)
|
||||||
|
|
||||||
|
text := fmt.Sprintf("%s\n\n%s", plainTitle, plainMessage)
|
||||||
|
formattedText := fmt.Sprintf("%s %s", title, message)
|
||||||
|
|
||||||
|
_, err := d.client.SendFormattedText(a.MatrixID, text, formattedText)
|
||||||
|
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
// HTML-formats the title
|
||||||
|
func (d *Dispatcher) getFormattedTitle(n *model.Notification) string {
|
||||||
|
trimmedTitle := strings.TrimSpace(n.Title)
|
||||||
|
title := html.EscapeString(trimmedTitle)
|
||||||
|
|
||||||
|
if valueRaw, ok := d.settings["coloredtitle"]; ok {
|
||||||
|
value, ok := valueRaw.(bool)
|
||||||
|
|
||||||
|
if ok && value {
|
||||||
|
title = d.coloredText(d.priorityToColor(n.Priority), title)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return "<b>" + title + "</b><br /><br />"
|
||||||
|
}
|
||||||
|
|
||||||
|
// Converts different syntaxes to a HTML-formatted message
|
||||||
|
func (d *Dispatcher) getFormattedMessage(n *model.Notification) string {
|
||||||
|
trimmedMessage := strings.TrimSpace(n.Message)
|
||||||
|
message := strings.Replace(html.EscapeString(trimmedMessage), "\n", "<br />", -1) // default to text/plain
|
||||||
|
|
||||||
if optionsDisplayRaw, ok := n.Extras["client::display"]; ok {
|
if optionsDisplayRaw, ok := n.Extras["client::display"]; ok {
|
||||||
optionsDisplay, ok := optionsDisplayRaw.(map[string]interface{})
|
optionsDisplay, ok := optionsDisplayRaw.(map[string]interface{})
|
||||||
|
@ -30,25 +59,47 @@ func (d *Dispatcher) SendNotification(a *model.Application, n *model.Notificatio
|
||||||
|
|
||||||
switch contentType {
|
switch contentType {
|
||||||
case "html", "text/html":
|
case "html", "text/html":
|
||||||
message = plainMessage
|
message = strings.Replace(trimmedMessage, "\n", "<br />", -1)
|
||||||
case "markdown", "md", "text/md", "text/markdown":
|
case "markdown", "md", "text/md", "text/markdown":
|
||||||
message = string(markdown.ToHTML([]byte(plainMessage), nil, nil))
|
// allow HTML in Markdown
|
||||||
|
message = string(markdown.ToHTML([]byte(trimmedMessage), nil, nil))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// TODO cubicroot: add colors for priority https://spec.matrix.org/unstable/client-server-api/#mroommessage-msgtypes
|
return message
|
||||||
// maybe make this optional in the settings or so
|
}
|
||||||
|
|
||||||
// TODO cubicroot: check if we somehow can handle \n or other methods of line breaks
|
// Maps priorities to hex colors
|
||||||
|
func (d *Dispatcher) priorityToColor(prio int) string {
|
||||||
// TODO cubicroot: add docu
|
switch prio {
|
||||||
|
case 0: // emergency - dark red
|
||||||
text := fmt.Sprintf("%s\n\n%s", plainTitle, plainMessage)
|
return "#cc0000"
|
||||||
formattedText := fmt.Sprintf("<b>%s</b><br /><br />%s", escapedTitle, message)
|
case 1: // alert - red
|
||||||
|
return "#ed1f11"
|
||||||
_, err := d.client.SendFormattedText(a.MatrixID, text, formattedText)
|
case 2: // critical - dark orange
|
||||||
|
return "#ed6d11"
|
||||||
return err
|
case 3: // error - orange
|
||||||
|
return "#edab11"
|
||||||
|
case 4: // warning - yellow
|
||||||
|
return "#edd711"
|
||||||
|
case 5: // notice - green
|
||||||
|
return "#70ed11"
|
||||||
|
case 6: // informational - blue
|
||||||
|
return "#118eed"
|
||||||
|
case 7: // debug - grey
|
||||||
|
return "#828282"
|
||||||
|
}
|
||||||
|
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
|
||||||
|
// Maps a priority to a color tag
|
||||||
|
func (d *Dispatcher) coloredText(color string, text string) string {
|
||||||
|
if color == "" {
|
||||||
|
return text
|
||||||
|
}
|
||||||
|
|
||||||
|
return "<font data-mx-color='" + color + "'>" + text + "</font>"
|
||||||
}
|
}
|
||||||
|
|
Loading…
Add table
Reference in a new issue