From f38c35b60947fd926246fd95cfce5b9674967124 Mon Sep 17 00:00:00 2001 From: Justin Clarke Casey Date: Wed, 10 Dec 2008 19:12:59 +0000 Subject: * refactor: Move inventory handlers out from UserProfileCacheService * This means that UserProfileCacheService no longer needs to know about IClientAPI and can leave it to callers to do their own error logging * This is also more consistent with the way that item inventory manipulation is handled * I don't really think Scene.PacketHandlers.cs should be a permanent home for these handlers - this is just for convenience --- .../Cache/UserProfileCacheService.cs | 279 --------------------- .../Tests/Cache/UserProfileCacheServiceTests.cs | 48 ++++ .../Tests/UserProfileCacheServiceTests.cs | 48 ---- 3 files changed, 48 insertions(+), 327 deletions(-) create mode 100644 OpenSim/Framework/Communications/Tests/Cache/UserProfileCacheServiceTests.cs delete mode 100644 OpenSim/Framework/Communications/Tests/UserProfileCacheServiceTests.cs (limited to 'OpenSim/Framework') diff --git a/OpenSim/Framework/Communications/Cache/UserProfileCacheService.cs b/OpenSim/Framework/Communications/Cache/UserProfileCacheService.cs index 46df2b7..958ef4e 100644 --- a/OpenSim/Framework/Communications/Cache/UserProfileCacheService.cs +++ b/OpenSim/Framework/Communications/Cache/UserProfileCacheService.cs @@ -185,289 +185,10 @@ namespace OpenSim.Framework.Communications.Cache } else { - CachedUserInfo userInfo = new CachedUserInfo(m_commsManager, userData); m_userProfiles.Add(userID, userInfo); } } } - - /// - /// Handle an inventory folder creation request from the client. - /// - /// - /// - /// - /// - /// - public void HandleCreateInventoryFolder(IClientAPI remoteClient, UUID folderID, ushort folderType, - string folderName, UUID parentID) - { - CachedUserInfo userProfile; - - if (m_userProfiles.TryGetValue(remoteClient.AgentId, out userProfile)) - { - if (!userProfile.CreateFolder(folderName, folderID, folderType, parentID)) - { - m_log.ErrorFormat( - "[AGENT INVENTORY]: Failed to create folder for user {0} {1}", - remoteClient.Name, remoteClient.AgentId); - } - } - else - { - m_log.ErrorFormat( - "[AGENT INVENTORY]: Could not find user profile for {0} {1}", - remoteClient.Name, remoteClient.AgentId); - } - } - - /// - /// Handle a client request to update the inventory folder - /// - /// - /// FIXME: We call add new inventory folder because in the data layer, we happen to use an SQL REPLACE - /// so this will work to rename an existing folder. Needless to say, to rely on this is very confusing, - /// and needs to be changed. - /// - /// - /// - /// - /// - /// - public void HandleUpdateInventoryFolder(IClientAPI remoteClient, UUID folderID, ushort type, string name, - UUID parentID) - { -// m_log.DebugFormat( -// "[AGENT INVENTORY]: Updating inventory folder {0} {1} for {2} {3}", folderID, name, remoteClient.Name, remoteClient.AgentId); - - CachedUserInfo userProfile; - - if (m_userProfiles.TryGetValue(remoteClient.AgentId, out userProfile)) - { - if (!userProfile.UpdateFolder(name, folderID, type, parentID)) - { - m_log.ErrorFormat( - "[AGENT INVENTORY]: Failed to update folder for user {0} {1}", - remoteClient.Name, remoteClient.AgentId); - } - } - else - { - m_log.ErrorFormat( - "[AGENT INVENTORY]: Could not find user profile for {0} {1}", - remoteClient.Name, remoteClient.AgentId); - } - } - - /// - /// Handle an inventory folder move request from the client. - /// - /// - /// - /// - public void HandleMoveInventoryFolder(IClientAPI remoteClient, UUID folderID, UUID parentID) - { - CachedUserInfo userProfile; - - if (m_userProfiles.TryGetValue(remoteClient.AgentId, out userProfile)) - { - if (!userProfile.MoveFolder(folderID, parentID)) - { - m_log.ErrorFormat( - "[AGENT INVENTORY]: Failed to move folder {0} to {1} for user {2}", - folderID, parentID, remoteClient.Name); - } - } - else - { - m_log.ErrorFormat( - "[AGENT INVENTORY]: Could not find user profile for {0} {1}", - remoteClient.Name, remoteClient.AgentId); - } - } - - /// - /// Tell the client about the various child items and folders contained in the requested folder. - /// - /// - /// - /// - /// - /// - /// - public void HandleFetchInventoryDescendents(IClientAPI remoteClient, UUID folderID, UUID ownerID, - bool fetchFolders, bool fetchItems, int sortOrder) - { - // FIXME MAYBE: We're not handling sortOrder! - - InventoryFolderImpl fold = null; - if ((fold = LibraryRoot.FindFolder(folderID)) != null) - { - remoteClient.SendInventoryFolderDetails( - LibraryRoot.Owner, folderID, fold.RequestListOfItems(), - fold.RequestListOfFolders(), fetchFolders, fetchItems); - - return; - } - - CachedUserInfo userProfile; - if (m_userProfiles.TryGetValue(remoteClient.AgentId, out userProfile)) - { - userProfile.SendInventoryDecendents(remoteClient, folderID, fetchFolders, fetchItems); - } - else - { - m_log.ErrorFormat( - "[AGENT INVENTORY]: Could not find user profile for {0} {1}", - remoteClient.Name, remoteClient.AgentId); - } - } - - /// - /// Handle the caps inventory descendents fetch. - /// - /// Since the folder structure is sent to the client on login, I believe we only need to handle items. - /// - /// - /// - /// - /// - /// - /// - /// null if the inventory look up failed - public List HandleFetchInventoryDescendentsCAPS(UUID agentID, UUID folderID, UUID ownerID, - bool fetchFolders, bool fetchItems, int sortOrder) - { -// m_log.DebugFormat( -// "[INVENTORY CACHE]: Fetching folders ({0}), items ({1}) from {2} for agent {3}", -// fetchFolders, fetchItems, folderID, agentID); - - // FIXME MAYBE: We're not handling sortOrder! - - InventoryFolderImpl fold; - if ((fold = LibraryRoot.FindFolder(folderID)) != null) - { - return fold.RequestListOfItems(); - } - - CachedUserInfo userProfile; - if (m_userProfiles.TryGetValue(agentID, out userProfile)) - { - // XXX: When a client crosses into a scene, their entire inventory is fetched - // asynchronously. If the client makes a request before the inventory is received, we need - // to give the inventory a chance to come in. - // - // This is a crude way of dealing with that by retrying the lookup. It's not quite as bad - // in CAPS as doing this with the udp request, since here it won't hold up other packets. - // In fact, here we'll be generous and try for longer. - if (!userProfile.HasReceivedInventory) - { - int attempts = 0; - while (attempts++ < 30) - { - m_log.DebugFormat( - "[INVENTORY CACHE]: Poll number {0} for inventory items in folder {1} for user {2}", - attempts, folderID, agentID); - - Thread.Sleep(2000); - - if (userProfile.HasReceivedInventory) - { - break; - } - } - } - - if (userProfile.HasReceivedInventory) - { - if ((fold = userProfile.RootFolder.FindFolder(folderID)) != null) - { - return fold.RequestListOfItems(); - } - else - { - m_log.WarnFormat( - "[AGENT INVENTORY]: Could not find folder {0} requested by user {1}", - folderID, agentID); - - return null; - } - } - else - { - m_log.ErrorFormat("[INVENTORY CACHE]: Could not find root folder for user {0}", agentID); - - return null; - } - } - else - { - m_log.ErrorFormat("[AGENT INVENTORY]: Could not find user profile for {0}", agentID); - - return null; - } - } - - /// - /// This should delete all the items and folders in the given directory. - /// - /// - /// - public void HandlePurgeInventoryDescendents(IClientAPI remoteClient, UUID folderID) - { - CachedUserInfo userProfile; - - if (m_userProfiles.TryGetValue(remoteClient.AgentId, out userProfile)) - { - if (!userProfile.PurgeFolder(folderID)) - { - m_log.ErrorFormat( - "[AGENT INVENTORY]: Failed to purge folder for user {0} {1}", - remoteClient.Name, remoteClient.AgentId); - } - } - else - { - m_log.ErrorFormat( - "[AGENT INVENTORY]: Could not find user profile for {0} {1}", - remoteClient.Name, remoteClient.AgentId); - } - } - - public void HandleFetchInventory(IClientAPI remoteClient, UUID itemID, UUID ownerID) - { - if (ownerID == LibraryRoot.Owner) - { - //Console.WriteLine("request info for library item"); - - return; - } - - CachedUserInfo userProfile; - if (m_userProfiles.TryGetValue(remoteClient.AgentId, out userProfile)) - { - if (userProfile.HasReceivedInventory) - { - InventoryItemBase item = null; - if ( userProfile.RootFolder == null ) - m_log.ErrorFormat( - "[AGENT INVENTORY]: User {0} {1} does not have a root folder.", - remoteClient.Name, remoteClient.AgentId); - else - item = userProfile.RootFolder.FindItem(itemID); - if (item != null) - { - remoteClient.SendInventoryItemDetails(ownerID, item); - } - } - } - else - { - m_log.ErrorFormat( - "[AGENT INVENTORY]: Could not find user profile for {0} {1}", - remoteClient.Name, remoteClient.AgentId); - } - } } } diff --git a/OpenSim/Framework/Communications/Tests/Cache/UserProfileCacheServiceTests.cs b/OpenSim/Framework/Communications/Tests/Cache/UserProfileCacheServiceTests.cs new file mode 100644 index 0000000..0d239aa --- /dev/null +++ b/OpenSim/Framework/Communications/Tests/Cache/UserProfileCacheServiceTests.cs @@ -0,0 +1,48 @@ +/* + * 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 OpenSim 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 NUnit.Framework; + +namespace OpenSim.Framework.Communications.Tests +{ + /// + /// User profile cache service tests + /// + [TestFixture] + public class UserProfileCacheServiceTests + { + /// + /// Test folder moving. Doesn't do what is says on the tin yet + /// + [Test] + public void TestMoveFolder() + { + // Temporarily empty + } + } +} diff --git a/OpenSim/Framework/Communications/Tests/UserProfileCacheServiceTests.cs b/OpenSim/Framework/Communications/Tests/UserProfileCacheServiceTests.cs deleted file mode 100644 index 0d239aa..0000000 --- a/OpenSim/Framework/Communications/Tests/UserProfileCacheServiceTests.cs +++ /dev/null @@ -1,48 +0,0 @@ -/* - * 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 OpenSim 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 NUnit.Framework; - -namespace OpenSim.Framework.Communications.Tests -{ - /// - /// User profile cache service tests - /// - [TestFixture] - public class UserProfileCacheServiceTests - { - /// - /// Test folder moving. Doesn't do what is says on the tin yet - /// - [Test] - public void TestMoveFolder() - { - // Temporarily empty - } - } -} -- cgit v1.1