SendChat and SendChatTo

Initial implementation of the `net.*` namespace with the:
- `send_chat_to`
- `send_chat`

`send_chat_to` does not implement the DCS API parameter of `fromPlayerId` due
to the social impact of a player being emulated is more severe than a breached system
and hence why the parameter has been redacted. If there is a valid use case, please
do feel free to present your use case and why alternatives do not meet the
user requirements. See PR #94

Added `net` as global read for lua linter

Author: justin-lovell

.luacheckrc

@@ -7,6 +7,7 @@ read_globals = {
   "AI",
   "atmosphere",
   "coalition",
+  "net",
   "coord",
   "DCS",
   "env",

CHANGELOG.md

@@ -5,6 +5,11 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Added
+- Generated scaffolding for the `net.*` scope into `NetService`
+- `SendChat` API
+- `SendChatTo` API
+
 ### Changed
 - Stream `PlayerSendChatEvent` to the `MissionService.StreamEvents` for clients to observe the chat as part of the event stream
 

lua/DCS-gRPC/grpc.lua

@@ -143,6 +143,7 @@ dofile(GRPC.luaPath .. [[methods\custom.lua]])
 dofile(GRPC.luaPath .. [[methods\group.lua]])
 dofile(GRPC.luaPath .. [[methods\hook.lua]])
 dofile(GRPC.luaPath .. [[methods\mission.lua]])
+dofile(GRPC.luaPath .. [[methods\net.lua]])
 dofile(GRPC.luaPath .. [[methods\timer.lua]])
 dofile(GRPC.luaPath .. [[methods\trigger.lua]])
 dofile(GRPC.luaPath .. [[methods\unit.lua]])

lua/DCS-gRPC/methods/net.lua

@@ -0,0 +1,22 @@
+--
+-- RPC net actions
+-- https://wiki.hoggitworld.com/view/DCS_singleton_net
+--
+
+GRPC.methods.sendChatTo = function(params)
+    -- note: it was explicitly decided not to place "from player id" parameter
+    --       due to the magnitude of a social attack vector.
+    --       https://github.com/DCS-gRPC/rust-server/pull/94#discussion_r780777794
+    net.send_chat_to(params.message, params.targetPlayerId)
+    return GRPC.success(nil)
+end
+
+GRPC.methods.sendChat = function(params)
+    if params.coalition > 1 then
+        return GRPC.errorInvalidArgument("Chat messages can only be sent to all or neutral/spectators")
+    end
+
+    local toAll = params.coalition ~= 1
+    net.send_chat(params.message, toAll)
+    return GRPC.success(nil)
+end

protos/dcs/dcs.proto

@@ -10,6 +10,7 @@ import "dcs/custom/v0/custom.proto";
 import "dcs/group/v0/group.proto";
 import "dcs/hook/v0/hook.proto";
 import "dcs/mission/v0/mission.proto";
+import "dcs/net/v0/net.proto";
 import "dcs/timer/v0/timer.proto";
 import "dcs/trigger/v0/trigger.proto";
 import "dcs/unit/v0/unit.proto";

protos/dcs/net/v0/net.proto

@@ -0,0 +1,29 @@
+syntax = "proto3";
+package dcs.net.v0;
+import "dcs/common/v0/common.proto";
+
+service NetService {
+  // https://wiki.hoggitworld.com/view/DCS_func_send_chat_to
+  rpc SendChatTo(SendChatToRequest) returns (SendChatToResponse) {}
+
+  // https://wiki.hoggitworld.com/view/DCS_func_send_chat
+  rpc SendChat(SendChatRequest) returns (SendChatResponse) {}
+}
+
+message SendChatToRequest {
+  // the message to send in the chat
+  string message = 1;
+  // the target player of the direct message
+  uint32 target_player_id = 2;
+}
+
+message SendChatToResponse {}
+
+message SendChatRequest {
+  // the message to send in the chat
+  string message = 1;
+  // which coalition? DCS only supports ALL or NEUTRAL (only applicable to send_chat)
+  dcs.common.v0.Coalition coalition = 2;
+}
+
+message SendChatResponse {}

src/rpc.rs

@@ -15,6 +15,7 @@ mod custom;
 mod group;
 mod hook;
 mod mission;
+mod net;
 mod timer;
 mod trigger;
 mod unit;

src/rpc/net.rs

@@ -0,0 +1,23 @@
+use super::MissionRpc;
+use stubs::net::v0::net_service_server::NetService;
+use stubs::*;
+use tonic::{Request, Response, Status};
+
+#[tonic::async_trait]
+impl NetService for MissionRpc {
+    async fn send_chat_to(
+        &self,
+        request: Request<net::v0::SendChatToRequest>,
+    ) -> Result<Response<net::v0::SendChatToResponse>, Status> {
+        self.notification("sendChatTo", request).await?;
+        Ok(Response::new(net::v0::SendChatToResponse {}))
+    }
+
+    async fn send_chat(
+        &self,
+        request: Request<net::v0::SendChatRequest>,
+    ) -> Result<Response<net::v0::SendChatResponse>, Status> {
+        self.notification("sendChat", request).await?;
+        Ok(Response::new(net::v0::SendChatResponse {}))
+    }
+}

src/services.rs

@@ -6,6 +6,7 @@ use stubs::custom::v0::custom_service_server::CustomServiceServer;
 use stubs::group::v0::group_service_server::GroupServiceServer;
 use stubs::hook::v0::hook_service_server::HookServiceServer;
 use stubs::mission::v0::mission_service_server::MissionServiceServer;
+use stubs::net::v0::net_service_server::NetServiceServer;
 use stubs::timer::v0::timer_service_server::TimerServiceServer;
 use stubs::trigger::v0::trigger_service_server::TriggerServiceServer;
 use stubs::unit::v0::unit_service_server::UnitServiceServer;
@@ -36,6 +37,7 @@ pub struct DcsServices {
     group: GroupServiceServer<MissionRpc>,
     hook: HookServiceServer<HookRpc>,
     mission: MissionServiceServer<MissionRpc>,
+    net: NetServiceServer<MissionRpc>,
     timer: TimerServiceServer<MissionRpc>,
     trigger: TriggerServiceServer<MissionRpc>,
     unit: UnitServiceServer<MissionRpc>,
@@ -52,6 +54,7 @@ impl DcsServices {
             group: GroupServiceServer::new(mission_rpc.clone()),
             hook: HookServiceServer::new(hook_rpc),
             mission: MissionServiceServer::new(mission_rpc.clone()),
+            net: NetServiceServer::new(mission_rpc.clone()),
             timer: TimerServiceServer::new(mission_rpc.clone()),
             trigger: TriggerServiceServer::new(mission_rpc.clone()),
             unit: UnitServiceServer::new(mission_rpc.clone()),
@@ -93,6 +96,8 @@ impl Service<http::Request<transport::Body>> for DcsServices {
             self.hook.call(req)
         } else if path.starts_with(MissionServiceServer::<MissionRpc>::NAME) {
             self.mission.call(req)
+        } else if path.starts_with(NetServiceServer::<MissionRpc>::NAME) {
+            self.net.call(req)
         } else if path.starts_with(TimerServiceServer::<MissionRpc>::NAME) {
             self.timer.call(req)
         } else if path.starts_with(TriggerServiceServer::<MissionRpc>::NAME) {

stubs/src/lib.rs

@@ -46,6 +46,12 @@ pub mod mission {
     }
 }
 
+pub mod net {
+    pub mod v0 {
+        tonic::include_proto!("dcs.net.v0");
+    }
+}
+
 pub mod timer {
     pub mod v0 {
         tonic::include_proto!("dcs.timer.v0");