Merge branch 'master' into careminster

OpenSim/Region/ClientStack/Linden/UDP/J2KImage.cs

@@ -45,6 +45,15 @@ namespace OpenSim.Region.ClientStack.LindenUDP
         private const int IMAGE_PACKET_SIZE = 1000;
         private const int FIRST_PACKET_SIZE = 600;
 
+        /// <summary>
+        /// If we've requested an asset but not received it in this ticks timeframe, then allow a duplicate
+        /// request from the client to trigger a fresh asset request.
+        /// </summary>
+        /// <remarks>
+        /// There are 10,000 ticks in a millisecond
+        /// </remarks>
+        private const int ASSET_REQUEST_TIMEOUT = 100000000;
+
         private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
 
         public uint LastSequence;
@@ -57,8 +66,22 @@ namespace OpenSim.Region.ClientStack.LindenUDP
         public UUID AgentID;
         public IInventoryAccessModule InventoryAccessModule;
         private OpenJPEG.J2KLayerInfo[] m_layers;
+
+        /// <summary>
+        /// Has this request decoded the asset data?
+        /// </summary>
         public bool IsDecoded { get; private set; }
+
+        /// <summary>
+        /// Has this request received the required asset data?
+        /// </summary>
         public bool HasAsset { get; private set; }
+
+        /// <summary>
+        /// Time in milliseconds at which the asset was requested.
+        /// </summary>
+        public long AssetRequestTime { get; private set; }
+
         public C5.IPriorityQueueHandle<J2KImage> PriorityQueueHandle;
 
         private uint m_currentPacket;
@@ -82,7 +105,7 @@ namespace OpenSim.Region.ClientStack.LindenUDP
         /// <param name="packetsToSend">Maximum number of packets to send during this call</param>
         /// <param name="packetsSent">Number of packets sent during this call</param>
         /// <returns>True if the transfer completes at the current discard level, otherwise false</returns>
-        public bool SendPackets(LLClientView client, int packetsToSend, out int packetsSent)
+        public bool SendPackets(IClientAPI client, int packetsToSend, out int packetsSent)
         {
             packetsSent = 0;
 
@@ -123,10 +146,15 @@ namespace OpenSim.Region.ClientStack.LindenUDP
         {
             if (!HasAsset)
             {
-                if (!m_assetRequested)
+                if (!m_assetRequested || DateTime.UtcNow.Ticks > AssetRequestTime + ASSET_REQUEST_TIMEOUT)
                 {
+//                    m_log.DebugFormat(
+//                        "[J2KIMAGE]: Requesting asset {0} from request in packet {1}, already requested? {2}, due to timeout? {3}",
+//                        TextureID, LastSequence, m_assetRequested, DateTime.UtcNow.Ticks > AssetRequestTime + ASSET_REQUEST_TIMEOUT);
+
                     m_assetRequested = true;
-//                    m_log.DebugFormat("[J2KIMAGE]: Requesting asset {0}", TextureID);
+                    AssetRequestTime = DateTime.UtcNow.Ticks;
+
                     AssetService.Get(TextureID.ToString(), this, AssetReceived);
                 }
             }
@@ -215,7 +243,7 @@ namespace OpenSim.Region.ClientStack.LindenUDP
             }
         }
 
-        private bool SendFirstPacket(LLClientView client)
+        private bool SendFirstPacket(IClientAPI client)
         {
             if (client == null)
                 return false;
@@ -250,7 +278,7 @@ namespace OpenSim.Region.ClientStack.LindenUDP
             return false;
         }
 
-        private bool SendPacket(LLClientView client)
+        private bool SendPacket(IClientAPI client)
         {
             if (client == null)
                 return false;
@@ -380,6 +408,9 @@ namespace OpenSim.Region.ClientStack.LindenUDP
 
         private void AssetReceived(string id, Object sender, AssetBase asset)
         {
+//            m_log.DebugFormat(
+//                "[J2KIMAGE]: Received asset {0} ({1} bytes)", id, asset != null ? asset.Data.Length.ToString() : "n/a");
+
             UUID assetID = UUID.Zero;
             if (asset != null)
             {

OpenSim/Region/ClientStack/Linden/UDP/LLClientView.cs

@@ -220,6 +220,7 @@ namespace OpenSim.Region.ClientStack.LindenUDP
         public event BakeTerrain OnBakeTerrain;
         public event RequestTerrain OnUploadTerrain;
         public event EstateChangeInfo OnEstateChangeInfo;
+        public event EstateManageTelehub OnEstateManageTelehub;
         public event EstateRestartSimRequest OnEstateRestartSimRequest;
         public event EstateChangeCovenantRequest OnEstateChangeCovenantRequest;
         public event UpdateEstateAccessDeltaRequest OnUpdateEstateAccessDeltaRequest;
@@ -4537,6 +4538,23 @@ namespace OpenSim.Region.ClientStack.LindenUDP
             OutPacket(packet, ThrottleOutPacketType.Task);
         }
 
+        public void SendTelehubInfo(UUID ObjectID, string ObjectName, Vector3 ObjectPos, Quaternion ObjectRot, List<Vector3> SpawnPoint)
+        {
+            TelehubInfoPacket packet = (TelehubInfoPacket)PacketPool.Instance.GetPacket(PacketType.TelehubInfo);
+            packet.TelehubBlock.ObjectID = ObjectID;
+            packet.TelehubBlock.ObjectName = Utils.StringToBytes(ObjectName);
+            packet.TelehubBlock.TelehubPos = ObjectPos;
+            packet.TelehubBlock.TelehubRot = ObjectRot;
+
+            packet.SpawnPointBlock = new TelehubInfoPacket.SpawnPointBlockBlock[SpawnPoint.Count];
+            for (int n = 0; n < SpawnPoint.Count; n++)
+            {
+                packet.SpawnPointBlock[n] = new TelehubInfoPacket.SpawnPointBlockBlock{SpawnPointPos = SpawnPoint[n]};
+            }
+
+            OutPacket(packet, ThrottleOutPacketType.Task);
+        }
+
         #endregion
 
         #region Land Data Sending Methods
@@ -8981,7 +8999,7 @@ namespace OpenSim.Region.ClientStack.LindenUDP
         private bool HandleEstateOwnerMessage(IClientAPI sender, Packet Pack)
         {
             EstateOwnerMessagePacket messagePacket = (EstateOwnerMessagePacket)Pack;
-            //m_log.Debug(messagePacket.ToString());
+            // m_log.InfoFormat("[LLCLIENTVIEW]: Packet: {0}", Utils.BytesToString(messagePacket.MethodData.Method));
             GodLandStatRequest handlerLandStatRequest;
 
             #region Packet Session and User Check
@@ -9280,6 +9298,23 @@ namespace OpenSim.Region.ClientStack.LindenUDP
                     }
                     return true;
 
+                case "telehub":
+                    if (((Scene)m_scene).Permissions.CanIssueEstateCommand(AgentId, false))
+                    {
+                        UUID invoice = messagePacket.MethodData.Invoice;
+                        UUID SenderID = messagePacket.AgentData.AgentID;
+                        UInt32 param1 = Convert.ToUInt32(Utils.BytesToString(messagePacket.ParamList[1].Parameter));
+
+                        string command = (string)Utils.BytesToString(messagePacket.ParamList[0].Parameter);
+
+                        EstateManageTelehub handlerEstateManageTelehub = OnEstateManageTelehub;
+                        if (handlerEstateManageTelehub != null)
+                        {
+                            handlerEstateManageTelehub(this, invoice, SenderID, command, param1);
+                        }
+                    }
+                    return true;
+
                 default:
                     m_log.Error("EstateOwnerMessage: Unknown method requested\n" + messagePacket);
                     return true;
@@ -9291,8 +9326,6 @@ namespace OpenSim.Region.ClientStack.LindenUDP
             //lsrp.RequestData.ReportType; // 1 = colliders, 0 = scripts
             //lsrp.RequestData.RequestFlags;
             //lsrp.RequestData.Filter;
-
-//            return true;
         }
 
         private bool HandleRequestRegionInfo(IClientAPI sender, Packet Pack)

OpenSim/Region/ClientStack/Linden/UDP/LLImageManager.cs

@@ -55,18 +55,29 @@ namespace OpenSim.Region.ClientStack.LindenUDP
         private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
         private bool m_shuttingdown;
         private AssetBase m_missingImage;
-        private LLClientView m_client; //Client we're assigned to
-        private IAssetService m_assetCache; //Asset Cache
-        private IJ2KDecoder m_j2kDecodeModule; //Our J2K module
+        private IAssetService m_assetCache;
+        private IJ2KDecoder m_j2kDecodeModule;
+
+        /// <summary>
+        /// Priority queue for determining which image to send first.
+        /// </summary>
         private C5.IntervalHeap<J2KImage> m_priorityQueue = new C5.IntervalHeap<J2KImage>(10, new J2KImageComparer());
+
+        /// <summary>
+        /// Used to control thread access to the priority queue.
+        /// </summary>
         private object m_syncRoot = new object();
 
-        public LLClientView Client { get { return m_client; } }
+        /// <summary>
+        /// Client served by this image manager
+        /// </summary>
+        public IClientAPI Client { get; private set; }
+
         public AssetBase MissingImage { get { return m_missingImage; } }
 
-        public LLImageManager(LLClientView client, IAssetService pAssetCache, IJ2KDecoder pJ2kDecodeModule)
+        public LLImageManager(IClientAPI client, IAssetService pAssetCache, IJ2KDecoder pJ2kDecodeModule)
         {
-            m_client = client;
+            Client = client;
             m_assetCache = pAssetCache;
 
             if (pAssetCache != null)
@@ -111,8 +122,8 @@ namespace OpenSim.Region.ClientStack.LindenUDP
 //                            "[LL IMAGE MANAGER]: Received duplicate of existing request for {0}, start packet {1} from {2}",
 //                            newRequest.RequestedAssetID, newRequest.PacketNumber, m_client.Name);
 
-                        //m_log.DebugFormat("[TEX]: (UPD) ID={0}: D={1}, S={2}, P={3}",
-                        //    newRequest.RequestedAssetID, newRequest.DiscardLevel, newRequest.PacketNumber, newRequest.Priority);
+//                        m_log.DebugFormat("[TEX]: (UPD) ID={0}: D={1}, S={2}, P={3}",
+//                            newRequest.RequestedAssetID, newRequest.DiscardLevel, newRequest.PacketNumber, newRequest.Priority);
 
                         //Check the packet sequence to make sure this isn't older than
                         //one we've already received
@@ -178,8 +189,8 @@ namespace OpenSim.Region.ClientStack.LindenUDP
                         imgrequest = new J2KImage(this);
                         imgrequest.J2KDecoder = m_j2kDecodeModule;
                         imgrequest.AssetService = m_assetCache;
-                        imgrequest.AgentID = m_client.AgentId;
-                        imgrequest.InventoryAccessModule = m_client.Scene.RequestModuleInterface<IInventoryAccessModule>();
+                        imgrequest.AgentID = Client.AgentId;
+                        imgrequest.InventoryAccessModule = Client.Scene.RequestModuleInterface<IInventoryAccessModule>();
                         imgrequest.DiscardLevel = newRequest.DiscardLevel;
                         imgrequest.StartPacket = Math.Max(1, newRequest.PacketNumber);
                         imgrequest.Priority = newRequest.Priority;
@@ -210,7 +221,7 @@ namespace OpenSim.Region.ClientStack.LindenUDP
                 if (image.IsDecoded)
                 {
                     int sent;
-                    bool imageDone = image.SendPackets(m_client, packetsToSend - packetsSent, out sent);
+                    bool imageDone = image.SendPackets(Client, packetsToSend - packetsSent, out sent);
                     packetsSent += sent;
 
                     // If the send is complete, destroy any knowledge of this transfer
@@ -245,6 +256,26 @@ namespace OpenSim.Region.ClientStack.LindenUDP
             m_shuttingdown = true;
         }
 
+        /// <summary>
+        /// Clear the image queue.
+        /// </summary>
+        /// <returns>The number of requests cleared.</returns>
+        public int ClearImageQueue()
+        {
+            int requestsDeleted;
+
+            lock (m_priorityQueue)
+            {
+                requestsDeleted = m_priorityQueue.Count;
+
+                // Surprisingly, there doesn't seem to be a clear method at this time.
+                while (!m_priorityQueue.IsEmpty)
+                    m_priorityQueue.DeleteMax();
+            }
+
+            return requestsDeleted;
+        }
+
         /// <summary>
         /// Returns an array containing all the images in the queue.
         /// </summary>

OpenSim/Region/ClientStack/Linden/UDP/Tests/LLImageManagerTests.cs

@@ -0,0 +1,160 @@
+/*
+ * Copyright (c) Contributors, http://opensimulator.org/
+ * See CONTRIBUTORS.TXT for a full list of copyright holders.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *     * Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in the
+ *       documentation and/or other materials provided with the distribution.
+ *     * Neither the name of the OpenSimulator Project nor the
+ *       names of its contributors may be used to endorse or promote products
+ *       derived from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
+ * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * 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
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+using System;
+using System.IO;
+using System.Net;
+using System.Reflection;
+using log4net.Config;
+using Nini.Config;
+using NUnit.Framework;
+using OpenMetaverse;
+using OpenMetaverse.Packets;
+using OpenSim.Framework;
+using OpenSim.Region.CoreModules.Agent.TextureSender;
+using OpenSim.Region.Framework.Scenes;
+using OpenSim.Tests.Common;
+using OpenSim.Tests.Common.Mock;
+
+namespace OpenSim.Region.ClientStack.LindenUDP.Tests
+{
+    [TestFixture]
+    public class LLImageManagerTests
+    {
+        private AssetBase m_testImageAsset;
+        private Scene scene;
+        private LLImageManager llim;
+        private TestClient tc;
+
+        [TestFixtureSetUp]
+        public void FixtureInit()
+        {
+            using (
+                Stream resource
+                    = GetType().Assembly.GetManifestResourceStream(
+                        "OpenSim.Region.ClientStack.LindenUDP.Tests.Resources.4-tile2.jp2"))
+            {
+                using (BinaryReader br = new BinaryReader(resource))
+                {
+                    m_testImageAsset
+                        = new AssetBase(
+                            TestHelpers.ParseTail(0x1),
+                            "Test Image",
+                            (sbyte)AssetType.Texture,
+                            TestHelpers.ParseTail(0x2).ToString());
+
+                    m_testImageAsset.Data = br.ReadBytes(99999999);
+                }
+            }
+        }
+
+        [SetUp]
+        public void SetUp()
+        {
+            UUID userId = TestHelpers.ParseTail(0x3);
+
+            J2KDecoderModule j2kdm = new J2KDecoderModule();
+
+            scene = SceneHelpers.SetupScene();
+            SceneHelpers.SetupSceneModules(scene, j2kdm);
+
+            tc = new TestClient(SceneHelpers.GenerateAgentData(userId), scene);
+            llim = new LLImageManager(tc, scene.AssetService, j2kdm);
+        }
+
+        [Test]
+        public void TestSendImage()
+        {
+            TestHelpers.InMethod();
+//            XmlConfigurator.Configure();
+
+            scene.AssetService.Store(m_testImageAsset);
+
+            TextureRequestArgs args = new TextureRequestArgs();
+            args.RequestedAssetID = m_testImageAsset.FullID;
+            args.DiscardLevel = 0;
+            args.PacketNumber = 1;
+            args.Priority = 5;
+            args.requestSequence = 1;
+
+            llim.EnqueueReq(args);
+            llim.ProcessImageQueue(20);
+
+            Assert.That(tc.SentImageDataPackets.Count, Is.EqualTo(1));
+        }
+
+        [Test]
+        public void TestDiscardImage()
+        {
+            TestHelpers.InMethod();
+//            XmlConfigurator.Configure();
+
+            scene.AssetService.Store(m_testImageAsset);
+
+            TextureRequestArgs args = new TextureRequestArgs();
+            args.RequestedAssetID = m_testImageAsset.FullID;
+            args.DiscardLevel = 0;
+            args.PacketNumber = 1;
+            args.Priority = 5;
+            args.requestSequence = 1;
+            llim.EnqueueReq(args);
+
+            // Now create a discard request
+            TextureRequestArgs discardArgs = new TextureRequestArgs();
+            discardArgs.RequestedAssetID = m_testImageAsset.FullID;
+            discardArgs.DiscardLevel = -1;
+            discardArgs.PacketNumber = 1;
+            discardArgs.Priority = 0;
+            discardArgs.requestSequence = 2;
+            llim.EnqueueReq(discardArgs);
+
+            llim.ProcessImageQueue(20);
+
+            Assert.That(tc.SentImageDataPackets.Count, Is.EqualTo(0));
+        }
+
+        [Test]
+        public void TestMissingImage()
+        {
+            TestHelpers.InMethod();
+//            XmlConfigurator.Configure();
+
+            TextureRequestArgs args = new TextureRequestArgs();
+            args.RequestedAssetID = m_testImageAsset.FullID;
+            args.DiscardLevel = 0;
+            args.PacketNumber = 1;
+            args.Priority = 5;
+            args.requestSequence = 1;
+
+            llim.EnqueueReq(args);
+            llim.ProcessImageQueue(20);
+
+            Assert.That(tc.SentImageDataPackets.Count, Is.EqualTo(0));
+            Assert.That(tc.SentImageNotInDatabasePackets.Count, Is.EqualTo(1));
+        }
+    }
+}