* Put in the code necessary to allow inventory transfer of whole folders (and their contents) between agents, not just single items

* However, this is not currently activated since it's not absolutely fully tested and there's a bug lurking in there to do with the sending of the BulkInventoryUpdate packets

4 files changed, 214 insertions, 40 deletions

diff --git a/OpenSim/Region/Environment/Modules/Avatar/Inventory/Transfer/InventoryTransferModule.cs b/OpenSim/Region/Environment/Modules/Avatar/Inventory/Transfer/InventoryTransferModule.cs
index 73f1761..b41c36f 100644
--- a/OpenSim/Region/Environment/Modules/Avatar/Inventory/Transfer/InventoryTransferModule.cs
+++ b/OpenSim/Region/Environment/Modules/Avatar/Inventory/Transfer/InventoryTransferModule.cs
@@ -136,42 +136,85 @@ namespace OpenSim.Region.Environment.Modules.Avatar.Inventory.Transfer
 
             if (im.dialog == (byte) InstantMessageDialog.InventoryOffered)
             {
-                ScenePresence user =
-                        scene.GetScenePresence(new UUID(im.toAgentID));
+                m_log.DebugFormat("Asset type {0}", ((AssetType)im.binaryBucket[0]));
+                
+                ScenePresence user = scene.GetScenePresence(new UUID(im.toAgentID));
+                UUID copyID;
 
-                // First byte of the array is probably the item type
-                // Next 16 bytes are the UUID
+                // First byte is the asset type
+                AssetType assetType = (AssetType)im.binaryBucket[0];
+                
+                // Temporarily disabled pending test of complex transfers (folders within folders, lots of items, 
+                // empty folders, etc.) 
+                if (AssetType.Folder == assetType)
+                    return;
+                
+                if (AssetType.Folder == assetType)
+                {
+                    UUID folderID = new UUID(im.binaryBucket, 1);
+                    
+                    m_log.DebugFormat("[AGENT INVENTORY]: Inserting original folder {0} "+
+                            "into agent {1}'s inventory",
+                            folderID, new UUID(im.toAgentID));
+                    
+                    InventoryFolderImpl folderCopy 
+                        = scene.GiveInventoryFolder(new UUID(im.toAgentID), client.AgentId, folderID, UUID.Zero);
+                    
+                    if (folderCopy == null)
+                    {
+                        client.SendAgentAlertMessage("Can't find folder to give. Nothing given.", false);
+                        return;
+                    }
+                                                           
+                    // The outgoing binary bucket should contain only the byte which signals an asset folder is
+                    // being copied and the following bytes for the copied folder's UUID
+                    copyID = folderCopy.ID;
+                    byte[] copyIDBytes = copyID.GetBytes();
+                    im.binaryBucket = new byte[1 + copyIDBytes.Length];
+                    im.binaryBucket[0] = (byte)AssetType.Folder;
+                    Array.Copy(copyIDBytes, 0, im.binaryBucket, 1, copyIDBytes.Length);  
+                    
+                    if (user != null && !user.IsChildAgent)
+                    {        
+                        user.ControllingClient.SendBulkUpdateInventory(folderCopy);
+                    }                    
+                }
+                else
+                {
+                    // First byte of the array is probably the item type
+                    // Next 16 bytes are the UUID
 
-                UUID itemID = new UUID(im.binaryBucket, 1);
+                    UUID itemID = new UUID(im.binaryBucket, 1);
 
-                m_log.DebugFormat("[AGENT INVENTORY]: Inserting item {0} "+
-                        "into agent {1}'s inventory",
-                        itemID, new UUID(im.toAgentID));
+                    m_log.DebugFormat("[AGENT INVENTORY]: Inserting item {0} "+
+                            "into agent {1}'s inventory",
+                            itemID, new UUID(im.toAgentID));
 
-                InventoryItemBase itemCopy = scene.GiveInventoryItem(
-                        new UUID(im.toAgentID),
-                        client.AgentId, itemID);
+                    InventoryItemBase itemCopy = scene.GiveInventoryItem(
+                            new UUID(im.toAgentID),
+                            client.AgentId, itemID);
 
-                if (itemCopy == null)
-                {
-                    client.SendAgentAlertMessage("Can't find item to give. Nothing given.", false);
-                    return;
+                    if (itemCopy == null)
+                    {
+                        client.SendAgentAlertMessage("Can't find item to give. Nothing given.", false);
+                        return;
+                    }
+                    
+                    copyID = itemCopy.ID;
+                    Array.Copy(copyID.GetBytes(), 0, im.binaryBucket, 1, 16);                                       
+                    
+                    if (user != null && !user.IsChildAgent)
+                    {        
+                        user.ControllingClient.SendBulkUpdateInventory(itemCopy);
+                    }
                 }
 
-                byte[] itemCopyID = itemCopy.ID.GetBytes();
-
-                Array.Copy(itemCopyID, 0, im.binaryBucket, 1, 16);
-
                 // Send the IM to the recipient. The item is already
                 // in their inventory, so it will not be lost if
                 // they are offline.
                 //
                 if (user != null && !user.IsChildAgent)
                 {
-                    // User is online. So, let's make the item visible
-                    //
-                    user.ControllingClient.SendBulkUpdateInventory(itemCopy);
-
                     // And notify. Transaction ID is the item ID. We get that
                     // same ID back on the reply so we know what to act on
                     //
@@ -179,7 +222,7 @@ namespace OpenSim.Region.Environment.Modules.Avatar.Inventory.Transfer
                             new UUID(im.fromAgentID), im.message,
                             new UUID(im.toAgentID),
                             im.fromAgentName, im.dialog, im.timestamp,
-                            itemCopy.ID, false, im.binaryBucket);
+                            copyID, false, im.binaryBucket);
 
                     return;
                 }
@@ -208,9 +251,7 @@ namespace OpenSim.Region.Environment.Modules.Avatar.Inventory.Transfer
                 }
             }
             else if (im.dialog == (byte) InstantMessageDialog.InventoryDeclined)
-            {
-                UUID itemID = new UUID(im.imSessionID); // The item, back from it's trip
-
+            {                                           
                 // Here, the recipient is local and we can assume that the
                 // inventory is loaded. Courtesy of the above bulk update,
                 // It will have been pushed to the client, too
@@ -224,27 +265,43 @@ namespace OpenSim.Region.Environment.Modules.Avatar.Inventory.Transfer
                 {
                     InventoryFolderImpl trashFolder =
                         userInfo.FindFolderForType((int)AssetType.TrashFolder);
-
-                    InventoryItemBase item =
-                            userInfo.RootFolder.FindItem(itemID);
-
-                    if (trashFolder != null && item != null)
+                    
+                    UUID inventoryEntityID = new UUID(im.imSessionID); // The inventory item/folder, back from it's trip
+                        
+                    InventoryItemBase item = userInfo.RootFolder.FindItem(inventoryEntityID);
+                    InventoryFolderBase folder = null;
+                    
+                    if (item != null && trashFolder != null)
                     {
                         item.Folder = trashFolder.ID;
 
-                        userInfo.DeleteItem(itemID);
+                        userInfo.DeleteItem(inventoryEntityID);
 
                         scene.AddInventoryItem(client, item);
                     }
                     else
                     {
-                        string reason = "";
+                        folder = userInfo.RootFolder.FindFolder(inventoryEntityID);
+                        
+                        if (folder != null & trashFolder != null)
+                        {
+                            userInfo.MoveFolder(inventoryEntityID, trashFolder.ID);
+                        }
+                    }
+                    
+                    if ((null == item && null == folder) | null == trashFolder)
+                    {                        
+                        string reason = String.Empty;
+                        
                         if (trashFolder == null)
                             reason += " Trash folder not found.";
                         if (item == null)
                             reason += " Item not found.";
+                        if (folder == null)
+                            reason += " Folder not found.";
+                        
                         client.SendAgentAlertMessage("Unable to delete "+
-                                "received item" + reason, false);
+                                "received inventory" + reason, false);
                     }
                 }
 
diff --git a/OpenSim/Region/Environment/Modules/World/NPC/NPCAvatar.cs b/OpenSim/Region/Environment/Modules/World/NPC/NPCAvatar.cs
index b5a5123..fb1d1ff 100644
--- a/OpenSim/Region/Environment/Modules/World/NPC/NPCAvatar.cs
+++ b/OpenSim/Region/Environment/Modules/World/NPC/NPCAvatar.cs
@@ -624,6 +624,9 @@ namespace OpenSim.Region.Environment.Modules.World.NPC
         public virtual void SendBulkUpdateInventory(InventoryItemBase item)
         {
         }
+        
+        public virtual void SendBulkUpdateInventory(InventoryFolderBase folderBase)
+        {}
 
         public void SendTakeControls(int controls, bool passToAgent, bool TakeControls)
         {
diff --git a/OpenSim/Region/Environment/Scenes/Scene.Inventory.cs b/OpenSim/Region/Environment/Scenes/Scene.Inventory.cs
index d1e0c24..3d6a905 100644
--- a/OpenSim/Region/Environment/Scenes/Scene.Inventory.cs
+++ b/OpenSim/Region/Environment/Scenes/Scene.Inventory.cs
@@ -400,11 +400,11 @@ namespace OpenSim.Region.Environment.Scenes
         }
 
         /// <summary>
-        /// Give an inventory item from one avatar to another
+        /// Give an inventory item from one user to another
         /// </summary>
         /// <param name="recipientClient"></param>
         /// <param name="senderId">ID of the sender of the item</param>
-        /// <param name="itemId"></param>
+        /// <param name="itemId"></param>        
         public virtual void GiveInventoryItem(IClientAPI recipientClient, UUID senderId, UUID itemId)
         {
             InventoryItemBase itemCopy = GiveInventoryItem(recipientClient.AgentId, senderId, itemId);
@@ -413,8 +413,34 @@ namespace OpenSim.Region.Environment.Scenes
                 recipientClient.SendBulkUpdateInventory(itemCopy);
         }
 
+        /// <summary>
+        /// Give an inventory item from one user to another
+        /// </summary>
+        /// <param name="recipient"></param>
+        /// <param name="senderId">ID of the sender of the item</param>
+        /// <param name="itemId"></param>        
+        /// <returns>The inventory item copy given, null if the give was unsuccessful</returns>
         public virtual InventoryItemBase GiveInventoryItem(UUID recipient, UUID senderId, UUID itemId)
         {
+            return GiveInventoryItem(recipient, senderId, itemId, UUID.Zero);
+        }
+        
+        /// <summary>
+        /// Give an inventory item from one user to another
+        /// </summary>
+        /// <param name="recipient"></param>
+        /// <param name="senderId">ID of the sender of the item</param>
+        /// <param name="itemId"></param>        
+        /// <param name="recipientFolderId">
+        /// The id of the folder in which the copy item should go.  If UUID.Zero then the item is placed in the most
+        /// appropriate default folder.
+        /// </param>
+        /// <returns>
+        /// The inventory item copy given, null if the give was unsuccessful
+        /// </returns>
+        public virtual InventoryItemBase GiveInventoryItem(
+            UUID recipient, UUID senderId, UUID itemId, UUID recipientFolderId)
+        {
             // Retrieve the item from the sender
             CachedUserInfo senderUserInfo = CommsManager.UserProfileCacheService.GetUserDetails(senderId);
 
@@ -438,7 +464,6 @@ namespace OpenSim.Region.Environment.Scenes
                             return null;
                     }
 
-                    // TODO get recipient's root folder
                     CachedUserInfo recipientUserInfo
                         = CommsManager.UserProfileCacheService.GetUserDetails(recipient);
 
@@ -457,7 +482,8 @@ namespace OpenSim.Region.Environment.Scenes
                         itemCopy.Name = item.Name;
                         itemCopy.AssetType = item.AssetType;
                         itemCopy.InvType = item.InvType;
-                        itemCopy.Folder = UUID.Zero;
+                        itemCopy.Folder = recipientFolderId;
+                        
                         if (Permissions.PropagatePermissions())
                         {
                             if (item.InvType == 6)
@@ -529,8 +555,93 @@ namespace OpenSim.Region.Environment.Scenes
                 m_log.Error("[AGENT INVENTORY]: Failed to find item " + itemId.ToString() + ", no root folder");
                 return null;
             }
+            
             return null;
         }
+        
+        /// <summary>
+        /// Give an entire inventory folder from one user to another.  The entire contents (including all descendent 
+        /// folders) is given.
+        /// </summary>
+        /// <param name="recipientId"></param>
+        /// <param name="senderId">ID of the sender of the item</param>
+        /// <param name="folderId"></param>
+        /// <param name="recipientParentFolderId">
+        /// The id of the receipient folder in which the send folder should be placed.  If UUID.Zero then the 
+        /// recipient folder is the root folder
+        /// </param>
+        /// <returns>
+        /// The inventory folder copy given, null if the copy was unsuccessful
+        /// </returns>
+        public virtual InventoryFolderImpl GiveInventoryFolder(
+            UUID recipientId, UUID senderId, UUID folderId, UUID recipientParentFolderId)
+        {
+            // Retrieve the folder from the sender
+            CachedUserInfo senderUserInfo = CommsManager.UserProfileCacheService.GetUserDetails(senderId);
+
+            if (null == senderUserInfo)
+            {
+                m_log.ErrorFormat(
+                     "[AGENT INVENTORY]: Failed to find sending user {0} for folder {1}", senderId, folderId);
+
+                return null;
+            }
+            
+            if (!senderUserInfo.HasReceivedInventory)
+            {
+                m_log.DebugFormat(
+                     "[AGENT INVENTORY]: Could not give inventory folder - have not yet received inventory for {0}",
+                     senderId);
+                
+                return null;
+            }
+            
+            InventoryFolderImpl folder = senderUserInfo.RootFolder.FindFolder(folderId);
+            
+            if (null == folder)
+            {
+                m_log.ErrorFormat(
+                     "[AGENT INVENTORY]: Could not find inventory folder {0} to give", folderId);
+
+                return null;                
+            }
+
+            CachedUserInfo recipientUserInfo
+                = CommsManager.UserProfileCacheService.GetUserDetails(recipientId);
+
+            if (null == recipientUserInfo)
+            {
+                m_log.ErrorFormat(
+                     "[AGENT INVENTORY]: Failed to find receiving user {0} for folder {1}", recipientId, folderId);
+
+                return null;
+            }
+            
+            if (recipientParentFolderId == UUID.Zero)
+                recipientParentFolderId = recipientUserInfo.RootFolder.ID;
+            
+            UUID newFolderId = UUID.Random();
+            recipientUserInfo.CreateFolder(folder.Name, newFolderId, (ushort)folder.Type, recipientParentFolderId);
+            
+            // XXX: Messy - we should really get this back in the CreateFolder call
+            InventoryFolderImpl copiedFolder = recipientUserInfo.RootFolder.FindFolder(newFolderId);
+            
+            // Give all the subfolders
+            List<InventoryFolderImpl> subFolders = folder.RequestListOfFolderImpls();
+            foreach (InventoryFolderImpl childFolder in subFolders)
+            {
+                GiveInventoryFolder(recipientId, senderId, childFolder.ID, copiedFolder.ID);
+            }              
+             
+            // Give all the items
+            List<InventoryItemBase> items = folder.RequestListOfItems();
+            foreach (InventoryItemBase item in items)
+            {
+                GiveInventoryItem(recipientId, senderId, item.ID, copiedFolder.ID);
+            }
+            
+            return copiedFolder;
+        }
 
         public void CopyInventoryItem(IClientAPI remoteClient, uint callbackID, UUID oldAgentID, UUID oldItemID,
                                       UUID newFolderID, string newName)
diff --git a/OpenSim/Region/Environment/Scenes/Tests/TestClient.cs b/OpenSim/Region/Environment/Scenes/Tests/TestClient.cs
index 69e45bb..cecb115 100644
--- a/OpenSim/Region/Environment/Scenes/Tests/TestClient.cs
+++ b/OpenSim/Region/Environment/Scenes/Tests/TestClient.cs
@@ -538,6 +538,9 @@ namespace OpenSim.Region.Environment.Scenes.Tests
         public virtual void SendBulkUpdateInventory(InventoryItemBase item)
         {
         }
+        
+        public void SendBulkUpdateInventory(InventoryFolderBase folderBase)
+        {}
 
         public UUID GetDefaultAnimation(string name)
         {
@@ -561,8 +564,8 @@ namespace OpenSim.Region.Environment.Scenes.Tests
             int PriceParcelClaim, float PriceParcelClaimFactor, int PriceParcelRent, int PricePublicObjectDecay,
             int PricePublicObjectDelete, int PriceRentLight, int PriceUpload, int TeleportMinPrice, float TeleportPriceExponent)
         {
-
         }
+        
         public virtual void SendNameReply(UUID profileId, string firstname, string lastname)
         {
         }