/* * 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.Linq; using OpenMetaverse; using log4net; using Nini.Config; using System.Reflection; using OpenSim.Services.Base; using OpenSim.Services.Interfaces; using OpenSim.Services.InventoryService; using OpenSim.Data; using OpenSim.Framework; using OpenSim.Server.Base; namespace OpenSim.Services.HypergridService { /// <summary> /// Hypergrid inventory service. It serves the IInventoryService interface, /// but implements it in ways that are appropriate for inter-grid /// inventory exchanges. Specifically, it does not performs deletions /// and it responds to GetRootFolder requests with the ID of the /// Suitcase folder, not the actual "My Inventory" folder. /// </summary> public class HGSuitcaseInventoryService : XInventoryService, IInventoryService { private static readonly ILog m_log = LogManager.GetLogger( MethodBase.GetCurrentMethod().DeclaringType); private string m_HomeURL; private IUserAccountService m_UserAccountService; private IAvatarService m_AvatarService; // private UserAccountCache m_Cache; private ExpiringCache<UUID, List<XInventoryFolder>> m_SuitcaseTrees = new ExpiringCache<UUID, List<XInventoryFolder>>(); private ExpiringCache<UUID, AvatarAppearance> m_Appearances = new ExpiringCache<UUID, AvatarAppearance>(); public HGSuitcaseInventoryService(IConfigSource config, string configName) : base(config, configName) { m_log.DebugFormat("[HG SUITCASE INVENTORY SERVICE]: Starting with config name {0}", configName); if (configName != string.Empty) m_ConfigName = configName; if (m_Database == null) m_log.ErrorFormat("[HG SUITCASE INVENTORY SERVICE]: m_Database is null!"); // // Try reading the [InventoryService] section, if it exists // IConfig invConfig = config.Configs[m_ConfigName]; if (invConfig != null) { string userAccountsDll = invConfig.GetString("UserAccountsService", string.Empty); if (userAccountsDll == string.Empty) throw new Exception("Please specify UserAccountsService in HGInventoryService configuration"); Object[] args = new Object[] { config }; m_UserAccountService = ServerUtils.LoadPlugin<IUserAccountService>(userAccountsDll, args); if (m_UserAccountService == null) throw new Exception(String.Format("Unable to create UserAccountService from {0}", userAccountsDll)); string avatarDll = invConfig.GetString("AvatarService", string.Empty); if (avatarDll == string.Empty) throw new Exception("Please specify AvatarService in HGInventoryService configuration"); m_AvatarService = ServerUtils.LoadPlugin<IAvatarService>(avatarDll, args); if (m_AvatarService == null) throw new Exception(String.Format("Unable to create m_AvatarService from {0}", avatarDll)); m_HomeURL = Util.GetConfigVarFromSections<string>(config, "HomeURI", new string[] { "Startup", "Hypergrid", m_ConfigName }, String.Empty); // m_Cache = UserAccountCache.CreateUserAccountCache(m_UserAccountService); } m_log.Debug("[HG SUITCASE INVENTORY SERVICE]: Starting..."); } public override bool CreateUserInventory(UUID principalID) { // NOGO return false; } public override List<InventoryFolderBase> GetInventorySkeleton(UUID principalID) { XInventoryFolder suitcase = GetSuitcaseXFolder(principalID); List<XInventoryFolder> tree = GetFolderTree(principalID, suitcase.folderID); if (tree == null || (tree != null && tree.Count == 0)) return null; List<InventoryFolderBase> folders = new List<InventoryFolderBase>(); foreach (XInventoryFolder x in tree) { folders.Add(ConvertToOpenSim(x)); } SetAsNormalFolder(suitcase); folders.Add(ConvertToOpenSim(suitcase)); return folders; } public override InventoryCollection GetUserInventory(UUID userID) { m_log.DebugFormat("[HG SUITCASE INVENTORY SERVICE]: Get Suitcase inventory for user {0}", userID); InventoryCollection userInventory = new InventoryCollection(); userInventory.UserID = userID; userInventory.Folders = new List<InventoryFolderBase>(); userInventory.Items = new List<InventoryItemBase>(); XInventoryFolder suitcase = GetSuitcaseXFolder(userID); List<XInventoryFolder> tree = GetFolderTree(userID, suitcase.folderID); if (tree == null || (tree != null && tree.Count == 0)) { SetAsNormalFolder(suitcase); userInventory.Folders.Add(ConvertToOpenSim(suitcase)); return userInventory; } List<InventoryItemBase> items; foreach (XInventoryFolder f in tree) { // Add the items of this subfolder items = GetFolderItems(userID, f.folderID); if (items != null && items.Count > 0) { userInventory.Items.AddRange(items); } // Add the folder itself userInventory.Folders.Add(ConvertToOpenSim(f)); } items = GetFolderItems(userID, suitcase.folderID); if (items != null && items.Count > 0) { userInventory.Items.AddRange(items); } SetAsNormalFolder(suitcase); userInventory.Folders.Add(ConvertToOpenSim(suitcase)); m_log.DebugFormat("[HG SUITCASE INVENTORY SERVICE]: GetUserInventory for user {0} returning {1} folders and {2} items", userID, userInventory.Folders.Count, userInventory.Items.Count); return userInventory; } public override InventoryFolderBase GetRootFolder(UUID principalID) { m_log.DebugFormat("[HG SUITCASE INVENTORY SERVICE]: GetRootFolder for {0}", principalID); // Let's find out the local root folder XInventoryFolder root = GetRootXFolder(principalID); ; if (root == null) { m_log.WarnFormat("[HG SUITCASE INVENTORY SERVICE]: Unable to retrieve local root folder for user {0}", principalID); return null; } // Warp! Root folder for travelers is the suitcase folder XInventoryFolder suitcase = GetSuitcaseXFolder(principalID); if (suitcase == null) { m_log.DebugFormat("[HG SUITCASE INVENTORY SERVICE]: User {0} does not have a Suitcase folder. Creating it...", principalID); // make one, and let's add it to the user's inventory as a direct child of the root folder // In the DB we tag it as type 100, but we use -1 (Unknown) outside suitcase = CreateFolder(principalID, root.folderID, 100, "My Suitcase"); if (suitcase == null) m_log.ErrorFormat("[HG SUITCASE INVENTORY SERVICE]: Unable to create suitcase folder"); m_Database.StoreFolder(suitcase); // Create System folders CreateSystemFolders(principalID, suitcase.folderID); } SetAsNormalFolder(suitcase); return ConvertToOpenSim(suitcase); } protected void CreateSystemFolders(UUID principalID, UUID rootID) { m_log.Debug("[HG SUITCASE INVENTORY SERVICE]: Creating System folders under Suitcase..."); XInventoryFolder[] sysFolders = GetSystemFolders(principalID, rootID); if (!Array.Exists(sysFolders, delegate(XInventoryFolder f) { if (f.type == (int)AssetType.Animation) return true; return false; })) CreateFolder(principalID, rootID, (int)AssetType.Animation, "Animations"); if (!Array.Exists(sysFolders, delegate(XInventoryFolder f) { if (f.type == (int)AssetType.Bodypart) return true; return false; })) CreateFolder(principalID, rootID, (int)AssetType.Bodypart, "Body Parts"); if (!Array.Exists(sysFolders, delegate(XInventoryFolder f) { if (f.type == (int)AssetType.CallingCard) return true; return false; })) CreateFolder(principalID, rootID, (int)AssetType.CallingCard, "Calling Cards"); if (!Array.Exists(sysFolders, delegate(XInventoryFolder f) { if (f.type == (int)AssetType.Clothing) return true; return false; })) CreateFolder(principalID, rootID, (int)AssetType.Clothing, "Clothing"); if (!Array.Exists(sysFolders, delegate(XInventoryFolder f) { if (f.type == (int)AssetType.Gesture) return true; return false; })) CreateFolder(principalID, rootID, (int)AssetType.Gesture, "Gestures"); if (!Array.Exists(sysFolders, delegate(XInventoryFolder f) { if (f.type == (int)AssetType.Landmark) return true; return false; })) CreateFolder(principalID, rootID, (int)AssetType.Landmark, "Landmarks"); if (!Array.Exists(sysFolders, delegate(XInventoryFolder f) { if (f.type == (int)AssetType.LostAndFoundFolder) return true; return false; })) CreateFolder(principalID, rootID, (int)AssetType.LostAndFoundFolder, "Lost And Found"); if (!Array.Exists(sysFolders, delegate(XInventoryFolder f) { if (f.type == (int)AssetType.Notecard) return true; return false; })) CreateFolder(principalID, rootID, (int)AssetType.Notecard, "Notecards"); if (!Array.Exists(sysFolders, delegate(XInventoryFolder f) { if (f.type == (int)AssetType.Object) return true; return false; })) CreateFolder(principalID, rootID, (int)AssetType.Object, "Objects"); if (!Array.Exists(sysFolders, delegate(XInventoryFolder f) { if (f.type == (int)AssetType.SnapshotFolder) return true; return false; })) CreateFolder(principalID, rootID, (int)AssetType.SnapshotFolder, "Photo Album"); if (!Array.Exists(sysFolders, delegate(XInventoryFolder f) { if (f.type == (int)AssetType.LSLText) return true; return false; })) CreateFolder(principalID, rootID, (int)AssetType.LSLText, "Scripts"); if (!Array.Exists(sysFolders, delegate(XInventoryFolder f) { if (f.type == (int)AssetType.Sound) return true; return false; })) CreateFolder(principalID, rootID, (int)AssetType.Sound, "Sounds"); if (!Array.Exists(sysFolders, delegate(XInventoryFolder f) { if (f.type == (int)AssetType.Texture) return true; return false; })) CreateFolder(principalID, rootID, (int)AssetType.Texture, "Textures"); if (!Array.Exists(sysFolders, delegate(XInventoryFolder f) { if (f.type == (int)AssetType.TrashFolder) return true; return false; })) CreateFolder(principalID, rootID, (int)AssetType.TrashFolder, "Trash"); if (!Array.Exists(sysFolders, delegate(XInventoryFolder f) { if (f.type == (int)AssetType.FavoriteFolder) return true; return false; })) CreateFolder(principalID, rootID, (int)AssetType.FavoriteFolder, "Favorites"); if (!Array.Exists(sysFolders, delegate(XInventoryFolder f) { if (f.type == (int)AssetType.CurrentOutfitFolder) return true; return false; })) CreateFolder(principalID, rootID, (int)AssetType.CurrentOutfitFolder, "Current Outfit"); } public override InventoryFolderBase GetFolderForType(UUID principalID, AssetType type) { //m_log.DebugFormat("[HG INVENTORY SERVICE]: GetFolderForType for {0} {0}", principalID, type); XInventoryFolder suitcase = GetSuitcaseXFolder(principalID); XInventoryFolder[] folders = m_Database.GetFolders( new string[] { "agentID", "type", "parentFolderID" }, new string[] { principalID.ToString(), ((int)type).ToString(), suitcase.folderID.ToString() }); if (folders.Length == 0) { m_log.WarnFormat("[HG SUITCASE INVENTORY SERVICE]: Found no folder for type {0} for user {1}", type, principalID); return null; } m_log.DebugFormat( "[HG SUITCASE INVENTORY SERVICE]: Found folder {0} {1} for type {2} for user {3}", folders[0].folderName, folders[0].folderID, type, principalID); return ConvertToOpenSim(folders[0]); } public override InventoryCollection GetFolderContent(UUID principalID, UUID folderID) { InventoryCollection coll = null; if (!IsWithinSuitcaseTree(principalID, folderID)) return new InventoryCollection(); coll = base.GetFolderContent(principalID, folderID); if (coll == null) { m_log.WarnFormat("[HG SUITCASE INVENTORY SERVICE]: Something wrong with user {0}'s suitcase folder", principalID); coll = new InventoryCollection(); } return coll; } public override List<InventoryItemBase> GetFolderItems(UUID principalID, UUID folderID) { // Let's do a bit of sanity checking, more than the base service does // make sure the given folder exists under the suitcase tree of this user if (!IsWithinSuitcaseTree(principalID, folderID)) return new List<InventoryItemBase>(); return base.GetFolderItems(principalID, folderID); } public override bool AddFolder(InventoryFolderBase folder) { //m_log.WarnFormat("[HG SUITCASE INVENTORY SERVICE]: AddFolder {0} {1}", folder.Name, folder.ParentID); // Let's do a bit of sanity checking, more than the base service does // make sure the given folder's parent folder exists under the suitcase tree of this user if (!IsWithinSuitcaseTree(folder.Owner, folder.ParentID)) return false; // OK, it's legit if (base.AddFolder(folder)) { List<XInventoryFolder> tree; if (m_SuitcaseTrees.TryGetValue(folder.Owner, out tree)) tree.Add(ConvertFromOpenSim(folder)); return true; } return false; } public override bool UpdateFolder(InventoryFolderBase folder) { //m_log.DebugFormat("[HG SUITCASE INVENTORY SERVICE]: Update folder {0}, version {1}", folder.ID, folder.Version); if (!IsWithinSuitcaseTree(folder.Owner, folder.ID)) { m_log.DebugFormat("[HG SUITCASE INVENTORY SERVICE]: folder {0} not within Suitcase tree", folder.Name); return false; } // For all others return base.UpdateFolder(folder); } public override bool MoveFolder(InventoryFolderBase folder) { if (!IsWithinSuitcaseTree(folder.Owner, folder.ID) || !IsWithinSuitcaseTree(folder.Owner, folder.ParentID)) return false; return base.MoveFolder(folder); } public override bool DeleteFolders(UUID principalID, List<UUID> folderIDs) { // NOGO return false; } public override bool PurgeFolder(InventoryFolderBase folder) { // NOGO return false; } public override bool AddItem(InventoryItemBase item) { // Let's do a bit of sanity checking, more than the base service does // make sure the given folder's parent folder exists under the suitcase tree of this user if (!IsWithinSuitcaseTree(item.Owner, item.Folder)) return false; // OK, it's legit return base.AddItem(item); } public override bool UpdateItem(InventoryItemBase item) { if (!IsWithinSuitcaseTree(item.Owner, item.Folder)) return false; return base.UpdateItem(item); } public override bool MoveItems(UUID principalID, List<InventoryItemBase> items) { // Principal is b0rked. *sigh* if (!IsWithinSuitcaseTree(items[0].Owner, items[0].Folder)) return false; return base.MoveItems(principalID, items); } public override bool DeleteItems(UUID principalID, List<UUID> itemIDs) { return false; } public new InventoryItemBase GetItem(InventoryItemBase item) { InventoryItemBase it = base.GetItem(item); if (it == null) { m_log.DebugFormat("[HG SUITCASE INVENTORY SERVICE]: Unable to retrieve item {0} ({1}) in folder {2}", item.Name, item.ID, item.Folder); return null; } if (!IsWithinSuitcaseTree(it.Owner, it.Folder) && !IsPartOfAppearance(it.Owner, it.ID)) { m_log.DebugFormat("[HG SUITCASE INVENTORY SERVICE]: Item {0} (folder {1}) is not within Suitcase", it.Name, it.Folder); return null; } // UserAccount user = m_Cache.GetUser(it.CreatorId); // // Adjust the creator data // if (user != null && it != null && (it.CreatorData == null || it.CreatorData == string.Empty)) // it.CreatorData = m_HomeURL + ";" + user.FirstName + " " + user.LastName; //} return it; } public new InventoryFolderBase GetFolder(InventoryFolderBase folder) { InventoryFolderBase f = base.GetFolder(folder); if (f != null) { if (!IsWithinSuitcaseTree(f.Owner, f.ID)) return null; } return f; } //public List<InventoryItemBase> GetActiveGestures(UUID principalID) //{ //} //public int GetAssetPermissions(UUID principalID, UUID assetID) //{ //} #region Auxiliary functions private XInventoryFolder GetXFolder(UUID userID, UUID folderID) { XInventoryFolder[] folders = m_Database.GetFolders( new string[] { "agentID", "folderID" }, new string[] { userID.ToString(), folderID.ToString() }); if (folders.Length == 0) return null; return folders[0]; } private XInventoryFolder GetRootXFolder(UUID principalID) { XInventoryFolder[] folders = m_Database.GetFolders( new string[] { "agentID", "folderName", "type" }, new string[] { principalID.ToString(), "My Inventory", ((int)AssetType.RootFolder).ToString() }); if (folders != null && folders.Length > 0) return folders[0]; // OK, so the RootFolder type didn't work. Let's look for any type with parent UUID.Zero. folders = m_Database.GetFolders( new string[] { "agentID", "folderName", "parentFolderID" }, new string[] { principalID.ToString(), "My Inventory", UUID.Zero.ToString() }); if (folders != null && folders.Length > 0) return folders[0]; return null; } private XInventoryFolder GetSuitcaseXFolder(UUID principalID) { // Warp! Root folder for travelers XInventoryFolder[] folders = m_Database.GetFolders( new string[] { "agentID", "type" }, new string[] { principalID.ToString(), "100" }); // This is a special folder type... if (folders != null && folders.Length > 0) return folders[0]; // check to see if we have the old Suitcase folder folders = m_Database.GetFolders( new string[] { "agentID", "folderName", "parentFolderID" }, new string[] { principalID.ToString(), "My Suitcase", UUID.Zero.ToString() }); if (folders != null && folders.Length > 0) { // Move it to under the root folder XInventoryFolder root = GetRootXFolder(principalID); folders[0].parentFolderID = root.folderID; folders[0].type = 100; m_Database.StoreFolder(folders[0]); return folders[0]; } return null; } private void SetAsNormalFolder(XInventoryFolder suitcase) { suitcase.type = (short)AssetType.Folder; } private List<XInventoryFolder> GetFolderTree(UUID principalID, UUID folder) { List<XInventoryFolder> t = null; if (m_SuitcaseTrees.TryGetValue(principalID, out t)) return t; t = GetFolderTreeRecursive(folder); m_SuitcaseTrees.AddOrUpdate(principalID, t, 5*60); // 5minutes return t; } private List<XInventoryFolder> GetFolderTreeRecursive(UUID root) { List<XInventoryFolder> tree = new List<XInventoryFolder>(); XInventoryFolder[] folders = m_Database.GetFolders( new string[] { "parentFolderID" }, new string[] { root.ToString() }); if (folders == null || (folders != null && folders.Length == 0)) return tree; // empty tree else { foreach (XInventoryFolder f in folders) { tree.Add(f); tree.AddRange(GetFolderTreeRecursive(f.folderID)); } return tree; } } /// <summary> /// Return true if the folderID is a subfolder of the Suitcase or the suitcase folder itself /// </summary> /// <param name="folderID"></param> /// <param name="root"></param> /// <param name="suitcase"></param> /// <returns></returns> private bool IsWithinSuitcaseTree(UUID principalID, UUID folderID) { XInventoryFolder suitcase = GetSuitcaseXFolder(principalID); if (suitcase == null) { m_log.WarnFormat("[HG SUITCASE INVENTORY SERVICE]: User {0} does not have a Suitcase folder", principalID); return false; } List<XInventoryFolder> tree = new List<XInventoryFolder>(); tree.Add(suitcase); // Warp! the tree is the real root folder plus the children of the suitcase folder tree.AddRange(GetFolderTree(principalID, suitcase.folderID)); XInventoryFolder f = tree.Find(delegate(XInventoryFolder fl) { if (fl.folderID == folderID) return true; else return false; }); if (f == null) return false; else return true; } #endregion #region Avatar Appearance private AvatarAppearance GetAppearance(UUID principalID) { AvatarAppearance a = null; if (m_Appearances.TryGetValue(principalID, out a)) return a; a = m_AvatarService.GetAppearance(principalID); m_Appearances.AddOrUpdate(principalID, a, 5 * 60); // 5minutes return a; } private bool IsPartOfAppearance(UUID principalID, UUID itemID) { AvatarAppearance a = GetAppearance(principalID); if (a == null) return false; // Check wearables (body parts and clothes) for (int i = 0; i < a.Wearables.Length; i++) { for (int j = 0; j < a.Wearables[i].Count; j++) { if (a.Wearables[i][j].ItemID == itemID) { //m_log.DebugFormat("[HG SUITCASE INVENTORY SERVICE]: item {0} is a wearable", itemID); return true; } } } // Check attachments if (a.GetAttachmentForItem(itemID) != null) { //m_log.DebugFormat("[HG SUITCASE INVENTORY SERVICE]: item {0} is an attachment", itemID); return true; } return false; } #endregion } }