/* * 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 System.Collections.Generic; using System.Threading; using libsecondlife; using OpenSim.Framework.Console; namespace OpenSim.Framework.Communications.Cache { public class UserProfileCacheService { private static readonly log4net.ILog m_log = log4net.LogManager.GetLogger(System.Reflection.MethodBase.GetCurrentMethod().DeclaringType); // Fields private readonly CommunicationsManager m_parent; private readonly Dictionary<LLUUID, CachedUserInfo> m_userProfiles = new Dictionary<LLUUID, CachedUserInfo>(); public LibraryRootFolder libraryRoot = new LibraryRootFolder(); // Methods public UserProfileCacheService(CommunicationsManager parent) { m_parent = parent; } /// <summary> /// A new user has moved into a region in this instance /// so get info from servers /// </summary> /// <param name="userID"></param> public void AddNewUser(LLUUID userID) { // Potential fix - Multithreading issue. lock (m_userProfiles) { if (!m_userProfiles.ContainsKey(userID)) { CachedUserInfo userInfo = new CachedUserInfo(m_parent); userInfo.UserProfile = m_parent.UserService.GetUserProfile(userID); if (userInfo.UserProfile != null) { // The inventory will be populated when the user actually enters the scene m_userProfiles.Add(userID, userInfo); } else { m_log.ErrorFormat("[USER CACHE]: User profile for user {0} not found", userID); } } } } public void UpdateUserInventory(LLUUID userID) { CachedUserInfo userInfo = GetUserDetails(userID); if (userInfo != null) { RequestInventoryForUser(userID, userInfo); } } public CachedUserInfo GetUserDetails(LLUUID userID) { if (m_userProfiles.ContainsKey(userID)) return m_userProfiles[userID]; else return null; } public void HandleCreateInventoryFolder(IClientAPI remoteClient, LLUUID folderID, ushort folderType, string folderName, LLUUID parentID) { CachedUserInfo userProfile; if (m_userProfiles.TryGetValue(remoteClient.AgentId, out userProfile)) { if (userProfile.RootFolder != null) { if (userProfile.RootFolder.ID == parentID) { InventoryFolderImpl createdFolder = userProfile.RootFolder.CreateNewSubFolder(folderID, folderName, folderType); if (createdFolder != null) { InventoryFolderBase createdBaseFolder = new InventoryFolderBase(); createdBaseFolder.AgentID = createdFolder.AgentID; createdBaseFolder.ID = createdFolder.ID; createdBaseFolder.Name = createdFolder.Name; createdBaseFolder.ParentID = createdFolder.ParentID; createdBaseFolder.Type = createdFolder.Type; createdBaseFolder.Version = createdFolder.Version; m_parent.InventoryService.AddNewInventoryFolder(remoteClient.AgentId, createdBaseFolder); } } else { InventoryFolderImpl folder = userProfile.RootFolder.HasSubFolder(parentID); if (folder != null) { folder.CreateNewSubFolder(folderID, folderName, folderType); } } } } } /// <summary> /// 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. /// </summary> /// <param name="remoteClient"></param> /// <param name="folderID"></param> /// <param name="type"></param> /// <param name="name"></param> /// <param name="parentID"></param> public void HandleUpdateInventoryFolder(IClientAPI remoteClient, LLUUID folderID, ushort type, string name, LLUUID parentID) { CachedUserInfo userProfile; if (m_userProfiles.TryGetValue(remoteClient.AgentId, out userProfile)) { if (userProfile.RootFolder != null) { InventoryFolderBase baseFolder = new InventoryFolderBase(); baseFolder.AgentID = remoteClient.AgentId; baseFolder.ID = folderID; baseFolder.Name = name; baseFolder.ParentID = parentID; baseFolder.Type = (short) type; baseFolder.Version = userProfile.RootFolder.Version; m_parent.InventoryService.AddNewInventoryFolder(remoteClient.AgentId, baseFolder); } } } public void HandleMoveInventoryFolder(IClientAPI remoteClient, LLUUID folderID, LLUUID parentID) { CachedUserInfo userProfile; if (m_userProfiles.TryGetValue(remoteClient.AgentId, out userProfile)) { if (userProfile.RootFolder != null) { InventoryFolderBase baseFolder = new InventoryFolderBase(); baseFolder.AgentID = remoteClient.AgentId; baseFolder.ID = folderID; baseFolder.ParentID = parentID; m_parent.InventoryService.MoveInventoryFolder(remoteClient.AgentId, baseFolder); } } } /// <summary> /// Tell the client about the various child items and folders contained in the requested folder. /// </summary> /// <param name="remoteClient"></param> /// <param name="folderID"></param> /// <param name="ownerID"></param> /// <param name="fetchFolders"></param> /// <param name="fetchItems"></param> /// <param name="sortOrder"></param> public void HandleFetchInventoryDescendents(IClientAPI remoteClient, LLUUID folderID, LLUUID ownerID, bool fetchFolders, bool fetchItems, int sortOrder) { // XXX We're not handling sortOrder yet! InventoryFolderImpl fold = null; if (folderID == libraryRoot.ID) { remoteClient.SendInventoryFolderDetails( libraryRoot.AgentID, libraryRoot.ID, libraryRoot.RequestListOfItems(), libraryRoot.RequestListOfFolders(), fetchFolders, fetchItems); return; } if ((fold = libraryRoot.HasSubFolder(folderID)) != null) { remoteClient.SendInventoryFolderDetails( libraryRoot.AgentID, folderID, fold.RequestListOfItems(), fold.RequestListOfFolders(), fetchFolders, fetchItems); return; } CachedUserInfo userProfile; if (m_userProfiles.TryGetValue(remoteClient.AgentId, out userProfile)) { // XXX: When a client crosses into a scene, their entire inventory is fetched // asynchronously. However, if the client is logging on and does not have a cached root // folder, then the root folder request usually comes in *before* the async completes, leading to // inventory failure. // // This is a crude way of dealing with that by retrying the lookup. if (userProfile.RootFolder == null) { int attempts = 5; while (attempts-- > 0) { Thread.Sleep(3000); if (userProfile.RootFolder != null) { break; } } } if (userProfile.RootFolder != null) { if (userProfile.RootFolder.ID == folderID) { // m_log.DebugFormat( // "[AGENT INVENTORY]: Found root folder {0} for client {1}", // folderID, remoteClient.AgentId); remoteClient.SendInventoryFolderDetails( remoteClient.AgentId, folderID, userProfile.RootFolder.RequestListOfItems(), userProfile.RootFolder.RequestListOfFolders(), fetchFolders, fetchItems); return; } else { if ((fold = userProfile.RootFolder.HasSubFolder(folderID)) != null) { // m_log.DebugFormat( // "[AGENT INVENTORY]: Found folder {0} for client {1}", // folderID, remoteClient.AgentId); remoteClient.SendInventoryFolderDetails( remoteClient.AgentId, folderID, fold.RequestListOfItems(), fold.RequestListOfFolders(), fetchFolders, fetchItems); return; } } } else { m_log.ErrorFormat("[INVENTORY CACHE]: Could not find root folder for user {0}", remoteClient.Name); return; } } else { m_log.ErrorFormat("[INVENTORY CACHE]: Could not find user profile for {0} for folder {1}", remoteClient.Name, folderID); return; } // If we've reached this point then we couldn't find the folder, even though the client thinks // it exists m_log.ErrorFormat("[INVENTORY CACHE]: Could not find folder {0} for user {1}", folderID, remoteClient.Name); } public List<InventoryItemBase> HandleFetchInventoryDescendentsCAPS(LLUUID agentID, LLUUID folderID, LLUUID ownerID, bool fetchFolders, bool fetchItems, int sortOrder) { // XXX We're not handling sortOrder yet! // with CAPS we are only return items in the folders at the moment // need to find the format that sub folder details are sent in // if (fetchItems) // { InventoryFolderImpl fold = null; if (folderID == libraryRoot.ID) { return libraryRoot.RequestListOfItems(); } if ((fold = libraryRoot.HasSubFolder(folderID)) != null) { return fold.RequestListOfItems(); } CachedUserInfo userProfile; if (m_userProfiles.TryGetValue(agentID, out userProfile)) { if (userProfile.RootFolder != null) { if (userProfile.RootFolder.ID == folderID) { return userProfile.RootFolder.RequestListOfItems(); } else { if ((fold = userProfile.RootFolder.HasSubFolder(folderID)) != null) { return fold.RequestListOfItems(); } } } else { m_log.ErrorFormat("[INVENTORY CACHE]: Could not find root folder for user {0}", agentID.ToString()); return new List<InventoryItemBase>(); ; } } else { m_log.ErrorFormat("[INVENTORY CACHE]: " + "Could not find user profile for {0} for folder {1}", agentID.ToString(), folderID); return new List<InventoryItemBase>(); } // If we've reached this point then we couldn't find the folder, even though the client thinks // it exists m_log.ErrorFormat("[INVENTORY CACHE]: " + "Could not find folder {0} for user {1}", folderID, agentID.ToString()); // } return new List<InventoryItemBase>(); } public void HandlePurgeInventoryDescendents(IClientAPI remoteClient, LLUUID folderID) { // m_log.InfoFormat("[INVENTORYCACHE]: Purging folder {0} for {1} uuid {2}", // folderID, remoteClient.Name, remoteClient.AgentId); CachedUserInfo userProfile; if (m_userProfiles.TryGetValue(remoteClient.AgentId, out userProfile)) { if (userProfile.RootFolder != null) { InventoryFolderImpl subFolder = userProfile.RootFolder.HasSubFolder(folderID); if (subFolder != null) { List<InventoryItemBase> items = subFolder.RequestListOfItems(); foreach (InventoryItemBase item in items) { userProfile.DeleteItem(remoteClient.AgentId, item); } } } } } public void HandleFetchInventory(IClientAPI remoteClient, LLUUID itemID, LLUUID ownerID) { if (ownerID == libraryRoot.AgentID) { //Console.WriteLine("request info for library item"); return; } CachedUserInfo userProfile; if (m_userProfiles.TryGetValue(remoteClient.AgentId, out userProfile)) { if (userProfile.RootFolder != null) { InventoryItemBase item = userProfile.RootFolder.HasItem(itemID); if (item != null) { remoteClient.SendInventoryItemDetails(ownerID, item); } } } } private void RequestInventoryForUser(LLUUID userID, CachedUserInfo userInfo) { m_parent.InventoryService.RequestInventoryForUser(userID, userInfo.FolderReceive, userInfo.ItemReceive); } } }