From 1ad237a8a757a0e6074278aff76805d01abf0c0b Mon Sep 17 00:00:00 2001 From: diva Date: Sun, 7 Jun 2009 19:00:55 +0000 Subject: First draft of inventory service connectors, and service implementation. No handlers yet, this is just the OUT part for now. It's not active and nothing in the simulator uses this yet. Just checking it in to start sharing with others. There are a couple of interesting software design points that could use other devs opinions. Hopefully I added all needed files. --- .../Inventory/ISessionAuthInventoryService.cs | 107 +++++++ .../Inventory/InventoryServiceConnector.cs | 343 +++++++++++++++++++++ 2 files changed, 450 insertions(+) create mode 100644 OpenSim/Services/Connectors/Inventory/ISessionAuthInventoryService.cs create mode 100644 OpenSim/Services/Connectors/Inventory/InventoryServiceConnector.cs (limited to 'OpenSim/Services/Connectors/Inventory') diff --git a/OpenSim/Services/Connectors/Inventory/ISessionAuthInventoryService.cs b/OpenSim/Services/Connectors/Inventory/ISessionAuthInventoryService.cs new file mode 100644 index 0000000..4fc4363 --- /dev/null +++ b/OpenSim/Services/Connectors/Inventory/ISessionAuthInventoryService.cs @@ -0,0 +1,107 @@ +/* + * 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 OpenSim.Framework; +using OpenSim.Services.Interfaces; +using OpenMetaverse; + +namespace OpenSim.Services.Connectors +{ + /// + /// Defines all operations to access a remote inventory service + /// using session authentication as a form of security. + /// + public interface ISessionAuthInventoryService + { + string Host + { + get; + } + + /// + /// Request the inventory for a user. This is an asynchronous operation that will call the callback when the + /// inventory has been received + /// + /// + /// + void GetUserInventory(string userID, UUID session_id, InventoryReceiptCallback callback); + + /// + /// Add a new folder to the user's inventory + /// + /// + /// true if the folder was successfully added + bool AddFolder(string userID, InventoryFolderBase folder, UUID session_id); + + /// + /// Update a folder in the user's inventory + /// + /// + /// true if the folder was successfully updated + bool UpdateFolder(string userID, InventoryFolderBase folder, UUID session_id); + + /// + /// Move an inventory folder to a new location + /// + /// A folder containing the details of the new location + /// true if the folder was successfully moved + bool MoveFolder(string userID, InventoryFolderBase folder, UUID session_id); + + /// + /// Purge an inventory folder of all its items and subfolders. + /// + /// + /// true if the folder was successfully purged + bool PurgeFolder(string userID, InventoryFolderBase folder, UUID session_id); + + /// + /// Add a new item to the user's inventory + /// + /// + /// true if the item was successfully added + bool AddItem(string userID, InventoryItemBase item, UUID session_id); + + /// + /// Update an item in the user's inventory + /// + /// + /// true if the item was successfully updated + bool UpdateItem(string userID, InventoryItemBase item, UUID session_id); + + /// + /// Delete an item from the user's inventory + /// + /// + /// true if the item was successfully deleted + bool DeleteItem(string userID, InventoryItemBase item, UUID session_id); + + InventoryItemBase QueryItem(string userID, InventoryItemBase item, UUID session_id); + + InventoryFolderBase QueryFolder(string userID, InventoryFolderBase item, UUID session_id); + + } +} diff --git a/OpenSim/Services/Connectors/Inventory/InventoryServiceConnector.cs b/OpenSim/Services/Connectors/Inventory/InventoryServiceConnector.cs new file mode 100644 index 0000000..34478ae --- /dev/null +++ b/OpenSim/Services/Connectors/Inventory/InventoryServiceConnector.cs @@ -0,0 +1,343 @@ +/* + * 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 log4net; +using System; +using System.Collections.Generic; +using System.IO; +using System.Reflection; +using Nini.Config; +using OpenSim.Framework; +using OpenSim.Framework.Servers.HttpServer; +using OpenSim.Services.Interfaces; +using OpenMetaverse; + +namespace OpenSim.Services.Connectors +{ + public class InventoryServicesConnector : ISessionAuthInventoryService + { + private static readonly ILog m_log = + LogManager.GetLogger( + MethodBase.GetCurrentMethod().DeclaringType); + + private string m_ServerURI = String.Empty; + + private Dictionary m_RequestingInventory = new Dictionary(); + + public InventoryServicesConnector() + { + } + + public InventoryServicesConnector(string serverURI) + { + m_ServerURI = serverURI.TrimEnd('/'); + } + + public InventoryServicesConnector(IConfigSource source) + { + Initialise(source); + } + + public virtual void Initialise(IConfigSource source) + { + IConfig inventoryConfig = source.Configs["InventoryService"]; + if (inventoryConfig == null) + { + m_log.Error("[INVENTORY CONNECTOR]: InventoryService missing from OpanSim.ini"); + throw new Exception("Inventory connector init error"); + } + + string serviceURI = inventoryConfig.GetString("InventoryServerURI", + String.Empty); + + if (serviceURI == String.Empty) + { + m_log.Error("[INVENTORY CONNECTOR]: No Server URI named in section InventoryService"); + throw new Exception("Inventory connector init error"); + } + m_ServerURI = serviceURI.TrimEnd('/'); + } + + #region ISessionAuthInventoryService + + public string Host + { + get { return m_ServerURI; } + } + + /// + /// Caller must catch eventual Exceptions. + /// + /// + /// + /// + public void GetUserInventory(string userIDStr, UUID sessionID, InventoryReceiptCallback callback) + { + UUID userID = UUID.Zero; + if (UUID.TryParse(userIDStr, out userID)) + { + lock (m_RequestingInventory) + { + if (!m_RequestingInventory.ContainsKey(userID)) + m_RequestingInventory.Add(userID, callback); + else + { + m_log.ErrorFormat("[INVENTORY CONNECTOR]: GetUserInventory - ignoring repeated request for user {0}", userID); + return; + } + } + + m_log.InfoFormat( + "[INVENTORY CONNECTOR]: Requesting inventory from {0}/GetInventory/ for user {1}", + m_ServerURI, userID); + + RestSessionObjectPosterResponse requester + = new RestSessionObjectPosterResponse(); + requester.ResponseCallback = InventoryResponse; + + requester.BeginPostObject(m_ServerURI + "/GetInventory/", userID.Guid, sessionID.ToString(), userID.ToString()); + } + } + + public bool AddFolder(string userID, InventoryFolderBase folder, UUID sessionID) + { + try + { + return SynchronousRestSessionObjectPoster.BeginPostObject( + "POST", m_ServerURI + "/NewFolder/", folder, sessionID.ToString(), folder.Owner.ToString()); + } + catch (Exception e) + { + m_log.ErrorFormat("[INVENTORY CONNECTOR]: Add new inventory folder operation failed, {0} {1}", + e.Source, e.Message); + } + + return false; + } + + public bool UpdateFolder(string userID, InventoryFolderBase folder, UUID sessionID) + { + try + { + return SynchronousRestSessionObjectPoster.BeginPostObject( + "POST", m_ServerURI + "/UpdateFolder/", folder, sessionID.ToString(), folder.Owner.ToString()); + } + catch (Exception e) + { + m_log.ErrorFormat("[INVENTORY CONNECTOR]: Update inventory folder operation failed, {0} {1}", + e.Source, e.Message); + } + + return false; + } + + public bool MoveFolder(string userID, InventoryFolderBase folder, UUID sessionID) + { + try + { + return SynchronousRestSessionObjectPoster.BeginPostObject( + "POST", m_ServerURI + "/MoveFolder/", folder, sessionID.ToString(), folder.Owner.ToString()); + } + catch (Exception e) + { + m_log.ErrorFormat("[INVENTORY CONNECTOR]: Move inventory folder operation failed, {0} {1}", + e.Source, e.Message); + } + + return false; + } + + public bool PurgeFolder(string userID, InventoryFolderBase folder, UUID sessionID) + { + try + { + return SynchronousRestSessionObjectPoster.BeginPostObject( + "POST", m_ServerURI + "/PurgeFolder/", folder, sessionID.ToString(), folder.Owner.ToString()); + } + catch (Exception e) + { + m_log.ErrorFormat("[INVENTORY CONNECTOR]: Move inventory folder operation failed, {0} {1}", + e.Source, e.Message); + } + + return false; + } + + public bool AddItem(string userID, InventoryItemBase item, UUID sessionID) + { + try + { + return SynchronousRestSessionObjectPoster.BeginPostObject( + "POST", m_ServerURI + "/NewItem/", item, sessionID.ToString(), item.Owner.ToString()); + } + catch (Exception e) + { + m_log.ErrorFormat("[INVENTORY CONNECTOR]: Add new inventory item operation failed, {0} {1}", + e.Source, e.Message); + } + + return false; + } + + public bool UpdateItem(string userID, InventoryItemBase item, UUID sessionID) + { + try + { + return SynchronousRestSessionObjectPoster.BeginPostObject( + "POST", m_ServerURI + "/NewItem/", item, sessionID.ToString(), item.Owner.ToString()); + } + catch (Exception e) + { + m_log.ErrorFormat("[INVENTORY CONNECTOR]: Update new inventory item operation failed, {0} {1}", + e.Source, e.Message); + } + + return false; + } + + public bool DeleteItem(string userID, InventoryItemBase item, UUID sessionID) + { + try + { + return SynchronousRestSessionObjectPoster.BeginPostObject( + "POST", m_ServerURI + "/DeleteItem/", item, sessionID.ToString(), item.Owner.ToString()); + } + catch (Exception e) + { + m_log.ErrorFormat("[INVENTORY CONNECTOR]: Delete inventory item operation failed, {0} {1}", + e.Source, e.Message); + } + + return false; + } + + public InventoryItemBase QueryItem(string userID, InventoryItemBase item, UUID sessionID) + { + try + { + return SynchronousRestSessionObjectPoster.BeginPostObject( + "POST", m_ServerURI + "/QueryItem/", item, sessionID.ToString(), item.Owner.ToString()); + } + catch (Exception e) + { + m_log.ErrorFormat("[INVENTORY CONNECTOR]: Query inventory item operation failed, {0} {1}", + e.Source, e.Message); + } + + return null; + } + + public InventoryFolderBase QueryFolder(string userID, InventoryFolderBase item, UUID sessionID) + { + try + { + return SynchronousRestSessionObjectPoster.BeginPostObject( + "POST", m_ServerURI + "/QueryFolder/", item, sessionID.ToString(), item.Owner.ToString()); + } + catch (Exception e) + { + m_log.ErrorFormat("[INVENTORY CONNECTOR]: Query inventory item operation failed, {0} {1}", + e.Source, e.Message); + } + + return null; + } + + #endregion + + /// + /// Callback used by the inventory server GetInventory request + /// + /// + private void InventoryResponse(InventoryCollection response) + { + UUID userID = response.UserID; + InventoryReceiptCallback callback = null; + lock (m_RequestingInventory) + { + if (m_RequestingInventory.ContainsKey(userID)) + { + callback = m_RequestingInventory[userID]; + m_RequestingInventory.Remove(userID); + } + else + { + m_log.WarnFormat( + "[INVENTORY CONNECTOR]: " + + "Received inventory response for {0} for which we do not have a record of requesting!", + userID); + return; + } + } + + m_log.InfoFormat("[INVENTORY CONNECTOR]: " + + "Received inventory response for user {0} containing {1} folders and {2} items", + userID, response.Folders.Count, response.Items.Count); + + InventoryFolderImpl rootFolder = null; + + ICollection folders = new List(); + ICollection items = new List(); + + foreach (InventoryFolderBase folder in response.Folders) + { + if (folder.ParentID == UUID.Zero) + { + rootFolder = new InventoryFolderImpl(folder); + folders.Add(rootFolder); + + break; + } + } + + if (rootFolder != null) + { + foreach (InventoryFolderBase folder in response.Folders) + { + if (folder.ID != rootFolder.ID) + { + folders.Add(new InventoryFolderImpl(folder)); + } + } + + foreach (InventoryItemBase item in response.Items) + { + items.Add(item); + } + } + else + { + m_log.ErrorFormat("[INVENTORY CONNECTOR]: Did not get back an inventory containing a root folder for user {0}", userID); + } + + callback(folders, items); + + } + + + } +} -- cgit v1.1