More docs

server/message_cache.go

@@ -90,7 +90,7 @@ const (
 
 // Schema management queries
 const (
-	currentSchemaVersion          = 5
+	currentSchemaVersion          = 6
 	createSchemaVersionTableQuery = `
 		CREATE TABLE IF NOT EXISTS schemaVersion (
 			id INT PRIMARY KEY,
@@ -168,6 +168,11 @@ const (
 		ALTER TABLE messages_new RENAME TO messages;
 		COMMIT;
 	`
+
+	// 5 -> 6
+	migrate5To6AlterMessagesTableQuery = `
+		ALTER TABLE messages ADD COLUMN actions TEXT NOT NULL DEFAULT('');
+	`
 )
 
 type messageCache struct {
@@ -509,6 +514,8 @@ func setupCacheDB(db *sql.DB) error {
 		return migrateFrom3(db)
 	} else if schemaVersion == 4 {
 		return migrateFrom4(db)
+	} else if schemaVersion == 5 {
+		return migrateFrom5(db)
 	}
 	return fmt.Errorf("unexpected schema version found: %d", schemaVersion)
 }
@@ -581,5 +588,16 @@ func migrateFrom4(db *sql.DB) error {
 	if _, err := db.Exec(updateSchemaVersion, 5); err != nil {
 		return err
 	}
+	return migrateFrom5(db)
+}
+
+func migrateFrom5(db *sql.DB) error {
+	log.Print("Migrating cache database schema: from 5 to 6")
+	if _, err := db.Exec(migrate5To6AlterMessagesTableQuery); err != nil {
+		return err
+	}
+	if _, err := db.Exec(updateSchemaVersion, 6); err != nil {
+		return err
+	}
 	return nil // Update this when a new version is added
 }

server/util.go

@@ -3,7 +3,6 @@ package server
 import (
 	"encoding/json"
 	"fmt"
-	"github.com/pkg/errors"
 	"heckel.io/ntfy/util"
 	"net/http"
 	"strings"
@@ -96,7 +95,10 @@ func parseActionsFromSimple(s string) ([]*action, error) {
 	actions := make([]*action, 0)
 	rawActions := util.SplitNoEmpty(s, ";")
 	for _, rawAction := range rawActions {
-		newAction := &action{}
+		newAction := &action{
+			Headers: make(map[string]string),
+			Extras:  make(map[string]string),
+		}
 		parts := util.SplitNoEmpty(rawAction, ",")
 		if len(parts) < 3 {
 			return nil, fmt.Errorf("cannot parse action: action requires at least keys 'action', 'label' and one parameter: %s", rawAction)
@@ -109,6 +111,10 @@ func parseActionsFromSimple(s string) ([]*action, error) {
 				newAction.Label = value
 			} else if key == "" && util.InStringList([]string{"view", "http"}, newAction.Action) && i == 2 {
 				newAction.URL = value
+			} else if strings.HasPrefix(key, "headers.") {
+				newAction.Headers[strings.TrimPrefix(key, "headers.")] = value
+			} else if strings.HasPrefix(key, "extras.") {
+				newAction.Extras[strings.TrimPrefix(key, "extras.")] = value
 			} else if key != "" {
 				switch strings.ToLower(key) {
 				case "action":
@@ -122,10 +128,10 @@ func parseActionsFromSimple(s string) ([]*action, error) {
 				case "body":
 					newAction.Body = value
 				default:
-					return nil, errors.Errorf("cannot parse action: key '%s' not supported, please use JSON format instead", part)
+					return nil, fmt.Errorf("cannot parse action: key '%s' not supported, please use JSON format instead", part)
 				}
 			} else {
-				return nil, errors.Errorf("cannot parse action: unknown phrase '%s'", part)
+				return nil, fmt.Errorf("cannot parse action: unknown phrase '%s'", part)
 			}
 		}
 		actions = append(actions, newAction)

server/util_test.go

@@ -61,4 +61,22 @@ func TestParseActions(t *testing.T) {
 	require.Equal(t, "https://door.lan/open", actions[0].URL)
 	require.Equal(t, "PUT", actions[0].Method)
 	require.Equal(t, "this is a body", actions[0].Body)
+
+	actions, err = parseActions("action=broadcast, label=Do a thing, extras.command=some command, extras.some_param=a parameter")
+	require.Nil(t, err)
+	require.Equal(t, 1, len(actions))
+	require.Equal(t, "broadcast", actions[0].Action)
+	require.Equal(t, "Do a thing", actions[0].Label)
+	require.Equal(t, 2, len(actions[0].Extras))
+	require.Equal(t, "some command", actions[0].Extras["command"])
+	require.Equal(t, "a parameter", actions[0].Extras["some_param"])
+
+	actions, err = parseActions("action=http, label=Send request, url=http://example.com, method=GET, headers.Content-Type=application/json, headers.Authorization=Basic sdasffsf")
+	require.Nil(t, err)
+	require.Equal(t, 1, len(actions))
+	require.Equal(t, "http", actions[0].Action)
+	require.Equal(t, "Send request", actions[0].Label)
+	require.Equal(t, 2, len(actions[0].Headers))
+	require.Equal(t, "application/json", actions[0].Headers["Content-Type"])
+	require.Equal(t, "Basic sdasffsf", actions[0].Headers["Authorization"])
 }