Merge commit 'cmickeyb/dev-appearance'

2 files changed, 225 insertions, 84 deletions

diff --git a/OpenSim/Region/CoreModules/Avatar/Attachments/AttachmentsModule.cs b/OpenSim/Region/CoreModules/Avatar/Attachments/AttachmentsModule.cs
index ad6b1de..e89368a 100644
--- a/OpenSim/Region/CoreModules/Avatar/Attachments/AttachmentsModule.cs
+++ b/OpenSim/Region/CoreModules/Avatar/Attachments/AttachmentsModule.cs
@@ -123,15 +123,12 @@ namespace OpenSim.Region.CoreModules.Avatar.Attachments
                     m_scene.EventManager.TriggerOnAttach(objectLocalID, part.ParentGroup.GetFromItemID(), remoteClient.AgentId);
 
                     // Save avatar attachment information
-                    ScenePresence presence;
-                    if (m_scene.AvatarService != null && m_scene.TryGetScenePresence(remoteClient.AgentId, out presence))
-                    {
-                        m_log.Info(
-                            "[ATTACHMENTS MODULE]: Saving avatar attachment. AgentID: " + remoteClient.AgentId
-                                + ", AttachmentPoint: " + AttachmentPt);
+                    m_log.Info(
+                        "[ATTACHMENTS MODULE]: Saving avatar attachment. AgentID: " + remoteClient.AgentId
+                        + ", AttachmentPoint: " + AttachmentPt);
 
-                        m_scene.AvatarService.SetAppearance(remoteClient.AgentId, presence.Appearance);
-                    }
+                    if (m_scene.AvatarFactory != null)
+                        m_scene.AvatarFactory.QueueAppearanceSave(remoteClient.AgentId);
                 }
             }
             catch (Exception e)
@@ -382,8 +379,8 @@ namespace OpenSim.Region.CoreModules.Avatar.Attachments
                 item = m_scene.InventoryService.GetItem(item);
                 presence.Appearance.SetAttachment((int)AttachmentPt, itemID, item.AssetID /* att.UUID */);
 
-                if (m_scene.AvatarService != null)
-                    m_scene.AvatarService.SetAppearance(remoteClient.AgentId, presence.Appearance);
+                if (m_scene.AvatarFactory != null)
+                    m_scene.AvatarFactory.QueueAppearanceSave(remoteClient.AgentId);
             }
         }
 
@@ -405,11 +402,9 @@ namespace OpenSim.Region.CoreModules.Avatar.Attachments
                 presence.Appearance.DetachAttachment(itemID);
 
                 // Save avatar attachment information
-                if (m_scene.AvatarService != null)
-                {
-                    m_log.Debug("[ATTACHMENTS MODULE]: Detaching from UserID: " + remoteClient.AgentId + ", ItemID: " + itemID);
-                    m_scene.AvatarService.SetAppearance(remoteClient.AgentId, presence.Appearance);
-                }
+                m_log.Debug("[ATTACHMENTS MODULE]: Detaching from UserID: " + remoteClient.AgentId + ", ItemID: " + itemID);
+                if (m_scene.AvatarFactory != null)
+                    m_scene.AvatarFactory.QueueAppearanceSave(remoteClient.AgentId);
             }
 
             DetachSingleAttachmentToInv(itemID, remoteClient);
@@ -435,10 +430,9 @@ namespace OpenSim.Region.CoreModules.Avatar.Attachments
 
                 presence.Appearance.DetachAttachment(itemID);
 
-                if (m_scene.AvatarService != null)
-                {
-                    m_scene.AvatarService.SetAppearance(remoteClient.AgentId, presence.Appearance);
-                }
+                if (m_scene.AvatarFactory != null)
+                    m_scene.AvatarFactory.QueueAppearanceSave(remoteClient.AgentId);
+
                 part.ParentGroup.DetachToGround();
 
                 List<UUID> uuids = new List<UUID>();
diff --git a/OpenSim/Region/CoreModules/Avatar/AvatarFactory/AvatarFactoryModule.cs b/OpenSim/Region/CoreModules/Avatar/AvatarFactory/AvatarFactoryModule.cs
index 9f7ff7f..bfbbcf8 100644
--- a/OpenSim/Region/CoreModules/Avatar/AvatarFactory/AvatarFactoryModule.cs
+++ b/OpenSim/Region/CoreModules/Avatar/AvatarFactory/AvatarFactoryModule.cs
@@ -32,23 +32,45 @@ using Nini.Config;
 using OpenMetaverse;
 using OpenSim.Framework;
 
+using System.Threading;
+using System.Timers;
+using System.Collections.Generic;
+
 using OpenSim.Region.Framework.Interfaces;
 using OpenSim.Region.Framework.Scenes;
 using OpenSim.Services.Interfaces;
 
 namespace OpenSim.Region.CoreModules.Avatar.AvatarFactory
 {
-    public class AvatarFactoryModule : IRegionModule
+    public class AvatarFactoryModule : IAvatarFactory, IRegionModule
     {
         private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
-        private static readonly byte[] BAKE_INDICES = new byte[] { 8, 9, 10, 11, 19, 20 };
         private Scene m_scene = null;
 
-        private bool m_startAnimationSet = false;
+        private int m_savetime = 5; // seconds to wait before saving changed appearance
+        private int m_sendtime = 2; // seconds to wait before sending changed appearance
+
+        private int m_checkTime = 500; // milliseconds to wait between checks for appearance updates
+        private System.Timers.Timer m_updateTimer = new System.Timers.Timer();
+        private Dictionary<UUID,long> m_savequeue = new Dictionary<UUID,long>();
+        private Dictionary<UUID,long> m_sendqueue = new Dictionary<UUID,long>();
 
-        public void Initialise(Scene scene, IConfigSource source)
+        #region RegionModule Members
+
+        public void Initialise(Scene scene, IConfigSource config)
         {
+            scene.RegisterModuleInterface<IAvatarFactory>(this);
             scene.EventManager.OnNewClient += NewClient;
+             
+            if (config != null)
+            {
+                IConfig sconfig = config.Configs["Startup"];
+                if (sconfig != null)
+                {
+                    m_savetime = Convert.ToInt32(sconfig.GetString("DelayBeforeAppearanceSave",Convert.ToString(m_savetime)));
+                    m_sendtime = Convert.ToInt32(sconfig.GetString("DelayBeforeAppearanceSend",Convert.ToString(m_sendtime)));
+                }
+            }
 
             if (m_scene == null)
                 m_scene = scene;
@@ -56,6 +78,10 @@ namespace OpenSim.Region.CoreModules.Avatar.AvatarFactory
 
         public void PostInitialise()
         {
+            m_updateTimer.Enabled = false;
+            m_updateTimer.AutoReset = true;
+            m_updateTimer.Interval = m_checkTime; // 500 milliseconds wait to start async ops
+            m_updateTimer.Elapsed += new ElapsedEventHandler(HandleAppearanceUpdateTimer);
         }
 
         public void Close()
@@ -84,6 +110,36 @@ namespace OpenSim.Region.CoreModules.Avatar.AvatarFactory
             // client.OnAvatarNowWearing -= AvatarIsWearing;
         }
 
+        #endregion
+
+        public bool ValidateBakedTextureCache(IClientAPI client)
+        {
+            ScenePresence sp = m_scene.GetScenePresence(client.AgentId);
+            if (sp == null)
+            {
+                m_log.WarnFormat("[AVFACTORY] SetAppearance unable to find presence for {0}",client.AgentId);
+                return false;
+            }
+
+            bool cached = true;
+
+            // Process the texture entry
+            for (int i = 0; i < AvatarAppearance.BAKE_INDICES.Length; i++)
+            {
+                int idx = AvatarAppearance.BAKE_INDICES[i];
+                Primitive.TextureEntryFace face = sp.Appearance.Texture.FaceTextures[idx];
+                if (face != null && face.TextureID != AppearanceManager.DEFAULT_AVATAR_TEXTURE)
+                    if (! CheckBakedTextureAsset(client,face.TextureID,idx))
+                    {
+                        sp.Appearance.Texture.FaceTextures[idx] = null;
+                        cached = false;
+                    }
+            }
+
+            return cached;
+        }
+        
+
         /// <summary>
         /// Set appearance data (textureentry and slider settings) received from the client
         /// </summary>
@@ -91,6 +147,10 @@ namespace OpenSim.Region.CoreModules.Avatar.AvatarFactory
         /// <param name="visualParam"></param>
         public void SetAppearance(IClientAPI client, Primitive.TextureEntry textureEntry, byte[] visualParams)
         {
+// DEBUG ON
+            m_log.WarnFormat("[AVFACTORY] SetAppearance for {0}",client.AgentId);
+// DEBUG OFF
+
             ScenePresence sp = m_scene.GetScenePresence(client.AgentId);
             if (sp == null)
             {
@@ -98,85 +158,179 @@ namespace OpenSim.Region.CoreModules.Avatar.AvatarFactory
                 return;
             }
             
-// DEBUG ON
-            m_log.WarnFormat("[AVFACTORY] SetAppearance for {0}",client.AgentId);
-// DEBUG OFF
-
-/*
-            if (m_physicsActor != null)
-            {
-                if (!IsChildAgent)
-                {
-                    // This may seem like it's redundant, remove the avatar from the physics scene
-                    // just to add it back again, but it saves us from having to update
-                    // 3 variables 10 times a second.
-                    bool flyingTemp = m_physicsActor.Flying;
-                    RemoveFromPhysicalScene();
-                    //m_scene.PhysicsScene.RemoveAvatar(m_physicsActor);
-
-                    //PhysicsActor = null;
-
-                    AddToPhysicalScene(flyingTemp);
-                }
-            }
-*/
-            #region Bake Cache Check
-
             bool changed = false;
             
             // Process the texture entry
             if (textureEntry != null)
             {
-                for (int i = 0; i < BAKE_INDICES.Length; i++)
-                {
-                    int j = BAKE_INDICES[i];
-                    Primitive.TextureEntryFace face = textureEntry.FaceTextures[j];
+                changed = sp.Appearance.SetTextureEntries(textureEntry);
 
+                for (int i = 0; i < AvatarAppearance.BAKE_INDICES.Length; i++)
+                {
+                    int idx = AvatarAppearance.BAKE_INDICES[i];
+                    Primitive.TextureEntryFace face = sp.Appearance.Texture.FaceTextures[idx];
                     if (face != null && face.TextureID != AppearanceManager.DEFAULT_AVATAR_TEXTURE)
-                    {
-                        if (m_scene.AssetService.Get(face.TextureID.ToString()) == null)
-                        {
-                            m_log.WarnFormat("[AVFACTORY]: Missing baked texture {0} ({1}) for avatar {2}",face.TextureID,j,this.Name);
-                            client.SendRebakeAvatarTextures(face.TextureID);
-                        }
-                    }
+                        Util.FireAndForget(delegate(object o) {
+                                if (! CheckBakedTextureAsset(client,face.TextureID,idx))
+                                    client.SendRebakeAvatarTextures(face.TextureID);
+                            });
                 }
-                changed = sp.Appearance.SetTextureEntries(textureEntry);
-             
             }
             
-            #endregion Bake Cache Check
-                
-            changed = sp.Appearance.SetVisualParams(visualParams) || changed;
-
-            // If nothing changed (this happens frequently) just return
+            // Process the visual params, this may change height as well
+            if (visualParams != null)
+            {
+                if (sp.Appearance.SetVisualParams(visualParams))
+                {
+                    changed = true;
+                    if (sp.Appearance.AvatarHeight > 0)
+                        sp.SetHeight(sp.Appearance.AvatarHeight);
+                }
+            }
+            
+            // If something changed in the appearance then queue an appearance save
             if (changed)
+                QueueAppearanceSave(client.AgentId);
+
+            // And always queue up an appearance update to send out
+            QueueAppearanceSend(client.AgentId);
+            
+            // Send the appearance back to the avatar
+            // AvatarAppearance avp = sp.Appearance;
+            // sp.ControllingClient.SendAvatarDataImmediate(sp);
+            // sp.ControllingClient.SendAppearance(avp.Owner,avp.VisualParams,avp.Texture.GetBytes());
+        }
+
+        /// <summary>
+        /// Checks for the existance of a baked texture asset and
+        /// requests the viewer rebake if the asset is not found
+        /// </summary>
+        /// <param name="client"></param>
+        /// <param name="textureID"></param>
+        /// <param name="idx"></param>
+        private bool CheckBakedTextureAsset(IClientAPI client, UUID textureID, int idx)
+        {
+            if (m_scene.AssetService.Get(textureID.ToString()) == null)
             {
+                m_log.WarnFormat("[AVFACTORY]: Missing baked texture {0} ({1}) for avatar {2}",
+                                 textureID,idx,client.Name);
+                return false;
+            }
+            return true;
+        }
+        
+        #region UpdateAppearanceTimer
+
+        public void QueueAppearanceSend(UUID agentid)
+        {
 // DEBUG ON
-                m_log.Warn("[AVFACTORY] Appearance changed");
+            m_log.WarnFormat("[AVFACTORY] Queue appearance send for {0}",agentid);
 // DEBUG OFF                
-                sp.Appearance.SetAppearance(textureEntry, visualParams);
-                if (sp.Appearance.AvatarHeight > 0)
-                    sp.SetHeight(sp.Appearance.AvatarHeight);
 
-                m_scene.AvatarService.SetAppearance(client.AgentId, sp.Appearance);
+            // 100 nanoseconds (ticks) we should wait
+            long timestamp = DateTime.Now.Ticks + Convert.ToInt64(m_sendtime * 10000000); 
+            lock (m_sendqueue)
+            {
+                m_sendqueue[agentid] = timestamp;
+                m_updateTimer.Start();
             }
+        }
+        
+        public void QueueAppearanceSave(UUID agentid)
+        {
 // DEBUG ON
-            else
-                m_log.Warn("[AVFACTORY] Appearance did not change");
-// DEBUG OFF
+            m_log.WarnFormat("[AVFACTORY] Queue appearance save for {0}",agentid);
+// DEBUG OFF                
 
+            // 100 nanoseconds (ticks) we should wait
+            long timestamp = DateTime.Now.Ticks + Convert.ToInt64(m_savetime * 10000000); 
+            lock (m_savequeue)
+            {
+                m_savequeue[agentid] = timestamp;
+                m_updateTimer.Start();
+            }
+        }
+        
+        private void HandleAppearanceSend(UUID agentid)
+        {
+            ScenePresence sp = m_scene.GetScenePresence(agentid);
+            if (sp == null)
+            {
+                m_log.WarnFormat("[AVFACTORY] Agent {0} no longer in the scene",agentid);
+                return;
+            }
+
+// DEBUG ON
+            m_log.WarnFormat("[AVFACTORY] Handle appearance send for {0}",agentid);
+// DEBUG OFF                
+
+            // Send the appearance to everyone in the scene
             sp.SendAppearanceToAllOtherAgents();
+            sp.ControllingClient.SendAvatarDataImmediate(sp);
+
+            // Send the appearance back to the avatar
+            // AvatarAppearance avp = sp.Appearance;
+            // sp.ControllingClient.SendAppearance(avp.Owner,avp.VisualParams,avp.Texture.GetBytes());
+
+/*
+//  this needs to be fixed, the flag should be on scene presence not the region module
+            // Start the animations if necessary
             if (!m_startAnimationSet)
             {
                 sp.Animator.UpdateMovementAnimations();
                 m_startAnimationSet = true;
             }
+*/
+        }
 
-            client.SendAvatarDataImmediate(sp);
-            client.SendAppearance(sp.Appearance.Owner,sp.Appearance.VisualParams,sp.Appearance.Texture.GetBytes());
+        private void HandleAppearanceSave(UUID agentid)
+        {
+            ScenePresence sp = m_scene.GetScenePresence(agentid);
+            if (sp == null)
+            {
+                m_log.WarnFormat("[AVFACTORY] Agent {0} no longer in the scene",agentid);
+                return;
+            }
+
+            m_scene.AvatarService.SetAppearance(agentid, sp.Appearance);
         }
 
+        private void HandleAppearanceUpdateTimer(object sender, EventArgs ea)
+        {
+            long now = DateTime.Now.Ticks;
+            
+            lock (m_sendqueue)
+            {
+                Dictionary<UUID,long> sends = new Dictionary<UUID,long>(m_sendqueue);
+                foreach (KeyValuePair<UUID,long> kvp in sends)
+                {
+                    if (kvp.Value < now)
+                    {
+                        Util.FireAndForget(delegate(object o) { HandleAppearanceSend(kvp.Key); });
+                        m_sendqueue.Remove(kvp.Key);
+                    }
+                }
+            }
+
+            lock (m_savequeue)
+            {
+                Dictionary<UUID,long> saves = new Dictionary<UUID,long>(m_savequeue);
+                foreach (KeyValuePair<UUID,long> kvp in saves)
+                {
+                    if (kvp.Value < now)
+                    {
+                        Util.FireAndForget(delegate(object o) { HandleAppearanceSave(kvp.Key); });
+                        m_savequeue.Remove(kvp.Key);
+                    }
+                }
+            }
+
+            if (m_savequeue.Count == 0 && m_sendqueue.Count == 0)
+                m_updateTimer.Stop();
+        }
+        
+        #endregion
+
         /// <summary>
         /// Tell the client for this scene presence what items it should be wearing now
         /// </summary>
@@ -215,14 +369,6 @@ namespace OpenSim.Region.CoreModules.Avatar.AvatarFactory
 
             AvatarAppearance avatAppearance = new AvatarAppearance(sp.Appearance);
 
-            //if (!TryGetAvatarAppearance(client.AgentId, out avatAppearance)) 
-            //{
-            //    m_log.Warn("[AVFACTORY]: We didn't seem to find the appearance, falling back to ScenePresence");
-            //    avatAppearance = sp.Appearance;
-            //}
-            
-            //m_log.DebugFormat("[AVFACTORY]: Received wearables for {0}", client.Name);
-            
             foreach (AvatarWearingArgs.Wearable wear in e.NowWearing)
             {
                 if (wear.Type < AvatarWearable.MAX_WEARABLES)
@@ -232,10 +378,11 @@ namespace OpenSim.Region.CoreModules.Avatar.AvatarFactory
                 }
             }
             
+            // This could take awhile since it needs to pull inventory
             SetAppearanceAssets(sp.UUID, ref avatAppearance);
 
-            m_scene.AvatarService.SetAppearance(client.AgentId, avatAppearance);
             sp.Appearance = avatAppearance;
+            m_scene.AvatarService.SetAppearance(client.AgentId, sp.Appearance);
         }
 
         private void SetAppearanceAssets(UUID userID, ref AvatarAppearance appearance)