3 files changed, 560 insertions, 561 deletions
diff --git a/OpenSim/Region/Environment/Modules/TextureDownloadModule.cs b/OpenSim/Region/Environment/Modules/Agent/TextureDownload/TextureDownloadModule.cs
index bde0dc0..b8899d2 100644
--- a/OpenSim/Region/Environment/Modules/TextureDownloadModule.cs
+++ b/OpenSim/Region/Environment/Modules/Agent/TextureDownload/TextureDownloadModule.cs
@@ -1,218 +1,215 @@
-/*
+/*
- * Copyright (c) Contributors, http://opensimulator.org/
+ * Copyright (c) Contributors, http://opensimulator.org/
- * See CONTRIBUTORS.TXT for a full list of copyright holders.
+ * See CONTRIBUTORS.TXT for a full list of copyright holders.
- *
+ *
- * Redistribution and use in source and binary forms, with or without
+ * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
+ * modification, are permitted provided that the following conditions are met:
- *     * Redistributions of source code must retain the above copyright
+ *     * Redistributions of source code must retain the above copyright
- *       notice, this list of conditions and the following disclaimer.
+ *       notice, this list of conditions and the following disclaimer.
- *     * Redistributions in binary form must reproduce the above copyright
+ *     * Redistributions in binary form must reproduce the above copyright
- *       notice, this list of conditions and the following disclaimer in the
+ *       notice, this list of conditions and the following disclaimer in the
- *       documentation and/or other materials provided with the distribution.
+ *       documentation and/or other materials provided with the distribution.
- *     * Neither the name of the OpenSim Project nor the
+ *     * Neither the name of the OpenSim Project nor the
- *       names of its contributors may be used to endorse or promote products
+ *       names of its contributors may be used to endorse or promote products
- *       derived from this software without specific prior written permission.
+ *       derived from this software without specific prior written permission.
- *
+ *
- * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
+ * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
- * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
+ * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
- * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
- * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
- * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
- * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
- * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
+ */
-using System;
+using System;
-using System.Collections.Generic;
+using System.Collections.Generic;
-using System.Threading;
+using System.Threading;
-using libsecondlife;
+using libsecondlife;
-using Nini.Config;
+using Nini.Config;
-using OpenSim.Framework;
+using OpenSim.Framework;
-using OpenSim.Region.Environment.Interfaces;
+using OpenSim.Region.Environment.Interfaces;
-using OpenSim.Region.Environment.Scenes;
+using OpenSim.Region.Environment.Scenes;
-namespace OpenSim.Region.Environment.Modules
+namespace OpenSim.Region.Environment.Modules.Agent.TextureDownload
-{
+{
-    //this is a first attempt, to start breaking the mess thats called the assetcache up.
+    public class TextureDownloadModule : IRegionModule
-    // basically this should be the texture sending (to clients) code moved out of assetcache 
+    {
-    //and some small clean up
+        //private static readonly log4net.ILog m_log 
-    public class TextureDownloadModule : IRegionModule
+        //    = log4net.LogManager.GetLogger(System.Reflection.MethodBase.GetCurrentMethod().DeclaringType);
-    {
+        
-        //private static readonly log4net.ILog m_log 
+        private Scene m_scene;
-        //    = log4net.LogManager.GetLogger(System.Reflection.MethodBase.GetCurrentMethod().DeclaringType);
+        private List<Scene> m_scenes = new List<Scene>();
-        
-        private Scene m_scene;
+        /// <summary>
-        private List<Scene> m_scenes = new List<Scene>();
+        /// There is one queue for all textures waiting to be sent, regardless of the requesting user.
+        /// </summary>
-        /// <summary>
+        private readonly BlockingQueue<ITextureSender> m_queueSenders 
-        /// There is one queue for all textures waiting to be sent, regardless of the requesting user.
+            = new BlockingQueue<ITextureSender>();
-        /// </summary>
-        private readonly BlockingQueue<ITextureSender> m_queueSenders 
+        /// <summary>
-            = new BlockingQueue<ITextureSender>();
+        /// Each user has their own texture download service.
+        /// </summary>
-        /// <summary>
+        private readonly Dictionary<LLUUID, UserTextureDownloadService> m_userTextureServices =
-        /// Each user has their own texture download service.
+            new Dictionary<LLUUID, UserTextureDownloadService>();
-        /// </summary>
-        private readonly Dictionary<LLUUID, UserTextureDownloadService> m_userTextureServices =
+        private Thread m_thread;
-            new Dictionary<LLUUID, UserTextureDownloadService>();
+        public TextureDownloadModule()
-        private Thread m_thread;
+        {
+        }
-        public TextureDownloadModule()
-        {
+        public void Initialise(Scene scene, IConfigSource config)
-        }
+        {
+            if (m_scene == null)
-        public void Initialise(Scene scene, IConfigSource config)
+            {
-        {
+                //Console.WriteLine("Creating Texture download module");
-            if (m_scene == null)
+                m_thread = new Thread(new ThreadStart(ProcessTextureSenders));
-            {
+                m_thread.Name = "ProcessTextureSenderThread";
-                //Console.WriteLine("Creating Texture download module");
+                m_thread.IsBackground = true;
-                m_thread = new Thread(new ThreadStart(ProcessTextureSenders));
+                m_thread.Start();
-                m_thread.Name = "ProcessTextureSenderThread";
+                ThreadTracker.Add(m_thread);
-                m_thread.IsBackground = true;
+            }
-                m_thread.Start();
-                ThreadTracker.Add(m_thread);
+            if (!m_scenes.Contains(scene))
-            }
+            {
+                m_scenes.Add(scene);
-            if (!m_scenes.Contains(scene))
+                m_scene = scene;
-            {
+                m_scene.EventManager.OnNewClient += NewClient;
-                m_scenes.Add(scene);
+                m_scene.EventManager.OnRemovePresence += EventManager_OnRemovePresence;
-                m_scene = scene;
+            }
-                m_scene.EventManager.OnNewClient += NewClient;
+        }
-                m_scene.EventManager.OnRemovePresence += EventManager_OnRemovePresence;
-            }
+        /// <summary>
-        }
+        /// Cleanup the texture service related objects for the removed presence.
+        /// </summary>
-        /// <summary>
+        /// <param name="agentId"> </param>
-        /// Cleanup the texture service related objects for the removed presence.
+        private void EventManager_OnRemovePresence(LLUUID agentId)
-        /// </summary>
+        {
-        /// <param name="agentId"> </param>
+            UserTextureDownloadService textureService;
-        private void EventManager_OnRemovePresence(LLUUID agentId)
-        {
+            lock (m_userTextureServices)
-            UserTextureDownloadService textureService;
+            {
+                if (m_userTextureServices.TryGetValue(agentId, out textureService))
-            lock (m_userTextureServices)
+                {
-            {
+                    textureService.Close();
-                if (m_userTextureServices.TryGetValue(agentId, out textureService))
-                {
+                    m_userTextureServices.Remove(agentId);
-                    textureService.Close();
+                }
+            }
-                    m_userTextureServices.Remove(agentId);
+        }
-                }
-            }
+        public void PostInitialise()
-        }
+        {
+        }
-        public void PostInitialise()
-        {
+        public void Close()
-        }
+        {
+        }
-        public void Close()
-        {
+        public string Name
-        }
+        {
+            get { return "TextureDownloadModule"; }
-        public string Name
+        }
-        {
-            get { return "TextureDownloadModule"; }
+        public bool IsSharedModule
-        }
+        {
+            get { return false; }
-        public bool IsSharedModule
+        }
-        {
-            get { return false; }
+        public void NewClient(IClientAPI client)
-        }
+        {
+            client.OnRequestTexture += TextureRequest;
-        public void NewClient(IClientAPI client)
+        }
-        {
-            client.OnRequestTexture += TextureRequest;
+        /// <summary>
-        }
+        /// Does this user have a registered texture download service?
+        /// </summary>
-        /// <summary>
+        /// <param name="userID"></param>
-        /// Does this user have a registered texture download service?
+        /// <param name="textureService"></param>
-        /// </summary>
+        /// <returns>Always returns true, since a service is created if one does not already exist</returns>
-        /// <param name="userID"></param>
+        private bool TryGetUserTextureService(
-        /// <param name="textureService"></param>
+            IClientAPI client, out UserTextureDownloadService textureService)
-        /// <returns>Always returns true, since a service is created if one does not already exist</returns>
+        {
-        private bool TryGetUserTextureService(
+            lock (m_userTextureServices)
-            IClientAPI client, out UserTextureDownloadService textureService)
+            {
-        {
+                if (m_userTextureServices.TryGetValue(client.AgentId, out textureService))
-            lock (m_userTextureServices)
+                {
-            {
+                    return true;
-                if (m_userTextureServices.TryGetValue(client.AgentId, out textureService))
+                }
-                {
-                    return true;
+                textureService = new UserTextureDownloadService(client, m_scene, m_queueSenders);
-                }
+                m_userTextureServices.Add(client.AgentId, textureService);
+                
-                textureService = new UserTextureDownloadService(client, m_scene, m_queueSenders);
+                return true;
-                m_userTextureServices.Add(client.AgentId, textureService);
+            }
-                
+        }
-                return true;
-            }
+        /// <summary>
-        }
+        /// Start the process of requesting a given texture.
+        /// </summary>
-        /// <summary>
+        /// <param name="sender"> </param>
-        /// Start the process of requesting a given texture.
+        /// <param name="e"></param>
-        /// </summary>
+        public void TextureRequest(Object sender, TextureRequestArgs e)
-        /// <param name="sender"> </param>
+        {
-        /// <param name="e"></param>
+            IClientAPI client = (IClientAPI) sender;
-        public void TextureRequest(Object sender, TextureRequestArgs e)
+            UserTextureDownloadService textureService;
-        {
+            
-            IClientAPI client = (IClientAPI) sender;
+            if (TryGetUserTextureService(client, out textureService))
-            UserTextureDownloadService textureService;
+            {
-            
+                textureService.HandleTextureRequest(e);
-            if (TryGetUserTextureService(client, out textureService))
+            }            
-            {
+        }
-                textureService.HandleTextureRequest(e);
-            }            
+        /// <summary>
-        }
+        /// Entry point for the thread dedicated to processing the texture queue.
+        /// </summary>
-        /// <summary>
+        public void ProcessTextureSenders()
-        /// Entry point for the thread dedicated to processing the texture queue.
+        {
-        /// </summary>
+            ITextureSender sender = null;
-        public void ProcessTextureSenders()
+            
-        {
+            while (true)
-            ITextureSender sender = null;
+            {
-            
+                sender = m_queueSenders.Dequeue();
-            while (true)
+                
-            {
+                if (sender.Cancel)
-                sender = m_queueSenders.Dequeue();
+                {
-                
+                    TextureSent(sender);
-                if (sender.Cancel)
-                {
+                    sender.Cancel = false;
-                    TextureSent(sender);
+                }
+                else
-                    sender.Cancel = false;
+                {
-                }
+                    bool finished = sender.SendTexturePacket();
-                else
+                    if (finished)
-                {
+                    {
-                    bool finished = sender.SendTexturePacket();
+                        TextureSent(sender);
-                    if (finished)
+                    }
-                    {
+                    else
-                        TextureSent(sender);
+                    {
-                    }
+                        m_queueSenders.Enqueue(sender);
-                    else
+                    }
-                    {
+                }
-                        m_queueSenders.Enqueue(sender);
+                
-                    }
+                // Make sure that any sender we currently have can get garbage collected
-                }
+                sender = null;
-                
+                
-                // Make sure that any sender we currently have can get garbage collected
+                //m_log.InfoFormat("[TEXTURE DOWNLOAD] Texture sender queue size: {0}", m_queueSenders.Count());
-                sender = null;
+            }
-                
+        }
-                //m_log.InfoFormat("[TEXTURE DOWNLOAD] Texture sender queue size: {0}", m_queueSenders.Count());
-            }
+        /// <summary>
-        }
+        /// Called when the texture has finished sending.
+        /// </summary>
-        /// <summary>
+        /// <param name="sender"></param>
-        /// Called when the texture has finished sending.
+        private void TextureSent(ITextureSender sender)
-        /// </summary>
+        {
-        /// <param name="sender"></param>
+            sender.Sending = false;    
-        private void TextureSent(ITextureSender sender)
+            //m_log.DebugFormat("[TEXTURE DOWNLOAD]: Removing download stat for {0}", sender.assetID);            
-        {
+            m_scene.AddPendingDownloads(-1);            
-            sender.Sending = false;    
+        }
-            //m_log.DebugFormat("[TEXTURE DOWNLOAD]: Removing download stat for {0}", sender.assetID);            
+    }
-            m_scene.AddPendingDownloads(-1);            
+}
+\ No newline at end of file
-        }
-    }
-}
diff --git a/OpenSim/Region/Environment/Modules/TextureNotFoundSender.cs b/OpenSim/Region/Environment/Modules/Agent/TextureDownload/TextureNotFoundSender.cs
index 7b835a1..6f11f73 100644
--- a/OpenSim/Region/Environment/Modules/TextureNotFoundSender.cs
+++ b/OpenSim/Region/Environment/Modules/Agent/TextureDownload/TextureNotFoundSender.cs
@@ -1,93 +1,93 @@
-/*
+/*
- * Copyright (c) Contributors, http://opensimulator.org/
+ * Copyright (c) Contributors, http://opensimulator.org/
- * See CONTRIBUTORS.TXT for a full list of copyright holders.
+ * See CONTRIBUTORS.TXT for a full list of copyright holders.
- *
+ *
- * Redistribution and use in source and binary forms, with or without
+ * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
+ * modification, are permitted provided that the following conditions are met:
- *     * Redistributions of source code must retain the above copyright
+ *     * Redistributions of source code must retain the above copyright
- *       notice, this list of conditions and the following disclaimer.
+ *       notice, this list of conditions and the following disclaimer.
- *     * Redistributions in binary form must reproduce the above copyright
+ *     * Redistributions in binary form must reproduce the above copyright
- *       notice, this list of conditions and the following disclaimer in the
+ *       notice, this list of conditions and the following disclaimer in the
- *       documentation and/or other materials provided with the distribution.
+ *       documentation and/or other materials provided with the distribution.
- *     * Neither the name of the OpenSim Project nor the
+ *     * Neither the name of the OpenSim Project nor the
- *       names of its contributors may be used to endorse or promote products
+ *       names of its contributors may be used to endorse or promote products
- *       derived from this software without specific prior written permission.
+ *       derived from this software without specific prior written permission.
- *
+ *
- * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
+ * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
- * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
+ * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
- * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
- * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
- * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
- * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
- * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
+ */
-using libsecondlife;
+using libsecondlife;
-using libsecondlife.Packets;
+using libsecondlife.Packets;
-using OpenSim.Framework;
+using OpenSim.Framework;
-using OpenSim.Region.Environment.Interfaces;
+using OpenSim.Region.Environment.Interfaces;
-namespace OpenSim.Region.Environment.Modules
+namespace OpenSim.Region.Environment.Modules.Agent.TextureDownload
-{
+{
-    /// <summary>
+    /// <summary>
-    /// Sends a 'texture not found' packet back to the client
+    /// Sends a 'texture not found' packet back to the client
-    /// </summary>
+    /// </summary>
-    public class TextureNotFoundSender : ITextureSender
+    public class TextureNotFoundSender : ITextureSender
-    {
+    {
-        //private static readonly log4net.ILog m_log 
+        //private static readonly log4net.ILog m_log 
-        //    = log4net.LogManager.GetLogger(System.Reflection.MethodBase.GetCurrentMethod().DeclaringType);
+        //    = log4net.LogManager.GetLogger(System.Reflection.MethodBase.GetCurrentMethod().DeclaringType);
-        
+        
-        private LLUUID m_textureId;
+        private LLUUID m_textureId;
-        private IClientAPI m_client;
+        private IClientAPI m_client;
-        
+        
-        // See ITextureSender
+        // See ITextureSender
-        public bool Sending 
+        public bool Sending 
-        { 
+        { 
-            get { return false; }
+            get { return false; }
-            set { m_sending = value; }
+            set { m_sending = value; }
-        }
+        }
-                    
+                    
-        private bool m_sending = false;           
+        private bool m_sending = false;           
-        // See ITextureSender
+        // See ITextureSender
-        public bool Cancel 
+        public bool Cancel 
-        { 
+        { 
-            get { return false; }
+            get { return false; }
-            set { m_cancel = value; }
+            set { m_cancel = value; }
-        }
+        }
-                    
+                    
-        private bool m_cancel = false;      
+        private bool m_cancel = false;      
-        
+        
-        public TextureNotFoundSender(IClientAPI client, LLUUID textureID)
+        public TextureNotFoundSender(IClientAPI client, LLUUID textureID)
-        {
+        {
-            m_client = client;
+            m_client = client;
-            m_textureId = textureID;
+            m_textureId = textureID;
-        }
+        }
-        
+        
-        // See ITextureSender
+        // See ITextureSender
-        public void UpdateRequest(int discardLevel, uint packetNumber)
+        public void UpdateRequest(int discardLevel, uint packetNumber)
-        {
+        {
-            // Not need to implement since priority changes don't affect this operation
+            // Not need to implement since priority changes don't affect this operation
-        }
+        }
-        
+        
-        // See ITextureSender
+        // See ITextureSender
-        public bool SendTexturePacket()
+        public bool SendTexturePacket()
-        {
+        {
-            //m_log.InfoFormat(
+            //m_log.InfoFormat(
-            //    "[TEXTURE NOT FOUND SENDER]: Informing the client that texture {0} cannot be found", 
+            //    "[TEXTURE NOT FOUND SENDER]: Informing the client that texture {0} cannot be found", 
-            //    m_textureId);
+            //    m_textureId);
-            
+            
-            ImageNotInDatabasePacket notFound = new ImageNotInDatabasePacket();
+            ImageNotInDatabasePacket notFound = new ImageNotInDatabasePacket();
-            notFound.ImageID.ID = m_textureId;
+            notFound.ImageID.ID = m_textureId;
-            
+            
-            // XXX Temporarily disabling as this appears to be causing client crashes on at least
+            // XXX Temporarily disabling as this appears to be causing client crashes on at least
-            // 1.19.0(5) of the Linden Second Life client.
+            // 1.19.0(5) of the Linden Second Life client.
-            // m_client.OutPacket(notFound, ThrottleOutPacketType.Texture);
+            // m_client.OutPacket(notFound, ThrottleOutPacketType.Texture);
-            
+            
-            return true;
+            return true;
-        }
+        }
-    }
+    }
-}
+}
+\ No newline at end of file
diff --git a/OpenSim/Region/Environment/Modules/UserTextureDownloadService.cs b/OpenSim/Region/Environment/Modules/Agent/TextureDownload/UserTextureDownloadService.cs
index e46bf6d..08a22d6 100644
--- a/OpenSim/Region/Environment/Modules/UserTextureDownloadService.cs
+++ b/OpenSim/Region/Environment/Modules/Agent/TextureDownload/UserTextureDownloadService.cs
@@ -1,250 +1,252 @@
-/*
+/*
- * Copyright (c) Contributors, http://opensimulator.org/
+ * Copyright (c) Contributors, http://opensimulator.org/
- * See CONTRIBUTORS.TXT for a full list of copyright holders.
+ * See CONTRIBUTORS.TXT for a full list of copyright holders.
- *
+ *
- * Redistribution and use in source and binary forms, with or without
+ * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
+ * modification, are permitted provided that the following conditions are met:
- *     * Redistributions of source code must retain the above copyright
+ *     * Redistributions of source code must retain the above copyright
- *       notice, this list of conditions and the following disclaimer.
+ *       notice, this list of conditions and the following disclaimer.
- *     * Redistributions in binary form must reproduce the above copyright
+ *     * Redistributions in binary form must reproduce the above copyright
- *       notice, this list of conditions and the following disclaimer in the
+ *       notice, this list of conditions and the following disclaimer in the
- *       documentation and/or other materials provided with the distribution.
+ *       documentation and/or other materials provided with the distribution.
- *     * Neither the name of the OpenSim Project nor the
+ *     * Neither the name of the OpenSim Project nor the
- *       names of its contributors may be used to endorse or promote products
+ *       names of its contributors may be used to endorse or promote products
- *       derived from this software without specific prior written permission.
+ *       derived from this software without specific prior written permission.
- *
+ *
- * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
+ * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
- * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
+ * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
- * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
- * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
- * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
- * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
- * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
+ */
-using System.Collections.Generic;
+using System.Collections.Generic;
-using System.Reflection;
+using System.Reflection;
-using libsecondlife;
+using libsecondlife;
-using log4net;
+using log4net;
-using OpenSim.Framework;
+using OpenSim.Framework;
-using OpenSim.Framework.Communications.Limit;
+using OpenSim.Framework.Communications.Limit;
-using OpenSim.Region.Environment.Interfaces;
+using OpenSim.Region.Environment.Interfaces;
-using OpenSim.Region.Environment.Scenes;
+using OpenSim.Region.Environment.Modules.Agent.TextureDownload;
+using OpenSim.Region.Environment.Modules.Agent.TextureSender;
-namespace OpenSim.Region.Environment.Modules
+using OpenSim.Region.Environment.Scenes;
-{
-    /// <summary>
+namespace OpenSim.Region.Environment.Modules.Agent.TextureDownload
-    /// This module sets up texture senders in response to client texture requests, and places them on a
+{
-    /// processing queue once those senders have the appropriate data (i.e. a texture retrieved from the 
+    /// <summary>
-    /// asset cache).
+    /// This module sets up texture senders in response to client texture requests, and places them on a
-    /// </summary>
+    /// processing queue once those senders have the appropriate data (i.e. a texture retrieved from the 
-    public class UserTextureDownloadService
+    /// asset cache).
-    {
+    /// </summary>
-        private static readonly ILog m_log 
+    public class UserTextureDownloadService
-            = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
+    {
+        private static readonly ILog m_log 
-        /// <summary>
+            = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
-        /// We will allow the client to request the same texture n times before dropping further requests
-        /// 
+        /// <summary>
-        /// This number includes repeated requests for the same texture at different resolutions (which we don't
+        /// We will allow the client to request the same texture n times before dropping further requests
-        /// currently handle properly as far as I know).  However, this situation should be handled in a more
+        /// 
-        /// sophisticated way.
+        /// This number includes repeated requests for the same texture at different resolutions (which we don't
-        /// </summary>
+        /// currently handle properly as far as I know).  However, this situation should be handled in a more
-        private static readonly int MAX_ALLOWED_TEXTURE_REQUESTS = 5;
+        /// sophisticated way.
-        
+        /// </summary>
-        /// <summary>
+        private static readonly int MAX_ALLOWED_TEXTURE_REQUESTS = 5;
-        /// We're going to limit requests for the same missing texture.
+        
-        /// XXX This is really a temporary solution to deal with the situation where a client continually requests
+        /// <summary>
-        /// the same missing textures
+        /// We're going to limit requests for the same missing texture.
-        /// </summary>        
+        /// XXX This is really a temporary solution to deal with the situation where a client continually requests
-        private readonly IRequestLimitStrategy<LLUUID> missingTextureLimitStrategy 
+        /// the same missing textures
-            = new RepeatLimitStrategy<LLUUID>(MAX_ALLOWED_TEXTURE_REQUESTS);        
+        /// </summary>        
-        
+        private readonly IRequestLimitStrategy<LLUUID> missingTextureLimitStrategy 
-        /// <summary>
+            = new RepeatLimitStrategy<LLUUID>(MAX_ALLOWED_TEXTURE_REQUESTS);        
-        /// XXX Also going to limit requests for found textures.
+        
-        /// </summary>
+        /// <summary>
-        private readonly IRequestLimitStrategy<LLUUID> foundTextureLimitStrategy 
+        /// XXX Also going to limit requests for found textures.
-            = new RepeatLimitStrategy<LLUUID>(MAX_ALLOWED_TEXTURE_REQUESTS);     
+        /// </summary>
-        
+        private readonly IRequestLimitStrategy<LLUUID> foundTextureLimitStrategy 
-        /// <summary>
+            = new RepeatLimitStrategy<LLUUID>(MAX_ALLOWED_TEXTURE_REQUESTS);     
-        /// Holds texture senders before they have received the appropriate texture from the asset cache.
+        
-        /// </summary>
+        /// <summary>
-        private readonly Dictionary<LLUUID, TextureSender> m_textureSenders = new Dictionary<LLUUID, TextureSender>();
+        /// Holds texture senders before they have received the appropriate texture from the asset cache.
-        
+        /// </summary>
-        /// <summary>
+        private readonly Dictionary<LLUUID, TextureSender.TextureSender> m_textureSenders = new Dictionary<LLUUID, TextureSender.TextureSender>();
-        /// Texture Senders are placed in this queue once they have received their texture from the asset
+        
-        /// cache.  Another module actually invokes the send.
+        /// <summary>
-        /// </summary>
+        /// Texture Senders are placed in this queue once they have received their texture from the asset
-        private readonly BlockingQueue<ITextureSender> m_sharedSendersQueue;
+        /// cache.  Another module actually invokes the send.
-        
+        /// </summary>
-        private readonly Scene m_scene;
+        private readonly BlockingQueue<ITextureSender> m_sharedSendersQueue;
-        
+        
-        private readonly IClientAPI m_client;
+        private readonly Scene m_scene;
+        
-        public UserTextureDownloadService(
+        private readonly IClientAPI m_client;
-            IClientAPI client, Scene scene, BlockingQueue<ITextureSender> sharedQueue)
-        {
+        public UserTextureDownloadService(
-            m_client = client;
+            IClientAPI client, Scene scene, BlockingQueue<ITextureSender> sharedQueue)
-            m_scene = scene;
+        {
-            m_sharedSendersQueue = sharedQueue;
+            m_client = client;
-        }
+            m_scene = scene;
+            m_sharedSendersQueue = sharedQueue;
-        /// <summary>
+        }
-        /// Handle a texture request.  This involves creating a texture sender and placing it on the 
-        /// previously passed in shared queue.
+        /// <summary>
-        /// </summary>
+        /// Handle a texture request.  This involves creating a texture sender and placing it on the 
-        /// <param name="e"></param>
+        /// previously passed in shared queue.
-        public void HandleTextureRequest(TextureRequestArgs e)
+        /// </summary>
-        {
+        /// <param name="e"></param>
-            TextureSender textureSender;
+        public void HandleTextureRequest(TextureRequestArgs e)
+        {
-            //TODO: should be working out the data size/ number of packets to be sent for each discard level
+            TextureSender.TextureSender textureSender;
-            if ((e.DiscardLevel >= 0) || (e.Priority != 0))
-            {
+            //TODO: should be working out the data size/ number of packets to be sent for each discard level
-                lock (m_textureSenders)
+            if ((e.DiscardLevel >= 0) || (e.Priority != 0))
-                {
+            {
-                    if (m_textureSenders.TryGetValue(e.RequestedAssetID, out textureSender))
+                lock (m_textureSenders)
-                    {
+                {
-                        // If we've received new non UUID information for this request and it hasn't dispatched 
+                    if (m_textureSenders.TryGetValue(e.RequestedAssetID, out textureSender))
-                        // yet, then update the request accordingly.
+                    {
-                        textureSender.UpdateRequest(e.DiscardLevel, e.PacketNumber);                        
+                        // If we've received new non UUID information for this request and it hasn't dispatched 
-                    }
+                        // yet, then update the request accordingly.
-                    else
+                        textureSender.UpdateRequest(e.DiscardLevel, e.PacketNumber);                        
-                    {       
+                    }
-                        if (!foundTextureLimitStrategy.AllowRequest(e.RequestedAssetID))
+                    else
-                        {
+                    {       
-//                            m_log.DebugFormat(
+                        if (!foundTextureLimitStrategy.AllowRequest(e.RequestedAssetID))
-//                                "[USER TEXTURE DOWNLOAD SERVICE]: Refusing request for {0} from client {1}", 
+                        {
-//                                e.RequestedAssetID, m_client.AgentId);
+//                            m_log.DebugFormat(
-                            
+//                                "[USER TEXTURE DOWNLOAD SERVICE]: Refusing request for {0} from client {1}", 
-                            return;
+//                                e.RequestedAssetID, m_client.AgentId);
-                        }
+                            
-                        else if (!missingTextureLimitStrategy.AllowRequest(e.RequestedAssetID))                      
+                            return;
-                        {
+                        }
-                            if (missingTextureLimitStrategy.IsFirstRefusal(e.RequestedAssetID))
+                        else if (!missingTextureLimitStrategy.AllowRequest(e.RequestedAssetID))                      
-                            {
+                        {
-                                // Commenting out this message for now as it causes too much noise with other 
+                            if (missingTextureLimitStrategy.IsFirstRefusal(e.RequestedAssetID))
-                                // debug messages.  
+                            {
-                                // TODO: possibly record this as a statistic in the future
+                                // Commenting out this message for now as it causes too much noise with other 
-                                //
+                                // debug messages.  
-//                                m_log.DebugFormat(
+                                // TODO: possibly record this as a statistic in the future
-//                                    "[USER TEXTURE DOWNLOAD SERVICE]: Dropping requests for notified missing texture {0} for client {1} since we have received more than {2} requests",
+                                //
-//                                    e.RequestedAssetID, m_client.AgentId, MAX_ALLOWED_TEXTURE_REQUESTS);
+//                                m_log.DebugFormat(
-                            }       
+//                                    "[USER TEXTURE DOWNLOAD SERVICE]: Dropping requests for notified missing texture {0} for client {1} since we have received more than {2} requests",
-                            
+//                                    e.RequestedAssetID, m_client.AgentId, MAX_ALLOWED_TEXTURE_REQUESTS);
-                            return;                                                        
+                            }       
-                        }
+                            
-                
+                            return;                                                        
-                        m_scene.AddPendingDownloads(1);
+                        }
-                
+                
-                        TextureSender requestHandler = new TextureSender(m_client, e.DiscardLevel, e.PacketNumber);                        
+                        m_scene.AddPendingDownloads(1);
-                        m_textureSenders.Add(e.RequestedAssetID, requestHandler);
+                
-                        
+                        TextureSender.TextureSender requestHandler = new TextureSender.TextureSender(m_client, e.DiscardLevel, e.PacketNumber);                        
-                        m_scene.AssetCache.GetAsset(e.RequestedAssetID, TextureCallback, true);                                                        
+                        m_textureSenders.Add(e.RequestedAssetID, requestHandler);
-                    }
+                        
-                }
+                        m_scene.AssetCache.GetAsset(e.RequestedAssetID, TextureCallback, true);                                                        
-            }
+                    }
-            else
+                }
-            {
+            }
-                lock (m_textureSenders)
+            else
-                {
+            {
-                    if (m_textureSenders.TryGetValue(e.RequestedAssetID, out textureSender))
+                lock (m_textureSenders)
-                    {
+                {
-                        textureSender.Cancel = true;
+                    if (m_textureSenders.TryGetValue(e.RequestedAssetID, out textureSender))
-                    }
+                    {
-                }
+                        textureSender.Cancel = true;
-            }
+                    }
-        }
+                }
+            }
-        /// <summary>
+        }
-        /// The callback for the asset cache when a texture has been retrieved.  This method queues the
-        /// texture sender for processing.
+        /// <summary>
-        /// </summary>
+        /// The callback for the asset cache when a texture has been retrieved.  This method queues the
-        /// <param name="textureID"></param>
+        /// texture sender for processing.
-        /// <param name="texture"></param>
+        /// </summary>
-        public void TextureCallback(LLUUID textureID, AssetBase texture)
+        /// <param name="textureID"></param>
-        {
+        /// <param name="texture"></param>
-            //m_log.DebugFormat("[USER TEXTURE DOWNLOAD SERVICE]: Calling TextureCallback with {0}, texture == null is {1}", textureID, (texture == null ? true : false));
+        public void TextureCallback(LLUUID textureID, AssetBase texture)
-            
+        {
-            lock (m_textureSenders)
+            //m_log.DebugFormat("[USER TEXTURE DOWNLOAD SERVICE]: Calling TextureCallback with {0}, texture == null is {1}", textureID, (texture == null ? true : false));
-            {
+            
-                TextureSender textureSender;
+            lock (m_textureSenders)
+            {
-                if (m_textureSenders.TryGetValue(textureID, out textureSender))
+                TextureSender.TextureSender textureSender;
-                {
-                    // XXX It may be perfectly valid for a texture to have no data...  but if we pass
+                if (m_textureSenders.TryGetValue(textureID, out textureSender))
-                    // this on to the TextureSender it will blow up, so just discard for now.
+                {
-                    // Needs investigation.
+                    // XXX It may be perfectly valid for a texture to have no data...  but if we pass
-                    if (texture == null || texture.Data == null)
+                    // this on to the TextureSender it will blow up, so just discard for now.
-                    {                        
+                    // Needs investigation.
-                        if (!missingTextureLimitStrategy.IsMonitoringRequests(textureID))
+                    if (texture == null || texture.Data == null)
-                        {
+                    {                        
-                            missingTextureLimitStrategy.MonitorRequests(textureID);
+                        if (!missingTextureLimitStrategy.IsMonitoringRequests(textureID))
+                        {
-                            m_log.DebugFormat(
+                            missingTextureLimitStrategy.MonitorRequests(textureID);
-                                "[USER TEXTURE DOWNLOAD SERVICE]: Queueing first TextureNotFoundSender for {0}, client {1}", 
-                                textureID, m_client.AgentId);
+                            m_log.DebugFormat(
-                        }
+                                "[USER TEXTURE DOWNLOAD SERVICE]: Queueing first TextureNotFoundSender for {0}, client {1}", 
-                       
+                                textureID, m_client.AgentId);
-                        ITextureSender textureNotFoundSender = new TextureNotFoundSender(m_client, textureID);
+                        }
-                        EnqueueTextureSender(textureNotFoundSender);                  
+                       
-                    }
+                        ITextureSender textureNotFoundSender = new TextureNotFoundSender(m_client, textureID);
-                    else
+                        EnqueueTextureSender(textureNotFoundSender);                  
-                    {
+                    }
-                        if (!textureSender.ImageLoaded)
+                    else
-                        {
+                    {
-                            textureSender.TextureReceived(texture);
+                        if (!textureSender.ImageLoaded)
-                            EnqueueTextureSender(textureSender);
+                        {
-                            
+                            textureSender.TextureReceived(texture);
-                            foundTextureLimitStrategy.MonitorRequests(textureID);
+                            EnqueueTextureSender(textureSender);
-                        }
+                            
-                    }
+                            foundTextureLimitStrategy.MonitorRequests(textureID);
+                        }
-                    //m_log.InfoFormat("[TEXTURE SENDER] Removing texture sender with uuid {0}", textureID);
+                    }
-                    m_textureSenders.Remove(textureID);                    
-                    //m_log.InfoFormat("[TEXTURE SENDER] Current texture senders in dictionary: {0}", m_textureSenders.Count);
+                    //m_log.InfoFormat("[TEXTURE SENDER] Removing texture sender with uuid {0}", textureID);
-                }
+                    m_textureSenders.Remove(textureID);                    
-                else
+                    //m_log.InfoFormat("[TEXTURE SENDER] Current texture senders in dictionary: {0}", m_textureSenders.Count);
-                {
+                }
-                    m_log.WarnFormat(
+                else
-                       "Got a texture uuid {0} with no sender object to handle it, this shouldn't happen",
+                {
-                       textureID);
+                    m_log.WarnFormat(
-                }
+                        "Got a texture uuid {0} with no sender object to handle it, this shouldn't happen",
-            }
+                        textureID);
-        }
+                }
+            }
-        /// <summary>
+        }
-        /// Place a ready texture sender on the processing queue.
-        /// </summary>
+        /// <summary>
-        /// <param name="textureSender"></param>
+        /// Place a ready texture sender on the processing queue.
-        private void EnqueueTextureSender(ITextureSender textureSender)
+        /// </summary>
-        {
+        /// <param name="textureSender"></param>
-            textureSender.Cancel = false;
+        private void EnqueueTextureSender(ITextureSender textureSender)
-            textureSender.Sending = true;
+        {
+            textureSender.Cancel = false;
-            if (!m_sharedSendersQueue.Contains(textureSender))
+            textureSender.Sending = true;
-            {
-                m_sharedSendersQueue.Enqueue(textureSender);
+            if (!m_sharedSendersQueue.Contains(textureSender))
-            }
+            {
-        }
+                m_sharedSendersQueue.Enqueue(textureSender);
+            }
-        /// <summary>
+        }
-        /// Close this module.
-        /// </summary>
+        /// <summary>
-        internal void Close()
+        /// Close this module.
-        {
+        /// </summary>
-            lock (m_textureSenders)
+        internal void Close()
-            {
+        {
-                foreach( TextureSender textureSender in m_textureSenders.Values )
+            lock (m_textureSenders)
-                {
+            {
-                    textureSender.Cancel = true;
+                foreach( TextureSender.TextureSender textureSender in m_textureSenders.Values )
-                }
+                {
+                    textureSender.Cancel = true;
-                m_textureSenders.Clear();
+                }
-            }
-        }
+                m_textureSenders.Clear();
-    }
+            }
-}
+        }
+    }
+}
+\ No newline at end of file