0.2.8 fix; added SCORCO capability

Author: scottmunday84

.idea/modules.xml

@@ -108,7 +108,7 @@ Once you have installed your requirements, building your protobufs are easy. For
 bash CLI command will develop your Go files.
 
 ```bash
-protoc 
+protoc \
   --go_out=../some_go_project/proto \
   --go-grpc_out=./some_go_project/proto \ 
   --go_opt=paths=source_relative \

.idea/nwnx4-plugins-xp_rpc.iml .idea/nwnx4-plugin-rpc.iml.idea/nwnx4-plugins-xp_rpc.iml renamed to .idea/nwnx4-plugin-rpc.iml

@@ -1,8 +1,8 @@
 syntax = 'proto3';
 
-import "include/types.proto";
+import "nwscript/types.proto";
 
-option go_package = "src/proto/include";
+option go_package = "src/proto/nwscript";
 
 package NWNX4.RPC.Proto.NWScript;
 

README.md

@@ -1,6 +1,6 @@
 syntax = 'proto3';
 
-option go_package = "src/proto/include";
+option go_package = "src/proto/nwscript";
 
 package NWNX4.RPC.Proto.NWScript;
 

proto/nwscript/nwnx.proto

@@ -0,0 +1,34 @@
+syntax = 'proto3';
+
+option go_package = "src/proto";
+
+package NWNX4.RPC.Proto.SCORCO;
+
+service SCORCOService {
+  rpc SCORCOGetGFFSize(SCORCOGetGFFSizeRequest) returns (SCORCOGetGFFSizeResponse);
+  rpc SCORCOGetGFF(SCORCOGetGFFRequest) returns (SCORCOGetGFFResponse);
+  rpc SCORCOSetGFF(SCORCOSetGFFRequest) returns (SCORCOSetGFFResponse);
+}
+
+message SCORCOGetGFFSizeRequest {
+  string sVarName = 1;
+}
+
+message SCORCOGetGFFSizeResponse {
+  uint32 size = 1;
+}
+
+message SCORCOGetGFFRequest {
+  string sVarName = 1;
+}
+
+message SCORCOGetGFFResponse {
+  bytes gffData = 1;
+}
+
+message SCORCOSetGFFRequest {
+  string sVarName = 1;
+  bytes gffData = 2;
+}
+
+message SCORCOSetGFFResponse {}

proto/nwscript/types.proto

@@ -8,17 +8,17 @@ replace nwnx4.org/src/proto/nwscript => ./proto/nwscript
 
 require (
 	github.com/sirupsen/logrus v1.8.1
-	google.golang.org/grpc v1.44.0
-	google.golang.org/protobuf v1.27.1
+	google.golang.org/grpc v1.48.0
+	google.golang.org/protobuf v1.28.0
 	gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b
 	nwnx4.org/src/proto v0.0.0-00010101000000-000000000000
 	nwnx4.org/src/proto/nwscript v0.0.0-00010101000000-000000000000
 )
 
 require (
 	github.com/golang/protobuf v1.5.2 // indirect
-	golang.org/x/net v0.0.0-20200822124328-c89045814202 // indirect
-	golang.org/x/sys v0.0.0-20200323222414-85ca7c5b95cd // indirect
-	golang.org/x/text v0.3.0 // indirect
+	golang.org/x/net v0.0.0-20201021035429-f5854403a974 // indirect
+	golang.org/x/sys v0.0.0-20210119212857-b64e53b001e4 // indirect
+	golang.org/x/text v0.3.3 // indirect
 	google.golang.org/genproto v0.0.0-20200526211855-cb27e3aa2013 // indirect
 )

proto/scorco.proto

@@ -10,6 +10,7 @@ github.com/cncf/udpa/go v0.0.0-20201120205902-5459f2c99403/go.mod h1:WmhPx2Nbnht
 github.com/cncf/udpa/go v0.0.0-20210930031921-04548b0d99d4/go.mod h1:6pvJx4me5XPnfI9Z40ddWsdw2W/uZgQLFXToKeRcDiI=
 github.com/cncf/xds/go v0.0.0-20210805033703-aa0b78936158/go.mod h1:eXthEFrGJvWHgFFCl3hGmgk+/aYT6PnTQLykKQRLhEs=
 github.com/cncf/xds/go v0.0.0-20210922020428-25de7278fc84/go.mod h1:eXthEFrGJvWHgFFCl3hGmgk+/aYT6PnTQLykKQRLhEs=
+github.com/cncf/xds/go v0.0.0-20211001041855-01bcc9b48dfe/go.mod h1:eXthEFrGJvWHgFFCl3hGmgk+/aYT6PnTQLykKQRLhEs=
 github.com/cncf/xds/go v0.0.0-20211011173535-cb28da3451f1/go.mod h1:eXthEFrGJvWHgFFCl3hGmgk+/aYT6PnTQLykKQRLhEs=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
@@ -19,6 +20,7 @@ github.com/envoyproxy/go-control-plane v0.9.1-0.20191026205805-5f8ba28d4473/go.m
 github.com/envoyproxy/go-control-plane v0.9.4/go.mod h1:6rpuAdCZL397s3pYoYcLgu1mIlRU8Am5FuJP05cCM98=
 github.com/envoyproxy/go-control-plane v0.9.9-0.20201210154907-fd9021fe5dad/go.mod h1:cXg6YxExXjJnVBQHBLXeUAgxn2UodCpnH306RInaBQk=
 github.com/envoyproxy/go-control-plane v0.9.10-0.20210907150352-cf90f659a021/go.mod h1:AFq3mo9L8Lqqiid3OhADV3RfLJnjiw63cSpi+fDTRC0=
+github.com/envoyproxy/go-control-plane v0.10.2-0.20220325020618-49ff273808a1/go.mod h1:KJwIaB5Mv44NWtYuAOFCVOjcI94vtpEz2JU/D2v6IjE=
 github.com/envoyproxy/protoc-gen-validate v0.1.0/go.mod h1:iSmxcyjqTsJpI2R4NaDN7+kN2VEUnK/pcBlmesArF7c=
 github.com/ghodss/yaml v1.0.0/go.mod h1:4dBDuWmgqj2HViK6kFavaiC9ZROes6MMH2rRYeMEF04=
 github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b/go.mod h1:SBH7ygxi8pfUlaOkMMuAQtPIUF8ecWP5IEl/CR7VP2Q=
@@ -44,6 +46,8 @@ github.com/google/go-cmp v0.4.0/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/
 github.com/google/go-cmp v0.5.0/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
 github.com/google/go-cmp v0.5.5 h1:Khx7svrCpmxxtHBq5j2mp/xVjsi8hQMfNLvJFAlrGgU=
 github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
+github.com/google/go-cmp v0.5.6 h1:BKbKCqvP6I+rmFHt06ZmyQtvB8xAkWdhFyr0ZUNZcxQ=
+github.com/google/go-cmp v0.5.6/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
 github.com/google/uuid v1.1.2/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/grpc-ecosystem/grpc-gateway v1.16.0/go.mod h1:BDjrQk3hbvj6Nolgz8mAMFbcEtjT1g+wF4CSlocrBnw=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
@@ -72,6 +76,8 @@ golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn
 golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
 golang.org/x/net v0.0.0-20200822124328-c89045814202 h1:VvcQYSHwXgi7W+TpUR6A9g6Up98WAHf3f/ulnJ62IyA=
 golang.org/x/net v0.0.0-20200822124328-c89045814202/go.mod h1:/O7V0waA8r7cgGh81Ro3o1hOxt32SMVPicZroKQ2sZA=
+golang.org/x/net v0.0.0-20201021035429-f5854403a974 h1:IX6qOQeG5uLjB/hjjwjedwfjND0hgjPMMyO1RoIXQNI=
+golang.org/x/net v0.0.0-20201021035429-f5854403a974/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU=
 golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U=
 golang.org/x/oauth2 v0.0.0-20200107190931-bf48bf16ab8d/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw=
 golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
@@ -84,8 +90,14 @@ golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7w
 golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20200323222414-85ca7c5b95cd h1:xhmwyvizuTgC2qz7ZlMluP20uW+C3Rm0FD/WLDX8884=
 golang.org/x/sys v0.0.0-20200323222414-85ca7c5b95cd/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20200930185726-fdedc70b468f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20210119212857-b64e53b001e4 h1:myAQVi0cGEoqQVR5POX+8RR2mrocKqNN1hmeMqhX27k=
+golang.org/x/sys v0.0.0-20210119212857-b64e53b001e4/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/text v0.3.0 h1:g61tztE5qeGQ89tm6NTjjM9VPIm088od1l6aSorWRWg=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
+golang.org/x/text v0.3.3 h1:cokOdA+Jmi5PJGXLlLllQSgYigAEfHXJAERHVMaCc2k=
+golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
+golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
 golang.org/x/tools v0.0.0-20190114222345-bf090417da8b/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
 golang.org/x/tools v0.0.0-20190226205152-f727befe758c/go.mod h1:9Yl7xja0Znq3iFh3HoIrodX9oNMXvdceNzlUR8zjMvY=
 golang.org/x/tools v0.0.0-20190311212946-11955173bddd/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs=
@@ -108,6 +120,8 @@ google.golang.org/grpc v1.33.1/go.mod h1:fr5YgcSWrqhRRxogOsw7RzIpsmvOZ6IcH4kBYTp
 google.golang.org/grpc v1.36.0/go.mod h1:qjiiYl8FncCW8feJPdyg3v6XW24KsRHe+dy9BAGRRjU=
 google.golang.org/grpc v1.44.0 h1:weqSxi/TMs1SqFRMHCtBgXRs8k3X39QIDEZ0pRcttUg=
 google.golang.org/grpc v1.44.0/go.mod h1:k+4IHHFw41K8+bbowsex27ge2rCb65oeWqe4jJ590SU=
+google.golang.org/grpc v1.48.0 h1:rQOsyJ/8+ufEDJd/Gdsz7HG220Mh9HAhFHRGnIjda0w=
+google.golang.org/grpc v1.48.0/go.mod h1:vN9eftEi1UMyUsIF80+uQXhHjbXYbm0uXoFCACuMGWk=
 google.golang.org/protobuf v0.0.0-20200109180630-ec00e32a8dfd/go.mod h1:DFci5gLYBciE7Vtevhsrf46CRTquxDuWsQurQQe4oz8=
 google.golang.org/protobuf v0.0.0-20200221191635-4d8936d0db64/go.mod h1:kwYJMbMJ01Woi6D6+Kah6886xMZcty6N08ah7+eCXa0=
 google.golang.org/protobuf v0.0.0-20200228230310-ab0ca4ff8a60/go.mod h1:cfTl7dwQJ+fmap5saPgwCLgHXTUD7jkjRqWcaiX5VyM=
@@ -121,6 +135,8 @@ google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp0
 google.golang.org/protobuf v1.26.0/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc=
 google.golang.org/protobuf v1.27.1 h1:SnqbnDw1V7RiZcXPx5MEeqPv2s79L9i7BJUlG/+RurQ=
 google.golang.org/protobuf v1.27.1/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc=
+google.golang.org/protobuf v1.28.0 h1:w43yiav+6bVFTBQFZX0r7ipe9JQ1QsbMgHwbBziscLw=
+google.golang.org/protobuf v1.28.0/go.mod h1:HV8QOd/L58Z+nl8r43ehVNZIU/HEI6OcFqwMG9pJV4I=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=

src/go.mod

@@ -31,14 +31,15 @@ import (
 	"path"
 	"reflect"
 	"time"
+	"unsafe"
 
 	// Protobuf
 	pbCore "nwnx4.org/src/proto"
 	pbNWScript "nwnx4.org/src/proto/nwscript"
 )
 
 const pluginName string = "NWNX RPC Plugin" // Plugin name passed to hook
-const pluginVersion string = "0.2.7"        // Plugin version passed to hook
+const pluginVersion string = "0.2.8"        // Plugin version passed to hook
 const pluginID string = "RPC"               // Plugin ID used for identification in the list
 
 // YAML configuration for src
@@ -55,13 +56,15 @@ type ServerConfig struct {
 
 // YAML server services configuration for src
 type ServerServicesConfig struct {
-	Logger bool
+	Logger           bool
+	ScorcoClientName string
 }
 
 // Core plugin class; singleton per DLL
 type rpcPlugin struct {
-	rpcServer  *rpcServer
-	rpcClients map[string]rpcClient
+	rpcServer        *rpcServer
+	rpcClients       map[string]rpcClient
+	scorcoClientName string
 }
 
 // initRpcServer initializes the RPC server
@@ -118,6 +121,7 @@ func (p *rpcPlugin) addRpcClient(name, url string) {
 		name:                 name,
 		url:                  url,
 		nwnxServiceClient:    pbNWScript.NewNWNXServiceClient(conn),
+		scorcoServiceClient:  pbCore.NewSCORCOServiceClient(conn),
 		messageServiceClient: pbCore.NewMessageServiceClient(conn),
 	}
 
@@ -294,6 +298,72 @@ func (p *rpcPlugin) setString(sFunction, sParam1 *C.char, nParam2 C.int, sValue
 	}
 }
 
+func (p *rpcPlugin) getGffSize(sVarName *C.char) C.size_t {
+	sVarName_ := C.GoString(sVarName)
+	client, ok := p.getRpcClient(p.scorcoClientName)
+	if !ok {
+		return 0
+	}
+
+	ctx, cancel := context.WithTimeout(context.Background(), time.Second*30)
+	defer cancel()
+	request := pbCore.SCORCOGetGFFSizeRequest{
+		SVarName: sVarName_,
+	}
+	response, err := client.scorcoServiceClient.SCORCOGetGFFSize(ctx, &request)
+	if err != nil {
+		log.Error(fmt.Sprintf("Call to GetGFFSize returned error: %s; %s",
+			err, request.SVarName))
+
+		return 0
+	}
+
+	return C.size_t(response.Size)
+}
+
+func (p *rpcPlugin) getGff(sVarName *C.char, result *C.uint8_t, resultSize C.size_t) {
+	sVarName_ := C.GoString(sVarName)
+	client, ok := p.getRpcClient(p.scorcoClientName)
+	if !ok {
+		return
+	}
+
+	ctx, cancel := context.WithTimeout(context.Background(), time.Second*30)
+	defer cancel()
+	request := pbCore.SCORCOGetGFFRequest{
+		SVarName: sVarName_,
+	}
+	response, err := client.scorcoServiceClient.SCORCOGetGFF(ctx, &request)
+	if err != nil {
+		log.Error(fmt.Sprintf("Call to GetGFF returned error: %s; %s",
+			err, request.SVarName))
+
+		return
+	}
+
+	C.memcpy(unsafe.Pointer(result), unsafe.Pointer(&response.GffData[0]), resultSize)
+}
+
+func (p *rpcPlugin) setGff(sVarName *C.char, gffData *C.uint8_t, _ C.size_t) {
+	sVarName_ := C.GoString(sVarName)
+	gffData_ := *(*[]byte)(unsafe.Pointer(gffData))
+	client, ok := p.getRpcClient(p.scorcoClientName)
+	if !ok {
+		return
+	}
+
+	ctx, cancel := context.WithTimeout(context.Background(), time.Second*30)
+	defer cancel()
+	var request = pbCore.SCORCOSetGFFRequest{
+		SVarName: sVarName_,
+		GffData:  gffData_,
+	}
+	if _, err := client.scorcoServiceClient.SCORCOSetGFF(ctx, &request); err != nil {
+		log.Error(fmt.Sprintf("Call to SetGFF returned error: %s; %s",
+			err, request.SVarName))
+	}
+}
+
 // rpcServer contains the interfaces to the RPC server
 type rpcServer struct {
 	pbCore.UnimplementedLogServiceServer
@@ -346,14 +416,16 @@ type rpcClient struct {
 	name                 string
 	url                  string
 	nwnxServiceClient    pbNWScript.NWNXServiceClient
+	scorcoServiceClient  pbCore.SCORCOServiceClient
 	messageServiceClient pbCore.MessageServiceClient
 }
 
 // newRpcPlugin builds and returns a new RPC plugin
 func newRpcPlugin() *rpcPlugin {
 	return &rpcPlugin{
-		rpcServer:  nil,
-		rpcClients: make(map[string]rpcClient),
+		rpcServer:        nil,
+		rpcClients:       make(map[string]rpcClient),
+		scorcoClientName: "",
 	}
 }
 
@@ -417,6 +489,7 @@ func NWNXCPlugin_New(initInfo C.CPluginInitInfo) C.uint32_t {
 
 	// Initialize the server
 	plugin.initRpcServer(config.Server)
+	plugin.scorcoClientName = config.Server.Services.ScorcoClientName
 
 	// Build out the clients
 	for name, url := range config.Clients {
@@ -464,4 +537,19 @@ func NWNXCPlugin_SetString(_ *C.void, sFunction, sParam1 *C.char, nParam2 C.int,
 	plugin.setString(sFunction, sParam1, nParam2, sValue)
 }
 
+//export NWNXCPlugin_GetGFFSize
+func NWNXCPlugin_GetGFFSize(_ *C.void, sVarName *C.char) C.size_t {
+	return plugin.getGffSize(sVarName)
+}
+
+//export NWNXCPlugin_GetGFF
+func NWNXCPlugin_GetGFF(_ *C.void, sVarName *C.char, result *C.uint8_t, resultSize C.size_t) {
+	plugin.getGff(sVarName, result, resultSize)
+}
+
+//export NWNXCPlugin_SetGFF
+func NWNXCPlugin_SetGFF(_ *C.void, sVarName *C.char, gffData *C.uint8_t, gffDataSize C.size_t) {
+	plugin.setGff(sVarName, gffData, gffDataSize)
+}
+
 func main() {}