eventstream: mimic PHP's rawurlencode function

As Icinga Web uses rawurldecode instead of rawurlencode, the space to
plus substitution cannot be used.

Author: oxzi

internal/eventstream/client.go

@@ -156,7 +156,7 @@ func (client *Client) buildCommonEvent(host, service string) (*event.Event, erro
 		eventName = host + "!" + service
 
 		eventUrl = eventUrl.JoinPath("/icingadb/service")
-		eventUrl.RawQuery = "name=" + url.PathEscape(service) + "&host.name=" + url.PathEscape(host)
+		eventUrl.RawQuery = "name=" + rawurlencode(service) + "&host.name=" + rawurlencode(host)
 
 		eventTags = map[string]string{
 			"host":    host,
@@ -174,7 +174,7 @@ func (client *Client) buildCommonEvent(host, service string) (*event.Event, erro
 		eventName = host
 
 		eventUrl = eventUrl.JoinPath("/icingadb/host")
-		eventUrl.RawQuery = "name=" + url.PathEscape(host)
+		eventUrl.RawQuery = "name=" + rawurlencode(host)
 
 		eventTags = map[string]string{
 			"host": host,

internal/eventstream/client_api.go

@@ -74,7 +74,7 @@ func (client *Client) queryObjectsApi(urlPaths []string, method string, body io.
 // queryObjectsApiDirect performs a direct resp. "fast" API query against an object, optionally identified by its name.
 func (client *Client) queryObjectsApiDirect(objType, objName string) (io.ReadCloser, error) {
 	return client.queryObjectsApi(
-		[]string{"/v1/objects/", objType + "s/", url.PathEscape(objName)},
+		[]string{"/v1/objects/", objType + "s/", rawurlencode(objName)},
 		http.MethodGet,
 		nil,
 		map[string]string{"Accept": "application/json"})

internal/eventstream/util.go

@@ -9,6 +9,8 @@ import (
 	"github.com/icinga/icingadb/pkg/icingadb"
 	"github.com/icinga/icingadb/pkg/logging"
 	"go.uber.org/zap"
+	"net/url"
+	"strings"
 )
 
 // makeProcessEvent creates a closure function to process received events.
@@ -69,3 +71,15 @@ func makeProcessEvent(
 		}
 	}
 }
+
+// rawurlencode mimics PHP's rawurlencode to be used for parameter encoding.
+//
+// Icinga Web uses rawurldecode instead of urldecode, which, as its main difference, does not honor the plus char ('+')
+// as a valid substitution for space (' '). Unfortunately, Go's url.QueryEscape does this very substitution and
+// url.PathEscape does a bit too less and has a misleading name on top.
+//
+// - https://www.php.net/manual/en/function.rawurlencode.php
+// - https://github.com/php/php-src/blob/php-8.2.12/ext/standard/url.c#L538
+func rawurlencode(s string) string {
+	return strings.ReplaceAll(url.QueryEscape(s), "+", "%20")
+}

internal/eventstream/util_test.go

@@ -0,0 +1,26 @@
+package eventstream
+
+import (
+	"github.com/stretchr/testify/assert"
+	"testing"
+)
+
+func TestRawurlencode(t *testing.T) {
+	tests := []struct {
+		name string
+		in   string
+		want string
+	}{
+		{"empty", "", ""},
+		{"printable", "abcABC0123", "abcABC0123"},
+		{"space", "foo bar", "foo%20bar"},
+		{"plus", "foo+bar", "foo%2Bbar"},
+		{"slash", "foo/bar", "foo%2Fbar"},
+		{"percent", "foo%bar", "foo%25bar"},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			assert.Equal(t, tt.want, rawurlencode(tt.in))
+		})
+	}
+}