Added basic security. Module can now be limited ton accept commands from ESTATE_OWNER, ESTATE_MANAGER or list of UUIDs

Module/BirdsModule/FlockingModule.cs

@@ -78,6 +78,7 @@ namespace Flocking
         private int m_maxHeight;
         private Vector3 m_shoutPos = new Vector3(128f, 128f, 30f); 
         static object m_sync = new object();
+        private List<UUID> m_allowedControllers = new List<UUID>();
 
         public IConfigSource m_config;
 
@@ -133,25 +134,60 @@ namespace Flocking
 
             if (m_startup)
             {
+                m_scene = scene;
                 m_enabled = cnf.GetBoolean("BirdsEnabled", false);
                 m_chatChannel = cnf.GetInt("BirdsChatChannel", 118);
                 m_birdPrim = cnf.GetString("BirdsPrim", "birdPrim");
-                m_flockSize = cnf.GetInt("BirdsFlockSize", 50);
+                m_flockSize = cnf.GetInt("BirdsFlockSize", 20);
                 m_maxFlockSize = cnf.GetInt("BirdsMaxFlockSize", 100);
-                m_maxSpeed = cnf.GetFloat("BirdsMaxSpeed", 3f);
+                m_maxSpeed = cnf.GetFloat("BirdsMaxSpeed", 1.5f);
-                m_maxForce = cnf.GetFloat("BirdsMaxForce", 0.25f);
+                m_maxForce = cnf.GetFloat("BirdsMaxForce", 0.2f);
                 m_neighbourDistance = cnf.GetFloat("BirdsNeighbourDistance", 25f);
-                m_desiredSeparation = cnf.GetFloat("BirdsDesiredSeparation", 20f);
+                m_desiredSeparation = cnf.GetFloat("BirdsDesiredSeparation", 10f);
                 m_tolerance = cnf.GetFloat("BirdsTolerance", 5f);
                 m_borderSize = cnf.GetFloat("BirdsRegionBorderSize", 5f);
-                m_maxHeight = cnf.GetInt("BirdsMaxHeight", 256);
+                m_maxHeight = cnf.GetInt("BirdsMaxHeight", 75);
                 m_frameUpdateRate = cnf.GetInt("BirdsUpdateEveryNFrames", 1);
 
-                m_log.InfoFormat("[{0}] Module is {1} listening for commands on channel {2} with Flock Size {3}", m_name, m_enabled?"enabled and":"disabled, but", m_chatChannel, m_flockSize);
+                string allowedControllers = cnf.GetString("BirdsAllowedControllers", UUID.Zero.ToString());
+                if (allowedControllers != UUID.Zero.ToString())
+                {
+                    string[] ac = allowedControllers.Split(new char[] { ',' });
+                    UUID acUUID;
+                    for (int i = 0; i < ac.Length; i++)
+                    {
+                        string value = ac[i].Trim();
+                        if (value == "ESTATE_OWNER")
+                        {
+                            UUID eoUUID = m_scene.RegionInfo.EstateSettings.EstateOwner;
+                            m_allowedControllers.Add(eoUUID);
+                            m_log.InfoFormat("[{0}] Added Estate Owner UUID: {1} to list of allowed users", m_name, eoUUID.ToString());
+                            continue;
+                        }
+                        if (value == "ESTATE_MANAGER")
+                        {
+                            foreach (UUID emUUID in m_scene.RegionInfo.EstateSettings.EstateManagers)
+                            {
+                                m_allowedControllers.Add(emUUID);
+                                m_log.InfoFormat("[{0}] Added Estate Manager UUID: {1} to list of allowed users", m_name, emUUID.ToString());
+                            }
+                            continue;
+                        }
+                        if (UUID.TryParse(ac[i].Trim(), out acUUID))
+                        {
+                            m_allowedControllers.Add(acUUID);
+                            m_log.InfoFormat("[{0}] Added UUID: {1} to list of allowed users", m_name, acUUID.ToString());
+                        }
+                    }
+                }
+                else
+                {
+                    m_log.InfoFormat("[{0}] No command security was defined in the config. Any user may possibly configure this module from a script!", m_name);
+                }
+
+                m_log.InfoFormat("[{0}] Module is {1} listening for commands on channel {2} with Flock Size {3}", m_name, m_enabled ? "enabled and" : "disabled, but still", m_chatChannel, m_flockSize);
 
-                m_scene = scene;
                 m_console = MainConsole.Instance;
-
                 //register commands with the scene
                 RegisterCommands();
 
@@ -171,6 +207,7 @@ namespace Flocking
                 FlockInitialise();
 
             }
+            else m_log.InfoFormat("[{0}] Module is disabled in Region {1}", m_name, scene.RegionInfo.RegionName);
 		}
 
 		public void RegionLoaded (Scene scene)
@@ -273,8 +310,9 @@ namespace Flocking
 		
 		protected void SimChatSent (Object x, OSChatMessage msg)
 		{
-			if (msg.Channel != m_chatChannel)
+			if (msg.Channel != m_chatChannel) return; // not for us
-				return; // not for us
+
+            if (m_allowedControllers.Count>0 & !m_allowedControllers.Contains(msg.SenderUUID)) return; // not for us
 
 			// try and parse a valid cmd from this msg
 			string cmd = msg.Message; //.ToLower ();

README.md

@@ -76,6 +76,9 @@ Here is an example config:
 	                             ;however this can be overridden to the name of an existing prim that
 	                             ;needs to already exist in the scene - i.e. be rezzed in the region.	
 
+         ;who is allowed to send commands via chat or script: list of UUIDs or ESTATE_OWNER or ESTATE_MANAGER
+         ;or everyone if not specified
+	 BirdsAllowedControllers = ESTATE_OWNER, ESTATE_MANAGER, 12345678-1234-1234-1234-123456789abc
 
 
 Various runtime commands control the flocking module behaviour - described below. These can either be invoked
@@ -114,6 +117,14 @@ These commands are great for playing with the flock dynamics in real time:
 Of course if distance is less than separation then the birds will never flock. The other way around and they will always
 eventually form one or more flocks.
 
+Security:
+
+By default anyone can send commands to the module from within a script or via the in-world chat on the 'BirdsChatChannel' channel.
+You should use a high negative value for channel if you want to allow script access, but not in-world chat. Further you can restrict
+which users are allowed to control the module using the 'BirdsAllowedControllers' setting. This is a comma separated list of user UUIDs,
+but it may also contain one of the pre-defined constants ESTATE_OWNER (evaluates to the UUID of the estate owner) and ESTATE_MANAGER 
+(evaluates to a list of estate manager UUIDS).
+
 Bird prims:
 
 Any currently rezzed in-scene-object can be used as the bird prim. However fps is very much affected by the

config/OpenSimBirds.ini.example

@@ -16,3 +16,7 @@
 	BirdsPrim = SeaGull1        ;By default the module will create a flock of plain wooden spheres, 
 				    ;however this can be overridden to the name of an existing prim that
 				    ;needs to already exist in the scene - i.e. be rezzed in the region.	
+        
+        ;who is allowed to send commands via chat or script: list of UUIDs or ESTATE_OWNER or ESTATE_MANAGER
+        ;or everyone if not specified
+	BirdsAllowedControllers = ESTATE_OWNER, ESTATE_MANAGER, 12345678-1234-1234-1234-123456789abc