feat(auth): show object perms in console and inspector

arenaxr · Oct 18, 2022 · f2d5a52 · f2d5a52
1 parent 18f75d4
commit f2d5a52
Show file tree

Hide file tree

Showing 10 changed files with 133 additions and 43 deletions.
diff --git a/Editor/ThirdParty/PrettyHierarchy/Runtime/PrettyObject.cs b/Editor/ThirdParty/PrettyHierarchy/Runtime/PrettyObject.cs
@@ -1,5 +1,6 @@
 // Modified from: https://github.com/NCEEGEE/PrettyHierarchy
 
+using System;
 using UnityEditor;
 using UnityEngine;
 
@@ -8,6 +9,23 @@ namespace PrettyHierarchy
     [DisallowMultipleComponent]
     public class PrettyObject : MonoBehaviour
     {
+        private bool hasPermissions;
+
+        private void updateText()
+        {
+            // for now, arena objects colored text consistently in Editor/ThirdParty/PrettyHierarchy/Editor/Utils/EditorColors.cs
+            if (EditorGUIUtility.isProSkin)
+                textColor = hasPermissions ? new Color32(0, 255, 0, 255) : new Color32(255, 165, 0, 255); // TODO dark theme=light green
+            else
+                textColor = hasPermissions ? new Color32(0, 128, 0, 255) : new Color32(255, 165, 0, 255); // TODO light theme=dark green
+#if UNITY_EDITOR
+
+            EditorApplication.RepaintHierarchyWindow();
+#endif
+        }
+
+        public bool HasPermissions { get { return hasPermissions; } set { hasPermissions = value; updateText(); } }
+
 #if UNITY_EDITOR
         //[Header("Background")]
         //[SerializeField]
@@ -41,15 +59,6 @@ public class PrettyObject : MonoBehaviour
         public TextAnchor Alignment { get { return alignment; } }
         public bool TextDropShadow { get { return textDropShadow; } }
 
-        private void Awake()
-        {
-            // for now, arena objects colored text consistently in Editor/ThirdParty/PrettyHierarchy/Editor/Utils/EditorColors.cs
-            // if (EditorGUIUtility.isProSkin)
-            //     textColor = new Color32(0, 255, 0, 255); //dark theme=light green
-            // else
-            //     textColor = new Color32(0, 128, 0, 255); //light theme=dark green
-        }
-
         private void OnValidate()
         {
             EditorApplication.RepaintHierarchyWindow();

diff --git a/Runtime/ArenaCamera.cs b/Runtime/ArenaCamera.cs
@@ -104,7 +104,7 @@ public bool PublishCreateUpdate()
             // publish
             msg.data = dataUnity;
             string payload = JsonConvert.SerializeObject(msg);
-            ArenaClientScene.Instance.PublishCamera(msg.object_id, payload);
+            ArenaClientScene.Instance.PublishCamera(msg.object_id, payload, HasPermissions);
             if (!created)
                 created = true;
 

diff --git a/Runtime/ArenaCameraEditor.cs b/Runtime/ArenaCameraEditor.cs
@@ -0,0 +1,41 @@
+/**
+ * Open source software under the terms in /LICENSE
+ * Copyright (c) 2021, The CONIX Research Center. All rights reserved.
+ */
+
+using UnityEditor;
+using UnityEngine;
+
+namespace ArenaUnity
+{
+#if UNITY_EDITOR
+    [CustomEditor(typeof(ArenaCamera))]
+    public class ArenaCameraEditor : Editor
+    {
+        public override void OnInspectorGUI()
+        {
+            ArenaCamera acobj = (ArenaCamera)target;
+
+            // edit authorization
+            GUILayout.BeginHorizontal("Box");
+            GUILayout.Label("Publish Permission:");
+            if (Application.isPlaying)
+            {
+                var authStyle = new GUIStyle(EditorStyles.label);
+                authStyle.normal.textColor = acobj.HasPermissions ? Color.green : (Color)new Color32(255, 165, 0, 255);
+                var authString = acobj.HasPermissions ? "A" : "Not a";
+                GUILayout.Label($"{authString}uthorized to publish changes", authStyle);
+            }
+            else
+            {
+                GUILayout.Label("Determined in playmode");
+            }
+            GUILayout.EndHorizontal();
+
+            GUI.enabled = !Application.isPlaying && acobj.HasPermissions;
+            DrawDefaultInspector();
+            GUI.enabled = true;
+        }
+    }
+#endif
+}
diff --git a/Runtime/ArenaCameraEditor.cs.meta b/Runtime/ArenaCameraEditor.cs.meta
diff --git a/Runtime/ArenaClientScene.cs b/Runtime/ArenaClientScene.cs
@@ -68,6 +68,8 @@ protected override void Awake()
         /// </summary>
         public string sceneUrl { get; private set; }
 
+        internal bool sceneObjectRights { get; private set; }
+
         private string sceneTopic = null;
         internal Dictionary<string, GameObject> arenaObjs = new Dictionary<string, GameObject>();
         internal Dictionary<string, GameObject> childObjs = new Dictionary<string, GameObject>();
@@ -171,7 +173,6 @@ public IEnumerator ConnectArena()
                 sceneTopic = $"{realm}/s/{namespaceName}/{sceneName}";
                 sceneUrl = $"https://{brokerAddress}/{namespaceName}/{sceneName}";
             }
-            bool sceneObjectRights = false;
             dynamic perms = JsonConvert.DeserializeObject(permissions);
             foreach (dynamic pubperm in perms.publ)
             {
@@ -184,18 +185,19 @@ public IEnumerator ConnectArena()
                 if ((cam.name == Camera.main.name || camlist.Length == 1) && !foundFirstCam)
                 {
                     // publish main/selected camera
+                    cam.HasPermissions = true; // TODO: client connection always gets at least one
                     cam.userid = userid;
                     cam.camid = camid;
                     foundFirstCam = true;
                 }
                 else
                 {
+                    cam.HasPermissions = sceneObjectRights;
                     // TODO: fix: other cameras are auto-generated, and account must have all scene rights
-                    // if (!sceneObjectRights)
-                    // {
-                    //     LogAndExit($"Using more than one ArenaCamera requires full scene permissions. Login with an Editor or Owner account with write permissions for this scene.");
-                    //     yield break;
-                    // }
+                    if (!sceneObjectRights)
+                    {
+                        Debug.LogWarning($"Using more than one ArenaCamera requires full scene permissions. Only one camera will be published.");
+                    }
                     var random = UnityEngine.Random.Range(0, 100000000);
                     cam.userid = $"{random:D8}_unity";
                     cam.camid = $"camera_{random:D8}_unity";
@@ -258,7 +260,7 @@ protected override void Update()
                             persist = true,
                         };
                         string payload = JsonConvert.SerializeObject(msg);
-                        PublishObject(msg.object_id, payload);
+                        PublishObject(msg.object_id, payload, sceneObjectRights);
                     }
                 }
 #endif
@@ -801,42 +803,42 @@ private IEnumerator HttpRequestRaw(string url)
         /// <summary>
         /// Object changes are published using a ClientId + ObjectId topic, a user must have permissions for the entire scene graph.
         /// </summary>
-        public void PublishObject(string object_id, string msgJson)
+        public void PublishObject(string object_id, string msgJson, bool hasPermissions = true)
         {
             dynamic msg = JsonConvert.DeserializeObject(msgJson);
             msg.timestamp = GetTimestamp();
-            PublishSceneMessage($"{sceneTopic}/{client.ClientId}/{object_id}", JsonConvert.SerializeObject(msg));
+            PublishSceneMessage($"{sceneTopic}/{client.ClientId}/{object_id}", JsonConvert.SerializeObject(msg), hasPermissions);
         }
 
         /// <summary>
         /// Camera presence changes are published using a ObjectId-only topic, a user might only have permissions for their camid.
         /// </summary>
-        public void PublishCamera(string object_id, string msgJson)
+        public void PublishCamera(string object_id, string msgJson, bool hasPermissions = true)
         {
             dynamic msg = JsonConvert.DeserializeObject(msgJson);
             msg.timestamp = GetTimestamp();
-            PublishSceneMessage($"{sceneTopic}/{object_id}", JsonConvert.SerializeObject(msg));
+            PublishSceneMessage($"{sceneTopic}/{object_id}", JsonConvert.SerializeObject(msg), hasPermissions);
         }
 
         /// <summary>
         /// Camera events are published using a ObjectId-only topic, a user might only have permissions for their camid.
         /// </summary>
-        public void PublishEvent(string object_id, string eventType, string msgJsonData)
+        public void PublishEvent(string object_id, string eventType, string msgJsonData, bool hasPermissions = true)
         {
             dynamic msg = new ExpandoObject();
             msg.object_id = camid;
             msg.action = "clientEvent";
             msg.type = eventType;
             msg.data = JsonConvert.DeserializeObject(msgJsonData);
             msg.timestamp = GetTimestamp();
-            PublishSceneMessage($"{sceneTopic}/{object_id}", JsonConvert.SerializeObject(msg));
+            PublishSceneMessage($"{sceneTopic}/{object_id}", JsonConvert.SerializeObject(msg), hasPermissions);
         }
 
-        private void PublishSceneMessage(string topic, string msg)
+        private void PublishSceneMessage(string topic, string msg, bool hasPermissions)
         {
             byte[] payload = System.Text.Encoding.UTF8.GetBytes(msg);
             Publish(topic, payload);
-            LogMessage("Sent", JsonConvert.DeserializeObject(msg));
+            LogMessage("Sending", JsonConvert.DeserializeObject(msg), hasPermissions);
         }
 
         private static string GetTimestamp()
@@ -918,7 +920,7 @@ private IEnumerator ProcessArenaMessage(dynamic msg, object menuCommand = null)
             }
         }
 
-        private void LogMessage(string dir, dynamic msg)
+        private void LogMessage(string dir, dynamic msg, bool hasPermissions = true)
         {
             // determine logging level
             if (!Convert.ToBoolean(msg.persist) && !logMqttNonPersist) return;
@@ -928,7 +930,10 @@ private void LogMessage(string dir, dynamic msg)
                 if (!logMqttObjects) return;
             }
             if (msg.action == "clientEvent" && !logMqttEvents) return;
-            Debug.Log($"{dir}: {JsonConvert.SerializeObject(msg)}");
+            if (hasPermissions)
+                Debug.Log($"{dir}: {JsonConvert.SerializeObject(msg)}");
+            else
+                Debug.LogWarning($"Permissions FAILED {dir}: {JsonConvert.SerializeObject(msg)}");
         }
 
         protected override void OnApplicationQuit()
@@ -942,7 +947,7 @@ protected override void OnApplicationQuit()
                     action = "delete",
                 };
                 string delCamMsg = JsonConvert.SerializeObject(msg);
-                PublishCamera(camid, delCamMsg);
+                PublishCamera(camid, delCamMsg, sceneObjectRights);
             }
             base.OnApplicationQuit();
         }

diff --git a/Runtime/ArenaMenu.cs b/Runtime/ArenaMenu.cs
@@ -143,7 +143,8 @@ private static void PublishPrimitive(MenuCommand menuCommand, string object_type
             Vector3 cameraPoint = cam.transform.position + cam.transform.forward * distance;
 
             dynamic msg = new ExpandoObject();
-            if (ArenaClientScene.Instance.arenaObjs.ContainsKey(object_id))
+            var client = ArenaClientScene.Instance;
+            if (client.arenaObjs.ContainsKey(object_id))
                 object_id = $"{object_id}-{UnityEngine.Random.Range(0, 1000000)}";
             msg.object_id = object_id;
             msg.action = "create";
@@ -158,8 +159,8 @@ private static void PublishPrimitive(MenuCommand menuCommand, string object_type
             data.material = material;
             msg.data = data;
             string payload = JsonConvert.SerializeObject(msg);
-            ArenaClientScene.Instance.PublishObject(msg.object_id, payload); // remote
-            ArenaClientScene.Instance.ProcessMessage(payload, menuCommand); // local
+            client.PublishObject(msg.object_id, payload, client.sceneObjectRights); // remote
+            client.ProcessMessage(payload, menuCommand); // local
         }
 #endif
     }

diff --git a/Runtime/ArenaMqttClient.cs b/Runtime/ArenaMqttClient.cs
@@ -137,17 +137,17 @@ protected override void DecodeMessage(string topic, byte[] message)
 
         public void Publish(string topic, byte[] payload)
         {
-            client.Publish(topic, payload);
+            if (client != null) client.Publish(topic, payload);
         }
 
         public void Subscribe(string[] topics)
         {
-            client.Subscribe(topics, new byte[] { MqttMsgBase.QOS_LEVEL_AT_MOST_ONCE });
+            if (client != null) client.Subscribe(topics, new byte[] { MqttMsgBase.QOS_LEVEL_AT_MOST_ONCE });
         }
 
         public void Unsubscribe(string[] topics)
         {
-            client.Unsubscribe(topics);
+            if (client != null) client.Unsubscribe(topics);
         }
 
         protected void OnDestroy()

diff --git a/Runtime/ArenaObject.cs b/Runtime/ArenaObject.cs
@@ -52,6 +52,8 @@ public void OnEnable()
 
         void Start()
         {
+            // TODO: consider how inactive objects react to find here, might need to use arenaObjs array
+
             // runtime created arena objects still need to be checked for name uniqueness
             bool found = false;
             foreach (var aobj in FindObjectsOfType<ArenaObject>())
@@ -84,6 +86,9 @@ void Update()
             if (!ArenaClientScene.Instance || ArenaClientScene.Instance.transformPublishInterval == 0 ||
             Time.frameCount % ArenaClientScene.Instance.transformPublishInterval != 0)
                 return;
+
+            HasPermissions = ArenaClientScene.Instance.sceneObjectRights;
+
             if (transform.hasChanged || meshChanged)
             {
                 //TODO: prevent child objects of parent.transform.hasChanged = true from publishing unnecessarily
@@ -113,7 +118,7 @@ private void HandleRename()
                 persist = persist,
             };
             string payload = JsonConvert.SerializeObject(msg);
-            ArenaClientScene.Instance.PublishObject(msg.object_id, payload);
+            ArenaClientScene.Instance.PublishObject(msg.object_id, payload, HasPermissions);
             // add new object with new name, it pubs
             created = false;
             transform.hasChanged = true;
@@ -193,7 +198,7 @@ public bool PublishCreateUpdate(bool transformOnly = false)
             msg.data = transformOnly ? dataUnity : updatedData;
             jsonData = JsonConvert.SerializeObject(updatedData, Formatting.Indented);
             string payload = JsonConvert.SerializeObject(msg);
-            ArenaClientScene.Instance.PublishObject(msg.object_id, payload);
+            ArenaClientScene.Instance.PublishObject(msg.object_id, payload, HasPermissions);
             if (!created)
                 created = true;
 
@@ -209,7 +214,7 @@ internal void PublishJson()
             msg.persist = persist;
             msg.data = JsonConvert.DeserializeObject(jsonData);
             string payload = JsonConvert.SerializeObject(msg);
-            ArenaClientScene.Instance.PublishObject(msg.object_id, payload); // remote
+            ArenaClientScene.Instance.PublishObject(msg.object_id, payload, HasPermissions); // remote
             ArenaClientScene.Instance.ProcessMessage(payload); // local
         }
 

diff --git a/Runtime/ArenaObjectAddUrlWindow.cs b/Runtime/ArenaObjectAddUrlWindow.cs
@@ -45,7 +45,8 @@ protected void OnGUI()
                 Vector3 cameraPoint = cam.transform.position + cam.transform.forward * distance;
 
                 dynamic msg = new ExpandoObject();
-                if (ArenaClientScene.Instance.arenaObjs.ContainsKey(object_id))
+                var client = ArenaClientScene.Instance;
+                if (client.arenaObjs.ContainsKey(object_id))
                     object_id = $"{object_id}-{UnityEngine.Random.Range(0, 1000000)}";
                 msg.object_id = object_id;
                 msg.action = "create";
@@ -59,8 +60,8 @@ protected void OnGUI()
                 data.position = ArenaUnity.ToArenaPosition(cameraPoint);
                 msg.data = data;
                 string payload = JsonConvert.SerializeObject(msg);
-                ArenaClientScene.Instance.PublishObject(msg.object_id, payload); // remote
-                ArenaClientScene.Instance.ProcessMessage(payload, menuCommand); // local
+                client.PublishObject(msg.object_id, payload, client.sceneObjectRights); // remote
+                client.ProcessMessage(payload, menuCommand); // local
                 Close();
             }
 

diff --git a/Runtime/ArenaObjectEditor.cs b/Runtime/ArenaObjectEditor.cs
@@ -3,7 +3,6 @@
  * Copyright (c) 2021, The CONIX Research Center. All rights reserved.
  */
 
-using System;
 using UnityEditor;
 using UnityEngine;
 
@@ -18,17 +17,35 @@ public override void OnInspectorGUI()
             ArenaObject aobj = (ArenaObject)target;
 
             // add button to publish unity changes
-            GUI.enabled = aobj.messageType == "object";
+            GUI.enabled = aobj.HasPermissions && aobj.messageType == "object";
             if (GUILayout.Button("Publish Unity Data"))
             {
                 aobj.PublishCreateUpdate();
             }
             GUI.enabled = true;
 
+            // edit authorization
+            GUILayout.BeginHorizontal("Box");
+            GUILayout.Label("Publish Permission:");
+            if (Application.isPlaying)
+            {
+                var authStyle = new GUIStyle(EditorStyles.label);
+                authStyle.normal.textColor = aobj.HasPermissions ? Color.green : (Color)new Color32(255, 165, 0, 255);
+                var authString = aobj.HasPermissions ? "A" : "Not a";
+                GUILayout.Label($"{authString}uthorized to publish changes", authStyle);
+            }
+            else
+            {
+                GUILayout.Label("Determined in playmode");
+            }
+            GUILayout.EndHorizontal();
+
+            GUI.enabled = !Application.isPlaying && aobj.HasPermissions;
             DrawDefaultInspector();
+            GUI.enabled = true;
 
             // add button to publish manual json data changes if valid
-            GUI.enabled = aobj.isJsonValidated;
+            GUI.enabled = aobj.HasPermissions && aobj.isJsonValidated;
             if (GUILayout.Button("Publish Json Data"))
             {
                 aobj.PublishJson();