1 files changed, 179 insertions, 0 deletions

diff --git a/OpenSim/Region/CoreModules/ServiceConnectorsOut/Inventory/BaseInventoryConnector.cs b/OpenSim/Region/CoreModules/ServiceConnectorsOut/Inventory/BaseInventoryConnector.cs
new file mode 100644
index 0000000..f2b736c
--- /dev/null
+++ b/OpenSim/Region/CoreModules/ServiceConnectorsOut/Inventory/BaseInventoryConnector.cs
@@ -0,0 +1,179 @@
+using System;
+using System.Collections.Generic;
+
+using OpenMetaverse;
+using Nini.Config;
+using log4net;
+
+using OpenSim.Framework;
+using OpenSim.Services.Interfaces;
+
+
+namespace OpenSim.Region.CoreModules.ServiceConnectorsOut.Inventory
+{
+    public abstract class BaseInventoryConnector : IInventoryService
+    {
+        protected InventoryCache m_cache;
+
+        protected virtual void Init(IConfigSource source)
+        {
+            m_cache = new InventoryCache();
+            m_cache.Init(source, this);
+        }
+
+        /// <summary>
+        /// Create the entire inventory for a given user
+        /// </summary>
+        /// <param name="user"></param>
+        /// <returns></returns>
+        public abstract bool CreateUserInventory(UUID user);
+
+        /// <summary>
+        /// Gets the skeleton of the inventory -- folders only
+        /// </summary>
+        /// <param name="userId"></param>
+        /// <returns></returns>
+        public abstract List<InventoryFolderBase> GetInventorySkeleton(UUID userId);
+
+        /// <summary>
+        /// Synchronous inventory fetch.
+        /// </summary>
+        /// <param name="userID"></param>
+        /// <returns></returns>
+        public abstract InventoryCollection GetUserInventory(UUID userID);
+
+        /// <summary>
+        /// Request the inventory for a user.  This is an asynchronous operation that will call the callback when the
+        /// inventory has been received
+        /// </summary>
+        /// <param name="userID"></param>
+        /// <param name="callback"></param>
+        public abstract void GetUserInventory(UUID userID, InventoryReceiptCallback callback);
+
+        /// <summary>
+        /// Retrieve the root inventory folder for the given user.
+        /// </summary>
+        /// <param name="userID"></param>
+        /// <returns>null if no root folder was found</returns>
+        public abstract InventoryFolderBase GetRootFolder(UUID userID);
+
+        public abstract Dictionary<AssetType, InventoryFolderBase> GetSystemFolders(UUID userID);
+
+        /// <summary>
+        /// Gets the user folder for the given folder-type
+        /// </summary>
+        /// <param name="userID"></param>
+        /// <param name="type"></param>
+        /// <returns></returns>
+        public InventoryFolderBase GetFolderForType(UUID userID, AssetType type)
+        {
+            return m_cache.GetFolderForType(userID, type);
+        }
+
+        /// <summary>
+        /// Gets everything (folders and items) inside a folder
+        /// </summary>
+        /// <param name="userId"></param>
+        /// <param name="folderID"></param>
+        /// <returns></returns>
+        public abstract InventoryCollection GetFolderContent(UUID userID, UUID folderID);
+
+        /// <summary>
+        /// Gets the items inside a folder
+        /// </summary>
+        /// <param name="userID"></param>
+        /// <param name="folderID"></param>
+        /// <returns></returns>
+        public abstract List<InventoryItemBase> GetFolderItems(UUID userID, UUID folderID);
+
+        /// <summary>
+        /// Add a new folder to the user's inventory
+        /// </summary>
+        /// <param name="folder"></param>
+        /// <returns>true if the folder was successfully added</returns>
+        public abstract bool AddFolder(InventoryFolderBase folder);
+
+        /// <summary>
+        /// Update a folder in the user's inventory
+        /// </summary>
+        /// <param name="folder"></param>
+        /// <returns>true if the folder was successfully updated</returns>
+        public abstract bool UpdateFolder(InventoryFolderBase folder);
+
+        /// <summary>
+        /// Move an inventory folder to a new location
+        /// </summary>
+        /// <param name="folder">A folder containing the details of the new location</param>
+        /// <returns>true if the folder was successfully moved</returns>
+        public abstract bool MoveFolder(InventoryFolderBase folder);
+
+        /// <summary>
+        /// Purge an inventory folder of all its items and subfolders.
+        /// </summary>
+        /// <param name="folder"></param>
+        /// <returns>true if the folder was successfully purged</returns>
+        public abstract bool PurgeFolder(InventoryFolderBase folder);
+
+        /// <summary>
+        /// Add a new item to the user's inventory.
+        /// If the given item has to parent folder, it tries to find the most
+        /// suitable folder for it.
+        /// </summary>
+        /// <param name="item"></param>
+        /// <returns>true if the item was successfully added</returns>
+        public bool AddItem(InventoryItemBase item)
+        {
+            if (item.Folder == UUID.Zero)
+            {
+                InventoryFolderBase f = GetFolderForType(item.Owner, (AssetType)item.AssetType);
+                if (f != null)
+                    item.Folder = f.ID;
+                else
+                {
+                    f = GetRootFolder(item.Owner);
+                    if (f != null)
+                        item.Folder = f.ID;
+                    else
+                        return false;
+                }
+            }
+
+            return AddItemPlain(item);
+        }
+
+        protected abstract bool AddItemPlain(InventoryItemBase item);
+
+        /// <summary>
+        /// Update an item in the user's inventory
+        /// </summary>
+        /// <param name="item"></param>
+        /// <returns>true if the item was successfully updated</returns>
+        public abstract bool UpdateItem(InventoryItemBase item);
+
+        /// <summary>
+        /// Delete an item from the user's inventory
+        /// </summary>
+        /// <param name="item"></param>
+        /// <returns>true if the item was successfully deleted</returns>
+        public abstract bool DeleteItem(InventoryItemBase item);
+
+        public abstract InventoryItemBase QueryItem(InventoryItemBase item);
+
+        public abstract InventoryFolderBase QueryFolder(InventoryFolderBase folder);
+
+        /// <summary>
+        /// Does the given user have an inventory structure?
+        /// </summary>
+        /// <param name="userID"></param>
+        /// <returns></returns>
+        public abstract bool HasInventoryForUser(UUID userID);
+
+        /// <summary>
+        /// Get the active gestures of the agent.
+        /// </summary>
+        /// <param name="userId"></param>
+        /// <returns></returns>
+        public abstract List<InventoryItemBase> GetActiveGestures(UUID userId);
+
+    }
+}