* Implement 'Save Object Back to My Inventory'. On the Linden client this is in the Tools menu available when editing an object

* This facility allows you to save changes to an object that you've rezzed into a region back into their original inventory item without having to take a copy of the rezzed 
object.

5 files changed, 169 insertions, 82 deletions

diff --git a/OpenSim/Region/Environment/Scenes/AsyncSceneObjectGroupDeleter.cs b/OpenSim/Region/Environment/Scenes/AsyncSceneObjectGroupDeleter.cs
index 03b3977..1429452 100644
--- a/OpenSim/Region/Environment/Scenes/AsyncSceneObjectGroupDeleter.cs
+++ b/OpenSim/Region/Environment/Scenes/AsyncSceneObjectGroupDeleter.cs
@@ -110,7 +110,7 @@ namespace OpenSim.Region.Environment.Scenes
             
             while (InventoryDeQueueAndDelete())
             {
-                m_log.Debug("[SCENE]: Returned item successfully to inventory, continuing...");
+                m_log.Debug("[SCENE]: Sent item successfully to inventory, continuing...");
             }
         }            
 
@@ -130,7 +130,7 @@ namespace OpenSim.Region.Environment.Scenes
                     if (left > 0)
                     {
                         m_log.DebugFormat(
-                            "[SCENE]: Sending deleted object to user's inventory, {0} item(s) remaining.", left);
+                            "[SCENE]: Sending object to user's inventory, {0} item(s) remaining.", left);
                         
                         x = m_inventoryDeletes.Dequeue();
 
@@ -142,7 +142,7 @@ namespace OpenSim.Region.Environment.Scenes
                         }
                         catch (Exception e)
                         {
-                            m_log.DebugFormat("Exception background deleting object: " + e);
+                            m_log.DebugFormat("Exception background sending object: " + e);
                         }
                         
                         return true;
@@ -154,11 +154,11 @@ namespace OpenSim.Region.Environment.Scenes
                 // We can't put the object group details in here since the root part may have disappeared (which is where these sit).
                 // FIXME: This needs to be fixed.
                 m_log.ErrorFormat(
-                    "[SCENE]: Queued deletion of scene object to agent {0} {1} failed: {2}",
+                    "[SCENE]: Queued sending of scene object to agent {0} {1} failed: {2}",
                     (x != null ? x.remoteClient.Name : "unavailable"), (x != null ? x.remoteClient.AgentId.ToString() : "unavailable"), e.ToString());
             }
 
-            m_log.Debug("[SCENE]: No objects left in inventory delete queue.");
+            m_log.Debug("[SCENE]: No objects left in inventory send queue.");
             return false;
         }        
     }
diff --git a/OpenSim/Region/Environment/Scenes/Scene.Inventory.cs b/OpenSim/Region/Environment/Scenes/Scene.Inventory.cs
index 7c518c4..c1decaa 100644
--- a/OpenSim/Region/Environment/Scenes/Scene.Inventory.cs
+++ b/OpenSim/Region/Environment/Scenes/Scene.Inventory.cs
@@ -1686,7 +1686,15 @@ namespace OpenSim.Region.Environment.Scenes
             bool permissionToTake = false;
             bool permissionToDelete = false;
 
-            if (action == DeRezAction.TakeCopy)
+            if (action == DeRezAction.SaveToExistingUserInventoryItem)
+            {
+                if (grp.OwnerID == remoteClient.AgentId && grp.RootPart.FromUserInventoryItemID != UUID.Zero)
+                {
+                    permissionToTake = true;
+                    permissionToDelete = false;
+                }
+            }
+            else if (action == DeRezAction.TakeCopy)
             {
                 permissionToTake =
                         Permissions.CanTakeCopyObject(
@@ -1726,6 +1734,7 @@ namespace OpenSim.Region.Environment.Scenes
                             grp.UUID,
                             remoteClient.AgentId);
                     permissionToDelete = permissionToTake;
+                    
                     if (permissionToDelete)
                     {
                         AddReturn(grp.OwnerID, grp.Name, grp.AbsolutePosition, "parcel owner return");
@@ -1737,6 +1746,12 @@ namespace OpenSim.Region.Environment.Scenes
                     permissionToDelete = true;
                 }
             }
+            else
+            {
+                m_log.DebugFormat(
+                    "[AGENT INVENTORY]: Ignoring unexpected derez action {0} for {1}", action, remoteClient.Name);
+                return;
+            }
 
             if (permissionToTake)
             {
@@ -1769,13 +1784,11 @@ namespace OpenSim.Region.Environment.Scenes
 
             if (remoteClient == null)
             {
-                userInfo = CommsManager.UserProfileCacheService.GetUserDetails(
-                        objectGroup.RootPart.OwnerID);
+                userInfo = CommsManager.UserProfileCacheService.GetUserDetails(objectGroup.RootPart.OwnerID);
             }
             else
             {
-                userInfo = CommsManager.UserProfileCacheService.GetUserDetails(
-                        remoteClient.AgentId);
+                userInfo = CommsManager.UserProfileCacheService.GetUserDetails(remoteClient.AgentId);
             }
 
             if (userInfo != null)
@@ -1785,8 +1798,8 @@ namespace OpenSim.Region.Environment.Scenes
                 // If we're returning someone's item, it goes back to the
                 // owner's Lost And Found folder.
 
-                if (folderID == UUID.Zero || (action == DeRezAction.Delete &&
-                        objectGroup.OwnerID != remoteClient.AgentId))
+                if (folderID == UUID.Zero 
+                    || (action == DeRezAction.Delete && objectGroup.OwnerID != remoteClient.AgentId))
                 {
                     InventoryFolderBase folder =
                             userInfo.FindFolderForType(
@@ -1811,6 +1824,21 @@ namespace OpenSim.Region.Environment.Scenes
                     }
                 }
 
+                InventoryItemBase item = null;
+                
+                if (DeRezAction.SaveToExistingUserInventoryItem == action)
+                {
+                    item = userInfo.RootFolder.FindItem(objectGroup.RootPart.FromUserInventoryItemID);
+                    
+                    if (null == item)
+                    {
+                        m_log.DebugFormat(
+                            "[AGENT INVENTORY]: Object {0} {1} scheduled for save to inventory has already been deleted.", 
+                            objectGroup.Name, objectGroup.UUID);                        
+                        return UUID.Zero;
+                    }
+                }
+
                 AssetBase asset = CreateAsset(
                     objectGroup.GetPartName(objectGroup.RootPart.LocalId),
                     objectGroup.GetPartDescription(objectGroup.RootPart.LocalId),
@@ -1818,65 +1846,74 @@ namespace OpenSim.Region.Environment.Scenes
                     Utils.StringToBytes(sceneObjectXml));
                 AssetCache.AddAsset(asset);
                 assetID = asset.FullID;
-
-                InventoryItemBase item = new InventoryItemBase();
-                item.Creator = objectGroup.RootPart.CreatorID;
-
-                if (action == DeRezAction.TakeCopy || action == DeRezAction.Take)
-                    item.Owner = remoteClient.AgentId;
-                else // Delete / Return
-                    item.Owner = objectGroup.OwnerID;
-
-                item.ID = UUID.Random();
-                item.AssetID = asset.FullID;
-                item.Description = asset.Description;
-                item.Name = asset.Name;
-                item.AssetType = asset.Type;
-                item.InvType = (int)InventoryType.Object;
-                item.Folder = folderID;
                 
-                if (remoteClient != null && (remoteClient.AgentId != objectGroup.RootPart.OwnerID) && Permissions.PropagatePermissions())
-                {
-                    uint perms=objectGroup.GetEffectivePermissions();
-                    uint nextPerms=(perms & 7) << 13;
-                    if ((nextPerms & (uint)PermissionMask.Copy) == 0)
-                        perms &= ~(uint)PermissionMask.Copy;
-                    if ((nextPerms & (uint)PermissionMask.Transfer) == 0)
-                        perms &= ~(uint)PermissionMask.Transfer;
-                    if ((nextPerms & (uint)PermissionMask.Modify) == 0)
-                        perms &= ~(uint)PermissionMask.Modify;
-
-                    item.BasePermissions = perms & objectGroup.RootPart.NextOwnerMask;
-                    item.CurrentPermissions = item.BasePermissions;
-                    item.NextPermissions = objectGroup.RootPart.NextOwnerMask;
-                    item.EveryOnePermissions = objectGroup.RootPart.EveryoneMask & objectGroup.RootPart.NextOwnerMask;
-                    item.GroupPermissions = objectGroup.RootPart.GroupMask & objectGroup.RootPart.NextOwnerMask;
-                    item.CurrentPermissions |= 8; // Slam!
+                if (DeRezAction.SaveToExistingUserInventoryItem == action)
+                {                                   
+                    item.AssetID = asset.FullID;                    
+                    userInfo.UpdateItem(item);
                 }
                 else
                 {
-                    item.BasePermissions = objectGroup.GetEffectivePermissions();
-                    item.CurrentPermissions = objectGroup.GetEffectivePermissions();
-                    item.NextPermissions = objectGroup.RootPart.NextOwnerMask;
-                    item.EveryOnePermissions = objectGroup.RootPart.EveryoneMask;
-                    item.GroupPermissions = objectGroup.RootPart.GroupMask;
-                }
+                    item = new InventoryItemBase();
+                    item.Creator = objectGroup.RootPart.CreatorID;
 
-                // TODO: add the new fields (Flags, Sale info, etc)
-                item.CreationDate = Util.UnixTimeSinceEpoch();
+                    if (action == DeRezAction.TakeCopy || action == DeRezAction.Take)
+                        item.Owner = remoteClient.AgentId;
+                    else // Delete / Return
+                        item.Owner = objectGroup.OwnerID;
 
-                userInfo.AddItem(item);
-                if (remoteClient != null && item.Owner == remoteClient.AgentId)
-                {
-                    remoteClient.SendInventoryItemCreateUpdate(item);
-                }
-                else
-                {
-                    ScenePresence notifyUser = GetScenePresence(item.Owner);
-                    if (notifyUser != null)
+                    item.ID = UUID.Random();
+                    item.AssetID = asset.FullID;
+                    item.Description = asset.Description;
+                    item.Name = asset.Name;
+                    item.AssetType = asset.Type;
+                    item.InvType = (int)InventoryType.Object;
+                    item.Folder = folderID;
+                    
+                    if (remoteClient != null && (remoteClient.AgentId != objectGroup.RootPart.OwnerID) && Permissions.PropagatePermissions())
+                    {
+                        uint perms=objectGroup.GetEffectivePermissions();
+                        uint nextPerms=(perms & 7) << 13;
+                        if ((nextPerms & (uint)PermissionMask.Copy) == 0)
+                            perms &= ~(uint)PermissionMask.Copy;
+                        if ((nextPerms & (uint)PermissionMask.Transfer) == 0)
+                            perms &= ~(uint)PermissionMask.Transfer;
+                        if ((nextPerms & (uint)PermissionMask.Modify) == 0)
+                            perms &= ~(uint)PermissionMask.Modify;
+
+                        item.BasePermissions = perms & objectGroup.RootPart.NextOwnerMask;
+                        item.CurrentPermissions = item.BasePermissions;
+                        item.NextPermissions = objectGroup.RootPart.NextOwnerMask;
+                        item.EveryOnePermissions = objectGroup.RootPart.EveryoneMask & objectGroup.RootPart.NextOwnerMask;
+                        item.GroupPermissions = objectGroup.RootPart.GroupMask & objectGroup.RootPart.NextOwnerMask;
+                        item.CurrentPermissions |= 8; // Slam!
+                    }
+                    else
+                    {
+                        item.BasePermissions = objectGroup.GetEffectivePermissions();
+                        item.CurrentPermissions = objectGroup.GetEffectivePermissions();
+                        item.NextPermissions = objectGroup.RootPart.NextOwnerMask;
+                        item.EveryOnePermissions = objectGroup.RootPart.EveryoneMask;
+                        item.GroupPermissions = objectGroup.RootPart.GroupMask;
+                    }
+
+                    // TODO: add the new fields (Flags, Sale info, etc)
+                    item.CreationDate = Util.UnixTimeSinceEpoch();
+
+                    userInfo.AddItem(item);
+                    
+                    if (remoteClient != null && item.Owner == remoteClient.AgentId)
                     {
-                        notifyUser.ControllingClient.SendInventoryItemCreateUpdate(item);
+                        remoteClient.SendInventoryItemCreateUpdate(item);
                     }
+                    else
+                    {
+                        ScenePresence notifyUser = GetScenePresence(item.Owner);
+                        if (notifyUser != null)
+                        {
+                            notifyUser.ControllingClient.SendInventoryItemCreateUpdate(item);
+                        }
+                    }                    
                 }
             }
             
@@ -2093,7 +2130,7 @@ namespace OpenSim.Region.Environment.Scenes
             CachedUserInfo userInfo = CommsManager.UserProfileCacheService.GetUserDetails(remoteClient.AgentId);
             if (userInfo != null)
             {
-                if (userInfo.RootFolder != null)
+                if (userInfo.HasReceivedInventory)
                 {
                     InventoryItemBase item = userInfo.RootFolder.FindItem(itemID);
 
@@ -2103,8 +2140,21 @@ namespace OpenSim.Region.Environment.Scenes
 
                         if (rezAsset != null)
                         {
+                            UUID itemId = UUID.Zero;
+                            
+                            // If we have permission to copy then link the rezzed object back to the user inventory
+                            // item that it came from.  This allows us to enable 'save object to inventory'
+                            if (!Permissions.BypassPermissions())
+                            {
+                                if ((item.CurrentPermissions & (uint)PermissionMask.Copy) == (uint)PermissionMask.Copy)
+                                {       
+                                    itemId = item.ID;
+                                }
+                            }
+                            
                             string xmlData = Utils.BytesToString(rezAsset.Data);
-                            SceneObjectGroup group = new SceneObjectGroup(xmlData, true);
+                            SceneObjectGroup group = new SceneObjectGroup(itemId, xmlData, true);
+                            
                             if (!Permissions.CanRezObject(
                                 group.Children.Count, remoteClient.AgentId, pos)
                                 && !attachment)
diff --git a/OpenSim/Region/Environment/Scenes/Scene.cs b/OpenSim/Region/Environment/Scenes/Scene.cs
index 5502f97..6831885 100644
--- a/OpenSim/Region/Environment/Scenes/Scene.cs
+++ b/OpenSim/Region/Environment/Scenes/Scene.cs
@@ -3480,28 +3480,19 @@ namespace OpenSim.Region.Environment.Scenes
 
         public virtual void StoreAddFriendship(UUID ownerID, UUID friendID, uint perms)
         {
-            // TODO: m_sceneGridService.DoStuff;
             m_sceneGridService.AddNewUserFriend(ownerID, friendID, perms);
         }
 
         public virtual void StoreUpdateFriendship(UUID ownerID, UUID friendID, uint perms)
         {
-            // TODO: m_sceneGridService.DoStuff;
             m_sceneGridService.UpdateUserFriendPerms(ownerID, friendID, perms);
         }
 
         public virtual void StoreRemoveFriendship(UUID ownerID, UUID ExfriendID)
         {
-            // TODO: m_sceneGridService.DoStuff;
             m_sceneGridService.RemoveUserFriend(ownerID, ExfriendID);
         }
 
-        public virtual List<FriendListItem> StoreGetFriendsForUser(UUID ownerID)
-        {
-            // TODO: m_sceneGridService.DoStuff;
-            return m_sceneGridService.GetUserFriendList(ownerID);
-        }
-
         public void AddPacketStats(int inPackets, int outPackets, int unAckedBytes)
         {
             m_statsReporter.AddInPackets(inPackets);
diff --git a/OpenSim/Region/Environment/Scenes/SceneObjectGroup.cs b/OpenSim/Region/Environment/Scenes/SceneObjectGroup.cs
index cc99929..5456282 100644
--- a/OpenSim/Region/Environment/Scenes/SceneObjectGroup.cs
+++ b/OpenSim/Region/Environment/Scenes/SceneObjectGroup.cs
@@ -401,16 +401,25 @@ namespace OpenSim.Region.Environment.Scenes
         {
             SetRootPart(part);
         }
+        
+        public SceneObjectGroup(string xmlData, bool isOriginalXmlFormat)
+            : this(UUID.Zero, xmlData, isOriginalXmlFormat)            
+        {
+        }
 
         /// <summary>
         /// Create an object using serialized data in OpenSim's original xml format.
         /// </summary>
+        /// <param name="fromUserInventoryItemID">
+        /// If applicable, the user inventory item id from which this object was rezzed.  If not applicable then this
+        /// should be UUID.Zero
+        /// </param>
         /// <param name="xmlData"></param>
         /// <param name="isOriginalXmlFormat">
         /// This parameter only exists to separate the two different xml constructors.  In the future, versions should
         /// be specified within the xml itself.
         /// </param>
-        public SceneObjectGroup(string xmlData, bool isOriginalXmlFormat)
+        public SceneObjectGroup(UUID fromUserInventoryItemID, string xmlData, bool isOriginalXmlFormat)
         {
             if (!isOriginalXmlFormat)
                 throw new Exception("This constructor must specify the xml is in OpenSim's original format");
@@ -430,7 +439,7 @@ namespace OpenSim.Region.Environment.Scenes
                 reader.Read();
                 reader.ReadStartElement("SceneObjectGroup");
                 reader.ReadStartElement("RootPart");
-                SetRootPart(SceneObjectPart.FromXml(reader));
+                SetRootPart(SceneObjectPart.FromXml(fromUserInventoryItemID, reader));
 
                 reader.ReadEndElement();
 
diff --git a/OpenSim/Region/Environment/Scenes/SceneObjectPart.cs b/OpenSim/Region/Environment/Scenes/SceneObjectPart.cs
index 10a37ee..3547cd4 100644
--- a/OpenSim/Region/Environment/Scenes/SceneObjectPart.cs
+++ b/OpenSim/Region/Environment/Scenes/SceneObjectPart.cs
@@ -116,30 +116,55 @@ namespace OpenSim.Region.Environment.Scenes
         //        for SL compatibility it should be persisted though (set sound / displaytext / particlesystem, kill script)
         [XmlIgnore]
         public UUID Sound;
+        
         [XmlIgnore]
         public byte SoundFlags;
+        
         [XmlIgnore]
         public double SoundGain;
+        
         [XmlIgnore]
         public double SoundRadius;
+        
         [XmlIgnore]
         public uint TimeStampFull = 0;
+        
         [XmlIgnore]
         public uint TimeStampLastActivity = 0; // Will be used for AutoReturn
+        
         [XmlIgnore]
         public uint TimeStampTerse = 0;
+        
         [XmlIgnore]
         public UUID FromAssetID = UUID.Zero;
+               
+        /// <value>
+        /// The UUID of the user inventory item from which this object was rezzed if this is a root part.  
+        /// If UUID.Zero then either this is not a root part or there is no connection with a user inventory item.
+        /// </value>
+        private UUID m_fromUserInventoryItemID = UUID.Zero;
+        
+        [XmlIgnore]
+        public UUID FromUserInventoryItemID
+        {
+            get { return m_fromUserInventoryItemID; }
+        }
+        
         [XmlIgnore]
         public bool IsAttachment = false;
+        
         [XmlIgnore]
         public scriptEvents AggregateScriptEvents = 0;
+        
         [XmlIgnore]
         public UUID AttachedAvatar = UUID.Zero;
+        
         [XmlIgnore]
         public Vector3 AttachedPos = Vector3.Zero;
+        
         [XmlIgnore]
         public uint AttachmentPoint = (byte)0;
+        
         [XmlIgnore]
         public PhysicsVector RotationAxis = new PhysicsVector(1f,1f,1f);
         
@@ -1428,15 +1453,27 @@ if (m_shape != null) {
         /// <summary>
         /// Restore this part from the serialized xml representation.
         /// </summary>
+        /// <param name="xmlReader"></param>
         /// <returns></returns>
         public static SceneObjectPart FromXml(XmlReader xmlReader)
         {
-            // It's not necessary to persist this
-
-            XmlSerializer serializer = new XmlSerializer(typeof (SceneObjectPart));
-            SceneObjectPart newobject = (SceneObjectPart) serializer.Deserialize(xmlReader);
-            return newobject;
+            return FromXml(UUID.Zero, xmlReader);
         }
+        
+        /// <summary>
+        /// Restore this part from the serialized xml representation.
+        /// </summary>
+        /// <param name="fromUserInventoryItemId">The inventory id from which this part came, if applicable</param>
+        /// <param name="xmlReader"></param>
+        /// <returns></returns>
+        public static SceneObjectPart FromXml(UUID fromUserInventoryItemId, XmlReader xmlReader)
+        {
+            XmlSerializer serializer = new XmlSerializer(typeof (SceneObjectPart));
+            SceneObjectPart part = (SceneObjectPart)serializer.Deserialize(xmlReader);
+            part.m_fromUserInventoryItemID = fromUserInventoryItemId;
+            
+            return part;
+        }        
 
         public UUID GetAvatarOnSitTarget()
         {
@@ -1603,7 +1640,7 @@ if (m_shape != null) {
         public void GetProperties(IClientAPI client)
         {
             client.SendObjectPropertiesReply(
-                UUID.Zero, (ulong)_creationDate, _creatorID, UUID.Zero, UUID.Zero,
+                m_fromUserInventoryItemID, (ulong)_creationDate, _creatorID, UUID.Zero, UUID.Zero,
                 _groupID, (short)InventorySerial, _lastOwnerID, UUID, _ownerID,
                 ParentGroup.RootPart.TouchName, new byte[0], ParentGroup.RootPart.SitName, Name, Description,
                 ParentGroup.RootPart._ownerMask, ParentGroup.RootPart._nextOwnerMask, ParentGroup.RootPart._groupMask, ParentGroup.RootPart._everyoneMask,