From 53e83e5dbb3590cb9c858aa301665357d1511b30 Mon Sep 17 00:00:00 2001 From: Diva Canto Date: Sun, 10 Jan 2010 16:20:59 -0800 Subject: * Starting to clean the house... * Fixed circular dependency --- .../Communications/Cache/CachedUserInfo.cs | 847 --------------------- .../Cache/UserProfileCacheService.cs | 277 ------- 2 files changed, 1124 deletions(-) delete mode 100644 OpenSim/Framework/Communications/Cache/CachedUserInfo.cs delete mode 100644 OpenSim/Framework/Communications/Cache/UserProfileCacheService.cs (limited to 'OpenSim/Framework/Communications/Cache') diff --git a/OpenSim/Framework/Communications/Cache/CachedUserInfo.cs b/OpenSim/Framework/Communications/Cache/CachedUserInfo.cs deleted file mode 100644 index 6648c36..0000000 --- a/OpenSim/Framework/Communications/Cache/CachedUserInfo.cs +++ /dev/null @@ -1,847 +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 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.Collections.Generic; -using System.Reflection; -using log4net; -using OpenMetaverse; -using OpenSim.Services.Interfaces; - -namespace OpenSim.Framework.Communications.Cache -{ - internal delegate void AddItemDelegate(InventoryItemBase itemInfo); - internal delegate void UpdateItemDelegate(InventoryItemBase itemInfo); - internal delegate void DeleteItemDelegate(UUID itemID); - internal delegate void QueryItemDelegate(UUID itemID); - internal delegate void QueryFolderDelegate(UUID folderID); - - internal delegate void CreateFolderDelegate(string folderName, UUID folderID, ushort folderType, UUID parentID); - internal delegate void MoveFolderDelegate(UUID folderID, UUID parentID); - internal delegate void PurgeFolderDelegate(UUID folderID); - internal delegate void UpdateFolderDelegate(string name, UUID folderID, ushort type, UUID parentID); - - internal delegate void SendInventoryDescendentsDelegate( - IClientAPI client, UUID folderID, bool fetchFolders, bool fetchItems); - - public delegate void OnItemReceivedDelegate(UUID itemID); - public delegate void OnInventoryReceivedDelegate(UUID userID); - - /// - /// Stores user profile and inventory data received from backend services for a particular user. - /// - public class CachedUserInfo - { - private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType); - - //// - /// Fired when a particular item has been received from the inventory service - /// - public event OnItemReceivedDelegate OnItemReceived; - - /// - /// Fired once the entire inventory has been received for the user - /// - public event OnInventoryReceivedDelegate OnInventoryReceived; - - /// - /// The comms manager holds references to services (user, grid, inventory, etc.) - /// - private readonly IInventoryService m_InventoryService; - - public UserProfileData UserProfile { get { return m_userProfile; } } - private UserProfileData m_userProfile; - - /// - /// Have we received the user's inventory from the inventory service? - /// - public bool HasReceivedInventory { get { return m_hasReceivedInventory; } } - private bool m_hasReceivedInventory; - - /// - /// Inventory requests waiting for receipt of this user's inventory from the inventory service. - /// - private readonly IList m_pendingRequests = new List(); - - /// - /// The root folder of this user's inventory. Returns null if the root folder has not yet been received. - /// - public InventoryFolderImpl RootFolder { get { return m_rootFolder; } } - private InventoryFolderImpl m_rootFolder; - - public UUID SessionID - { - get { return m_session_id; } - set { m_session_id = value; } - } - private UUID m_session_id = UUID.Zero; - - /// - /// Constructor - /// - /// - /// - public CachedUserInfo(IInventoryService invService, UserProfileData userProfile) - { - m_userProfile = userProfile; - m_InventoryService = invService; - } - - /// - /// This allows a request to be added to be processed once we receive a user's inventory - /// from the inventory service. If we already have the inventory, the request - /// is executed immediately instead. - /// - /// - protected void AddRequest(IInventoryRequest request) - { - lock (m_pendingRequests) - { - if (HasReceivedInventory) - { - request.Execute(); - } - else - { - m_pendingRequests.Add(request); - } - } - } - - /// - /// Helper function for InventoryReceive() - Store a folder temporarily until we've received entire folder list - /// - /// - private void AddFolderToDictionary(InventoryFolderImpl folder, IDictionary> dictionary) - { - UUID parentFolderId = folder.ParentID; - - if (dictionary.ContainsKey(parentFolderId)) - { - dictionary[parentFolderId].Add(folder); - } - else - { - IList folders = new List(); - folders.Add(folder); - dictionary[parentFolderId] = folders; - } - } - - /// - /// Recursively, in depth-first order, add all the folders we've received (stored - /// in a dictionary indexed by parent ID) into the tree that describes user folder - /// heirarchy - /// Any folder that is resolved into the tree is also added to resolvedFolderDictionary, - /// indexed by folder ID. - /// - /// - /// A - /// - private void ResolveReceivedFolders(InventoryFolderImpl parentFolder, - IDictionary> receivedFolderDictionary, - IDictionary resolvedFolderDictionary) - { - if (receivedFolderDictionary.ContainsKey(parentFolder.ID)) - { - List resolvedFolders = new List(); // Folders we've resolved with this invocation - foreach (InventoryFolderImpl folder in receivedFolderDictionary[parentFolder.ID]) - { - if (parentFolder.ContainsChildFolder(folder.ID)) - { - m_log.WarnFormat( - "[INVENTORY CACHE]: Received folder {0} {1} from inventory service which has already been received", - folder.Name, folder.ID); - } - else - { - if (resolvedFolderDictionary.ContainsKey(folder.ID)) - { - m_log.WarnFormat( - "[INVENTORY CACHE]: Received folder {0} {1} from inventory service has already been received but with different parent", - folder.Name, folder.ID); - } - else - { - resolvedFolders.Add(folder); - resolvedFolderDictionary[folder.ID] = folder; - parentFolder.AddChildFolder(folder); - } - } - } // foreach (folder in pendingCategorizationFolders[parentFolder.ID]) - - receivedFolderDictionary.Remove(parentFolder.ID); - foreach (InventoryFolderImpl folder in resolvedFolders) - ResolveReceivedFolders(folder, receivedFolderDictionary, resolvedFolderDictionary); - } // if (receivedFolderDictionary.ContainsKey(parentFolder.ID)) - } - - /// - /// Drop all cached inventory. - /// - public void DropInventory() - { - m_log.Debug("[INVENTORY CACHE]: DropInventory called"); - // Make sure there aren't pending requests around when we do this - // FIXME: There is still a race condition where an inventory operation can be requested (since these aren't being locked). - // Will have to extend locking to exclude this very soon. - lock (m_pendingRequests) - { - m_hasReceivedInventory = false; - m_rootFolder = null; - } - } - - /// - /// Fetch inventory for this user. - /// - /// This has to be executed as a separate step once user information is retreived. - /// This will occur synchronously if the inventory service is in the same process as this class, and - /// asynchronously otherwise. - public void FetchInventory() - { - m_InventoryService.GetUserInventory(UserProfile.ID, InventoryReceive); - } - - /// - /// Callback invoked when the inventory is received from an async request to the inventory service - /// - /// - /// - public void InventoryReceive(ICollection folders, ICollection items) - { - // FIXME: Exceptions thrown upwards never appear on the console. Could fix further up if these - // are simply being swallowed - - try - { - // collection of all received folders, indexed by their parent ID - IDictionary> receivedFolders = - new Dictionary>(); - - // collection of all folders that have been placed into the folder heirarchy starting at m_rootFolder - // This dictonary exists so we don't have to do an InventoryFolderImpl.FindFolder(), which is O(n) on the - // number of folders in our inventory. - // Maybe we should make this structure a member so we can skip InventoryFolderImpl.FindFolder() calls later too? - IDictionary resolvedFolders = - new Dictionary(); - - // Take all received folders, find the root folder, and put ther rest into - // the pendingCategorizationFolders collection - foreach (InventoryFolderImpl folder in folders) - AddFolderToDictionary(folder, receivedFolders); - - if (!receivedFolders.ContainsKey(UUID.Zero)) - throw new Exception("Database did not return a root inventory folder"); - else - { - IList rootFolderList = receivedFolders[UUID.Zero]; - m_rootFolder = rootFolderList[0]; - resolvedFolders[m_rootFolder.ID] = m_rootFolder; - if (rootFolderList.Count > 1) - { - for (int i = 1; i < rootFolderList.Count; i++) - { - m_log.WarnFormat( - "[INVENTORY CACHE]: Discarding extra root folder {0}. Using previously received root folder {1}", - rootFolderList[i].ID, RootFolder.ID); - } - } - receivedFolders.Remove(UUID.Zero); - } - - // Now take the pendingCategorizationFolders collection, and turn that into a tree, - // with the root being RootFolder - if (RootFolder != null) - ResolveReceivedFolders(RootFolder, receivedFolders, resolvedFolders); - - // Generate a warning for folders that are not part of the heirarchy - foreach (KeyValuePair> folderList in receivedFolders) - { - foreach (InventoryFolderImpl folder in folderList.Value) - m_log.WarnFormat("[INVENTORY CACHE]: Malformed Database: Unresolved Pending Folder {0}", folder.Name); - } - - // Take all ther received items and put them into the folder tree heirarchy - foreach (InventoryItemBase item in items) { - InventoryFolderImpl folder = resolvedFolders.ContainsKey(item.Folder) ? resolvedFolders[item.Folder] : null; - ItemReceive(item, folder); - } - } - catch (Exception e) - { - m_log.ErrorFormat("[INVENTORY CACHE]: Error processing inventory received from inventory service, {0}", e); - } - - // Deal with pending requests - lock (m_pendingRequests) - { - // We're going to change inventory status within the lock to avoid a race condition - // where requests are processed after the AddRequest() method has been called. - m_hasReceivedInventory = true; - - foreach (IInventoryRequest request in m_pendingRequests) - { - request.Execute(); - } - } - - if (OnInventoryReceived != null) - OnInventoryReceived(UserProfile.ID); - } - - /// - /// Callback invoked when an item is received from an async request to the inventory service. - /// - /// We're assuming here that items are always received after all the folders - /// received. - /// If folder is null, we will search for it starting from RootFolder (an O(n) operation), - /// otherwise we'll just put it into folder - /// - /// - private void ItemReceive(InventoryItemBase itemInfo, InventoryFolderImpl folder) - { - // m_log.DebugFormat( - // "[INVENTORY CACHE]: Received item {0} {1} for user {2}", - // itemInfo.Name, itemInfo.ID, userID); - - if (folder == null && RootFolder != null) - folder = RootFolder.FindFolder(itemInfo.Folder); - - if (null == folder) - { - m_log.WarnFormat( - "Received item {0} {1} but its folder {2} does not exist", - itemInfo.Name, itemInfo.ID, itemInfo.Folder); - - return; - } - - lock (folder.Items) - { - folder.Items[itemInfo.ID] = itemInfo; - } - - if (OnItemReceived != null) - OnItemReceived(itemInfo.ID); - } - - /// - /// Create a folder in this agent's inventory. - /// - /// - /// If the inventory service has not yet delievered the inventory - /// for this user then the request will be queued. - /// - /// - /// - public bool CreateFolder(string folderName, UUID folderID, ushort folderType, UUID parentID) - { - // m_log.DebugFormat( - // "[AGENT INVENTORY]: Creating inventory folder {0} {1} for {2} {3}", folderID, folderName, remoteClient.Name, remoteClient.AgentId); - - if (m_hasReceivedInventory) - { - InventoryFolderImpl parentFolder = RootFolder.FindFolder(parentID); - - if (null == parentFolder) - { - m_log.WarnFormat( - "[AGENT INVENTORY]: Tried to create folder {0} {1} but the parent {2} does not exist", - folderName, folderID, parentID); - - return false; - } - - InventoryFolderImpl createdFolder = parentFolder.CreateChildFolder(folderID, folderName, folderType); - - if (createdFolder != null) - { - InventoryFolderBase createdBaseFolder = new InventoryFolderBase(); - createdBaseFolder.Owner = createdFolder.Owner; - createdBaseFolder.ID = createdFolder.ID; - createdBaseFolder.Name = createdFolder.Name; - createdBaseFolder.ParentID = createdFolder.ParentID; - createdBaseFolder.Type = createdFolder.Type; - createdBaseFolder.Version = createdFolder.Version; - - m_InventoryService.AddFolder(createdBaseFolder); - - return true; - } - else - { - m_log.WarnFormat( - "[AGENT INVENTORY]: Tried to create folder {0} {1} but the folder already exists", - folderName, folderID); - - return false; - } - } - else - { - AddRequest( - new InventoryRequest( - Delegate.CreateDelegate(typeof(CreateFolderDelegate), this, "CreateFolder"), - new object[] { folderName, folderID, folderType, parentID })); - - return true; - } - } - - /// - /// Handle a client request to update the inventory folder - /// - /// - /// If the inventory service has not yet delievered the inventory - /// for this user then the request will be queued. - /// - /// 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 bool UpdateFolder(string name, UUID folderID, ushort type, UUID parentID) - { - // m_log.DebugFormat( - // "[AGENT INVENTORY]: Updating inventory folder {0} {1} for {2} {3}", folderID, name, remoteClient.Name, remoteClient.AgentId); - - if (m_hasReceivedInventory) - { - InventoryFolderImpl folder = RootFolder.FindFolder(folderID); - - // Delegate movement if updated parent id isn't the same as the existing parentId - if (folder.ParentID != parentID) - MoveFolder(folderID, parentID); - - InventoryFolderBase baseFolder = new InventoryFolderBase(); - baseFolder.Owner = m_userProfile.ID; - baseFolder.ID = folderID; - baseFolder.Name = name; - baseFolder.ParentID = parentID; - baseFolder.Type = (short)type; - baseFolder.Version = RootFolder.Version; - - m_InventoryService.UpdateFolder(baseFolder); - - folder.Name = name; - folder.Type = (short)type; - } - else - { - AddRequest( - new InventoryRequest( - Delegate.CreateDelegate(typeof(UpdateFolderDelegate), this, "UpdateFolder"), - new object[] { name, folderID, type, parentID })); - } - - return true; - } - - /// - /// Handle an inventory folder move request from the client. - /// - /// If the inventory service has not yet delievered the inventory - /// for this user then the request will be queued. - /// - /// - /// - /// - /// - /// true if the delete was successful, or if it was queued pending folder receipt - /// false if the folder to be deleted did not exist. - /// - public bool MoveFolder(UUID folderID, UUID parentID) - { - // m_log.DebugFormat( - // "[AGENT INVENTORY]: Moving inventory folder {0} into folder {1} for {2} {3}", - // parentID, remoteClient.Name, remoteClient.Name, remoteClient.AgentId); - - if (m_hasReceivedInventory) - { - InventoryFolderBase baseFolder = new InventoryFolderBase(); - baseFolder.Owner = m_userProfile.ID; - baseFolder.ID = folderID; - baseFolder.ParentID = parentID; - - m_InventoryService.MoveFolder(baseFolder); - - InventoryFolderImpl folder = RootFolder.FindFolder(folderID); - InventoryFolderImpl parentFolder = RootFolder.FindFolder(parentID); - if (parentFolder != null && folder != null) - { - InventoryFolderImpl oldParentFolder = RootFolder.FindFolder(folder.ParentID); - - if (oldParentFolder != null) - { - oldParentFolder.RemoveChildFolder(folderID); - parentFolder.AddChildFolder(folder); - } - else - { - return false; - } - } - else - { - return false; - } - - return true; - } - else - { - AddRequest( - new InventoryRequest( - Delegate.CreateDelegate(typeof(MoveFolderDelegate), this, "MoveFolder"), - new object[] { folderID, parentID })); - - return true; - } - } - - /// - /// This method will delete all the items and folders in the given folder. - /// - /// If the inventory service has not yet delievered the inventory - /// for this user then the request will be queued. - /// - /// - public bool PurgeFolder(UUID folderID) - { - // m_log.InfoFormat("[AGENT INVENTORY]: Purging folder {0} for {1} uuid {2}", - // folderID, remoteClient.Name, remoteClient.AgentId); - - if (m_hasReceivedInventory) - { - InventoryFolderImpl purgedFolder = RootFolder.FindFolder(folderID); - - if (purgedFolder != null) - { - // XXX Nasty - have to create a new object to hold details we already have - InventoryFolderBase purgedBaseFolder = new InventoryFolderBase(); - purgedBaseFolder.Owner = purgedFolder.Owner; - purgedBaseFolder.ID = purgedFolder.ID; - purgedBaseFolder.Name = purgedFolder.Name; - purgedBaseFolder.ParentID = purgedFolder.ParentID; - purgedBaseFolder.Type = purgedFolder.Type; - purgedBaseFolder.Version = purgedFolder.Version; - - m_InventoryService.PurgeFolder(purgedBaseFolder); - - purgedFolder.Purge(); - - return true; - } - } - else - { - AddRequest( - new InventoryRequest( - Delegate.CreateDelegate(typeof(PurgeFolderDelegate), this, "PurgeFolder"), - new object[] { folderID })); - - return true; - } - - return false; - } - - /// - /// Add an item to the user's inventory. - /// - /// If the item has no folder set (i.e. it is UUID.Zero), then it is placed in the most appropriate folder - /// for that type. - /// - public void AddItem(InventoryItemBase item) - { - if (m_hasReceivedInventory) - { - if (item.Folder == UUID.Zero) - { - InventoryFolderImpl f = FindFolderForType(item.AssetType); - if (f != null) - item.Folder = f.ID; - else - item.Folder = RootFolder.ID; - } - ItemReceive(item, null); - - m_InventoryService.AddItem(item); - } - else - { - AddRequest( - new InventoryRequest( - Delegate.CreateDelegate(typeof(AddItemDelegate), this, "AddItem"), - new object[] { item })); - } - } - - /// - /// Update an item in the user's inventory - /// - /// - /// - public void UpdateItem(InventoryItemBase item) - { - if (m_hasReceivedInventory) - { - m_InventoryService.UpdateItem(item); - } - else - { - AddRequest( - new InventoryRequest( - Delegate.CreateDelegate(typeof(UpdateItemDelegate), this, "UpdateItem"), - new object[] { item })); - } - } - - /// - /// Delete an item from the user's inventory - /// - /// If the inventory service has not yet delievered the inventory - /// for this user then the request will be queued. - /// - /// - /// - /// true on a successful delete or a if the request is queued. - /// Returns false on an immediate failure - /// - public bool DeleteItem(UUID itemID) - { - if (m_hasReceivedInventory) - { - // XXX For historical reasons (grid comms), we need to retrieve the whole item in order to delete, even though - // really only the item id is required. - InventoryItemBase item = RootFolder.FindItem(itemID); - - if (null == item) - { - m_log.WarnFormat("[AGENT INVENTORY]: Tried to delete item {0} which does not exist", itemID); - - return false; - } - - if (RootFolder.DeleteItem(item.ID)) - { - List uuids = new List(); - uuids.Add(itemID); - return m_InventoryService.DeleteItems(this.UserProfile.ID, uuids); - } - } - else - { - AddRequest( - new InventoryRequest( - Delegate.CreateDelegate(typeof(DeleteItemDelegate), this, "DeleteItem"), - new object[] { itemID })); - - return true; - } - - return false; - } - - /// - /// Send details of the inventory items and/or folders in a given folder to the client. - /// - /// - /// - /// - /// - /// true if the request was queued or successfully processed, false otherwise - public bool SendInventoryDecendents(IClientAPI client, UUID folderID, int version, bool fetchFolders, bool fetchItems) - { - if (m_hasReceivedInventory) - { - InventoryFolderImpl folder; - - if ((folder = RootFolder.FindFolder(folderID)) != null) - { - // m_log.DebugFormat( - // "[AGENT INVENTORY]: Found folder {0} for client {1}", - // folderID, remoteClient.AgentId); - - client.SendInventoryFolderDetails( - client.AgentId, folderID, folder.RequestListOfItems(), - folder.RequestListOfFolders(), version, fetchFolders, fetchItems); - - return true; - } - else - { - m_log.WarnFormat( - "[AGENT INVENTORY]: Could not find folder {0} requested by user {1} {2}", - folderID, client.Name, client.AgentId); - - return false; - } - } - else - { - AddRequest( - new InventoryRequest( - Delegate.CreateDelegate(typeof(SendInventoryDescendentsDelegate), this, "SendInventoryDecendents", false, false), - new object[] { client, folderID, fetchFolders, fetchItems })); - - return true; - } - } - - /// - /// Find an appropriate folder for the given asset type - /// - /// - /// null if no appropriate folder exists - public InventoryFolderImpl FindFolderForType(int type) - { - if (RootFolder == null) - return null; - - return RootFolder.FindFolderForType(type); - } - - // Load additional items that other regions have put into the database - // The item will be added tot he local cache. Returns true if the item - // was found and can be sent to the client - // - public bool QueryItem(InventoryItemBase item) - { - if (m_hasReceivedInventory) - { - InventoryItemBase invItem = RootFolder.FindItem(item.ID); - - if (invItem != null) - { - // Item is in local cache, just update client - // - return true; - } - - InventoryItemBase itemInfo = null; - - itemInfo = m_InventoryService.GetItem(item); - - if (itemInfo != null) - { - InventoryFolderImpl folder = RootFolder.FindFolder(itemInfo.Folder); - ItemReceive(itemInfo, folder); - return true; - } - - return false; - } - else - { - AddRequest( - new InventoryRequest( - Delegate.CreateDelegate(typeof(QueryItemDelegate), this, "QueryItem"), - new object[] { item.ID })); - - return true; - } - } - - public bool QueryFolder(InventoryFolderBase folder) - { - if (m_hasReceivedInventory) - { - InventoryFolderBase invFolder = RootFolder.FindFolder(folder.ID); - - if (invFolder != null) - { - // Folder is in local cache, just update client - // - return true; - } - - InventoryFolderBase folderInfo = null; - - folderInfo = m_InventoryService.GetFolder(folder); - - if (folderInfo != null) - { - InventoryFolderImpl createdFolder = RootFolder.CreateChildFolder(folderInfo.ID, folderInfo.Name, (ushort)folderInfo.Type); - - createdFolder.Version = folderInfo.Version; - createdFolder.Owner = folderInfo.Owner; - createdFolder.ParentID = folderInfo.ParentID; - - return true; - } - - return false; - } - else - { - AddRequest( - new InventoryRequest( - Delegate.CreateDelegate(typeof(QueryFolderDelegate), this, "QueryFolder"), - new object[] { folder.ID })); - - return true; - } - } - } - - /// - /// Should be implemented by callers which require a callback when the user's inventory is received - /// - public interface IInventoryRequest - { - /// - /// This is the method executed once we have received the user's inventory by which the request can be fulfilled. - /// - void Execute(); - } - - /// - /// Generic inventory request - /// - class InventoryRequest : IInventoryRequest - { - private Delegate m_delegate; - private Object[] m_args; - - internal InventoryRequest(Delegate delegat, Object[] args) - { - m_delegate = delegat; - m_args = args; - } - - public void Execute() - { - if (m_delegate != null) - m_delegate.DynamicInvoke(m_args); - } - } -} diff --git a/OpenSim/Framework/Communications/Cache/UserProfileCacheService.cs b/OpenSim/Framework/Communications/Cache/UserProfileCacheService.cs deleted file mode 100644 index acae4b1..0000000 --- a/OpenSim/Framework/Communications/Cache/UserProfileCacheService.cs +++ /dev/null @@ -1,277 +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 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.Collections.Generic; -using System.Reflection; -using log4net; -using OpenMetaverse; -using OpenSim.Services.Interfaces; - -namespace OpenSim.Framework.Communications.Cache -{ - /// - /// Holds user profile information and retrieves it from backend services. - /// - public class UserProfileCacheService - { - private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType); - - /// - /// Standard format for names. - /// - public const string NAME_FORMAT = "{0} {1}"; - - /// - /// The comms manager holds references to services (user, grid, inventory, etc.) - /// - private readonly CommunicationsManager m_commsManager; - - /// - /// User profiles indexed by UUID - /// - private readonly Dictionary m_userProfilesById - = new Dictionary(); - - /// - /// User profiles indexed by name - /// - private readonly Dictionary m_userProfilesByName - = new Dictionary(); - - /// - /// The root library folder. - /// - public readonly InventoryFolderImpl LibraryRoot; - - private IInventoryService m_InventoryService; - - /// - /// Constructor - /// - /// - /// - public UserProfileCacheService(CommunicationsManager commsManager, LibraryRootFolder libraryRootFolder) - { - m_commsManager = commsManager; - LibraryRoot = libraryRootFolder; - } - - public void SetInventoryService(IInventoryService invService) - { - m_InventoryService = invService; - } - - /// - /// A new user has moved into a region in this instance so retrieve their profile from the user service. - /// - /// - /// It isn't strictly necessary to make this call since user data can be lazily requested later on. However, - /// it might be helpful in order to avoid an initial response delay later on - /// - /// - public void AddNewUser(UUID userID) - { - if (userID == UUID.Zero) - return; - - //m_log.DebugFormat("[USER CACHE]: Adding user profile for {0}", userID); - GetUserDetails(userID); - } - - /// - /// Remove this user's profile cache. - /// - /// - /// true if the user was successfully removed, false otherwise - public bool RemoveUser(UUID userId) - { - if (!RemoveFromCaches(userId)) - { - m_log.WarnFormat( - "[USER CACHE]: Tried to remove the profile of user {0}, but this was not in the scene", userId); - - return false; - } - - return true; - } - - /// - /// Get details of the given user. - /// - /// If the user isn't in cache then the user is requested from the profile service. - /// - /// null if no user details are found - public CachedUserInfo GetUserDetails(string fname, string lname) - { - lock (m_userProfilesByName) - { - CachedUserInfo userInfo; - - if (m_userProfilesByName.TryGetValue(string.Format(NAME_FORMAT, fname, lname), out userInfo)) - { - return userInfo; - } - else - { - UserProfileData userProfile = m_commsManager.UserService.GetUserProfile(fname, lname); - - if (userProfile != null) - { - - if ((userProfile.UserAssetURI == null || userProfile.UserAssetURI == "") && m_commsManager.NetworkServersInfo != null) - userProfile.UserAssetURI = m_commsManager.NetworkServersInfo.AssetURL; - if ((userProfile.UserInventoryURI == null || userProfile.UserInventoryURI == "") && m_commsManager.NetworkServersInfo != null) - userProfile.UserInventoryURI = m_commsManager.NetworkServersInfo.InventoryURL; - - return AddToCaches(userProfile); - } - else - return null; - } - } - } - - /// - /// Get details of the given user. - /// - /// If the user isn't in cache then the user is requested from the profile service. - /// - /// null if no user details are found - public CachedUserInfo GetUserDetails(UUID userID) - { - if (userID == UUID.Zero) - return null; - - lock (m_userProfilesById) - { - if (m_userProfilesById.ContainsKey(userID)) - { - return m_userProfilesById[userID]; - } - else - { - UserProfileData userProfile = m_commsManager.UserService.GetUserProfile(userID); - if (userProfile != null) - { - - if ((userProfile.UserAssetURI == null || userProfile.UserAssetURI == "") && m_commsManager.NetworkServersInfo != null) - userProfile.UserAssetURI = m_commsManager.NetworkServersInfo.AssetURL; - if ((userProfile.UserInventoryURI == null || userProfile.UserInventoryURI == "") && m_commsManager.NetworkServersInfo != null) - userProfile.UserInventoryURI = m_commsManager.NetworkServersInfo.InventoryURL; - - return AddToCaches(userProfile); - } - else - return null; - } - } - } - - /// - /// Update an existing profile - /// - /// - /// true if a user profile was found to update, false otherwise - // Commented out for now. The implementation needs to be improved by protecting against race conditions, - // probably by making sure that the update doesn't use the UserCacheInfo.UserProfile directly (possibly via - // returning a read only class from the cache). -// public bool StoreProfile(UserProfileData userProfile) -// { -// lock (m_userProfilesById) -// { -// CachedUserInfo userInfo = GetUserDetails(userProfile.ID); -// -// if (userInfo != null) -// { -// userInfo.m_userProfile = userProfile; -// m_commsManager.UserService.UpdateUserProfile(userProfile); -// -// return true; -// } -// } -// -// return false; -// } - - /// - /// Populate caches with the given user profile - /// - /// - protected CachedUserInfo AddToCaches(UserProfileData userProfile) - { - CachedUserInfo createdUserInfo = new CachedUserInfo(m_InventoryService, userProfile); - - lock (m_userProfilesById) - { - m_userProfilesById[createdUserInfo.UserProfile.ID] = createdUserInfo; - - lock (m_userProfilesByName) - { - m_userProfilesByName[createdUserInfo.UserProfile.Name] = createdUserInfo; - } - } - - return createdUserInfo; - } - - /// - /// Remove profile belong to the given uuid from the caches - /// - /// - /// true if there was a profile to remove, false otherwise - protected bool RemoveFromCaches(UUID userId) - { - lock (m_userProfilesById) - { - if (m_userProfilesById.ContainsKey(userId)) - { - CachedUserInfo userInfo = m_userProfilesById[userId]; - m_userProfilesById.Remove(userId); - - lock (m_userProfilesByName) - { - m_userProfilesByName.Remove(userInfo.UserProfile.Name); - } - - return true; - } - } - - return false; - } - - /// - /// Preloads User data into the region cache. Modules may use this service to add non-standard clients - /// - /// - public void PreloadUserCache(UserProfileData userData) - { - AddToCaches(userData); - } - } -} -- cgit v1.1 From c5ea783526611a968400a1936e4c6764ee1c7013 Mon Sep 17 00:00:00 2001 From: Diva Canto Date: Mon, 11 Jan 2010 07:51:33 -0800 Subject: OpenSim/Framework/Communications/Cache deleted. LibraryRootFolder deleted. --- .../Communications/Cache/LibraryRootFolder.cs | 257 --------------------- 1 file changed, 257 deletions(-) delete mode 100644 OpenSim/Framework/Communications/Cache/LibraryRootFolder.cs (limited to 'OpenSim/Framework/Communications/Cache') diff --git a/OpenSim/Framework/Communications/Cache/LibraryRootFolder.cs b/OpenSim/Framework/Communications/Cache/LibraryRootFolder.cs deleted file mode 100644 index 74ba0a5..0000000 --- a/OpenSim/Framework/Communications/Cache/LibraryRootFolder.cs +++ /dev/null @@ -1,257 +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 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.Collections.Generic; -using System.IO; -using System.Reflection; -using System.Xml; -using log4net; -using Nini.Config; -using OpenMetaverse; - -namespace OpenSim.Framework.Communications.Cache -{ - /// - /// Basically a hack to give us a Inventory library while we don't have a inventory server - /// once the server is fully implemented then should read the data from that - /// - public class LibraryRootFolder : InventoryFolderImpl - { - private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType); - - private UUID libOwner = new UUID("11111111-1111-0000-0000-000100bba000"); - - /// - /// Holds the root library folder and all its descendents. This is really only used during inventory - /// setup so that we don't have to repeatedly search the tree of library folders. - /// - protected Dictionary libraryFolders - = new Dictionary(); - - public LibraryRootFolder(string pLibrariesLocation) - { - Owner = libOwner; - ID = new UUID("00000112-000f-0000-0000-000100bba000"); - Name = "OpenSim Library"; - ParentID = UUID.Zero; - Type = (short) 8; - Version = (ushort) 1; - - libraryFolders.Add(ID, this); - - LoadLibraries(pLibrariesLocation); - } - - public InventoryItemBase CreateItem(UUID inventoryID, UUID assetID, string name, string description, - int assetType, int invType, UUID parentFolderID) - { - InventoryItemBase item = new InventoryItemBase(); - item.Owner = libOwner; - item.CreatorId = libOwner.ToString(); - item.ID = inventoryID; - item.AssetID = assetID; - item.Description = description; - item.Name = name; - item.AssetType = assetType; - item.InvType = invType; - item.Folder = parentFolderID; - item.BasePermissions = 0x7FFFFFFF; - item.EveryOnePermissions = 0x7FFFFFFF; - item.CurrentPermissions = 0x7FFFFFFF; - item.NextPermissions = 0x7FFFFFFF; - return item; - } - - /// - /// Use the asset set information at path to load assets - /// - /// - /// - protected void LoadLibraries(string librariesControlPath) - { - m_log.InfoFormat("[LIBRARY INVENTORY]: Loading library control file {0}", librariesControlPath); - LoadFromFile(librariesControlPath, "Libraries control", ReadLibraryFromConfig); - } - - /// - /// Read a library set from config - /// - /// - protected void ReadLibraryFromConfig(IConfig config, string path) - { - string basePath = Path.GetDirectoryName(path); - string foldersPath - = Path.Combine( - basePath, config.GetString("foldersFile", String.Empty)); - - LoadFromFile(foldersPath, "Library folders", ReadFolderFromConfig); - - string itemsPath - = Path.Combine( - basePath, config.GetString("itemsFile", String.Empty)); - - LoadFromFile(itemsPath, "Library items", ReadItemFromConfig); - } - - /// - /// Read a library inventory folder from a loaded configuration - /// - /// - private void ReadFolderFromConfig(IConfig config, string path) - { - InventoryFolderImpl folderInfo = new InventoryFolderImpl(); - - folderInfo.ID = new UUID(config.GetString("folderID", ID.ToString())); - folderInfo.Name = config.GetString("name", "unknown"); - folderInfo.ParentID = new UUID(config.GetString("parentFolderID", ID.ToString())); - folderInfo.Type = (short)config.GetInt("type", 8); - - folderInfo.Owner = libOwner; - folderInfo.Version = 1; - - if (libraryFolders.ContainsKey(folderInfo.ParentID)) - { - InventoryFolderImpl parentFolder = libraryFolders[folderInfo.ParentID]; - - libraryFolders.Add(folderInfo.ID, folderInfo); - parentFolder.AddChildFolder(folderInfo); - -// m_log.InfoFormat("[LIBRARY INVENTORY]: Adding folder {0} ({1})", folderInfo.name, folderInfo.folderID); - } - else - { - m_log.WarnFormat( - "[LIBRARY INVENTORY]: Couldn't add folder {0} ({1}) since parent folder with ID {2} does not exist!", - folderInfo.Name, folderInfo.ID, folderInfo.ParentID); - } - } - - /// - /// Read a library inventory item metadata from a loaded configuration - /// - /// - private void ReadItemFromConfig(IConfig config, string path) - { - InventoryItemBase item = new InventoryItemBase(); - item.Owner = libOwner; - item.CreatorId = libOwner.ToString(); - item.ID = new UUID(config.GetString("inventoryID", ID.ToString())); - item.AssetID = new UUID(config.GetString("assetID", item.ID.ToString())); - item.Folder = new UUID(config.GetString("folderID", ID.ToString())); - item.Name = config.GetString("name", String.Empty); - item.Description = config.GetString("description", item.Name); - item.InvType = config.GetInt("inventoryType", 0); - item.AssetType = config.GetInt("assetType", item.InvType); - item.CurrentPermissions = (uint)config.GetLong("currentPermissions", 0x7FFFFFFF); - item.NextPermissions = (uint)config.GetLong("nextPermissions", 0x7FFFFFFF); - item.EveryOnePermissions = (uint)config.GetLong("everyonePermissions", 0x7FFFFFFF); - item.BasePermissions = (uint)config.GetLong("basePermissions", 0x7FFFFFFF); - item.Flags = (uint)config.GetInt("flags", 0); - - if (libraryFolders.ContainsKey(item.Folder)) - { - InventoryFolderImpl parentFolder = libraryFolders[item.Folder]; - try - { - parentFolder.Items.Add(item.ID, item); - } - catch (Exception) - { - m_log.WarnFormat("[LIBRARY INVENTORY] Item {1} [{0}] not added, duplicate item", item.ID, item.Name); - } - } - else - { - m_log.WarnFormat( - "[LIBRARY INVENTORY]: Couldn't add item {0} ({1}) since parent folder with ID {2} does not exist!", - item.Name, item.ID, item.Folder); - } - } - - private delegate void ConfigAction(IConfig config, string path); - - /// - /// Load the given configuration at a path and perform an action on each Config contained within it - /// - /// - /// - /// - private static void LoadFromFile(string path, string fileDescription, ConfigAction action) - { - if (File.Exists(path)) - { - try - { - XmlConfigSource source = new XmlConfigSource(path); - - for (int i = 0; i < source.Configs.Count; i++) - { - action(source.Configs[i], path); - } - } - catch (XmlException e) - { - m_log.ErrorFormat("[LIBRARY INVENTORY]: Error loading {0} : {1}", path, e); - } - } - else - { - m_log.ErrorFormat("[LIBRARY INVENTORY]: {0} file {1} does not exist!", fileDescription, path); - } - } - - /// - /// Looks like a simple getter, but is written like this for some consistency with the other Request - /// methods in the superclass - /// - /// - public Dictionary RequestSelfAndDescendentFolders() - { - Dictionary fs = new Dictionary(); - fs.Add(ID, this); - List fis = TraverseFolder(this); - foreach (InventoryFolderImpl f in fis) - { - fs.Add(f.ID, f); - } - //return libraryFolders; - return fs; - } - - private List TraverseFolder(InventoryFolderImpl node) - { - List folders = node.RequestListOfFolderImpls(); - List subs = new List(); - foreach (InventoryFolderImpl f in folders) - subs.AddRange(TraverseFolder(f)); - - folders.AddRange(subs); - return folders; - } - } -} -- cgit v1.1