Preservation of creator information now also working in IARs. Cleaned up usage help. Moved Osp around, deleted unnecessary OspInventoryWrapperPlugin, added manipulation of SOP's xml representation in a generic ExternalRepresentationUtils function.

5 files changed, 139 insertions, 113 deletions

diff --git a/OpenSim/Framework/Communications/Osp/OspInventoryWrapperPlugin.cs b/OpenSim/Framework/Communications/Osp/OspInventoryWrapperPlugin.cs
deleted file mode 100644
index bcd1eee..0000000
--- a/OpenSim/Framework/Communications/Osp/OspInventoryWrapperPlugin.cs
+++ /dev/null
@@ -1,104 +0,0 @@
-/*
- * 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.Collections.Generic;
-using OpenSim.Data;
-using OpenMetaverse;
-using OpenSim.Services.Interfaces;
-
-namespace OpenSim.Framework.Communications.Osp
-{
-    /// <summary>
-    /// Wrap other inventory data plugins so that we can perform OSP related post processing for items
-    /// </summary>
-    public class OspInventoryWrapperPlugin : IInventoryDataPlugin
-    {
-        protected IInventoryDataPlugin m_wrappedPlugin;
-        //protected CommunicationsManager m_commsManager;
-        protected IUserAccountService m_userAccountService;
-
-        public OspInventoryWrapperPlugin(IInventoryDataPlugin wrappedPlugin, IUserAccountService userService)
-        {
-            m_wrappedPlugin = wrappedPlugin;
-            m_userAccountService = userService;
-        }
-            
-        public string Name { get { return "OspInventoryWrapperPlugin"; } }
-        public string Version { get { return "0.1"; } }
-        public void Initialise() {}
-        public void Initialise(string connect) {}
-        public void Dispose() {}
-
-        public InventoryItemBase getInventoryItem(UUID item)
-        {
-            return PostProcessItem(m_wrappedPlugin.getInventoryItem(item));
-        }
-
-        // XXX: Why on earth does this exist as it appears to duplicate getInventoryItem?
-        public InventoryItemBase queryInventoryItem(UUID item)
-        {
-            return PostProcessItem(m_wrappedPlugin.queryInventoryItem(item));
-        }
-        
-        public List<InventoryItemBase> getInventoryInFolder(UUID folderID)
-        {
-            List<InventoryItemBase> items = m_wrappedPlugin.getInventoryInFolder(folderID);
-            
-            foreach (InventoryItemBase item in items)
-                PostProcessItem(item);
-
-            return items;
-        }
-
-        public List<InventoryItemBase> fetchActiveGestures(UUID avatarID)
-        {
-            return m_wrappedPlugin.fetchActiveGestures(avatarID);
-
-            // Presuming that no post processing is needed here as gestures don't refer to creator information (?)
-        }
-
-        protected InventoryItemBase PostProcessItem(InventoryItemBase item)
-        {
-            item.CreatorIdAsUuid = OspResolver.ResolveOspa(item.CreatorId, m_userAccountService);
-            return item;
-        }
-        
-        public List<InventoryFolderBase> getFolderHierarchy(UUID parentID) { return m_wrappedPlugin.getFolderHierarchy(parentID); }
-        public List<InventoryFolderBase> getUserRootFolders(UUID user) { return m_wrappedPlugin.getUserRootFolders(user); }
-        public InventoryFolderBase getUserRootFolder(UUID user) { return m_wrappedPlugin.getUserRootFolder(user); }
-        public List<InventoryFolderBase> getInventoryFolders(UUID parentID) { return m_wrappedPlugin.getInventoryFolders(parentID); }
-        public InventoryFolderBase getInventoryFolder(UUID folder) { return m_wrappedPlugin.getInventoryFolder(folder); }
-        public void addInventoryItem(InventoryItemBase item) { m_wrappedPlugin.addInventoryItem(item); }
-        public void updateInventoryItem(InventoryItemBase item) { m_wrappedPlugin.updateInventoryItem(item); }
-        public void deleteInventoryItem(UUID item) { m_wrappedPlugin.deleteInventoryItem(item); }
-        public InventoryFolderBase queryInventoryFolder(UUID folder) { return m_wrappedPlugin.queryInventoryFolder(folder); }
-        public void addInventoryFolder(InventoryFolderBase folder) { m_wrappedPlugin.addInventoryFolder(folder); }
-        public void updateInventoryFolder(InventoryFolderBase folder) { m_wrappedPlugin.updateInventoryFolder(folder); }
-        public void moveInventoryFolder(InventoryFolderBase folder) { m_wrappedPlugin.moveInventoryFolder(folder); }
-        public void deleteInventoryFolder(UUID folder) { m_wrappedPlugin.deleteInventoryFolder(folder); }
-    }
-}
diff --git a/OpenSim/Framework/Serialization/External/ExternalRepresentationUtils.cs b/OpenSim/Framework/Serialization/External/ExternalRepresentationUtils.cs
new file mode 100644
index 0000000..5c0630c
--- /dev/null
+++ b/OpenSim/Framework/Serialization/External/ExternalRepresentationUtils.cs
@@ -0,0 +1,87 @@
+/*
+ * 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.IO;
+using System.Xml;
+
+using OpenMetaverse;
+using OpenSim.Services.Interfaces;
+
+namespace OpenSim.Framework.Serialization.External
+{
+    public class ExternalRepresentationUtils
+    {
+        public static string RewriteSOP(string xml, string profileURL, IUserAccountService userService, UUID scopeID)
+        {
+            if (xml == string.Empty || profileURL == string.Empty || userService == null)
+                return xml;
+
+            XmlDocument doc = new XmlDocument();
+            doc.LoadXml(xml);
+            XmlNodeList sops = doc.GetElementsByTagName("SceneObjectPart");
+
+            foreach (XmlNode sop in sops)
+            {
+                UserAccount creator = null;
+                bool hasCreatorData = false;
+                XmlNodeList nodes = sop.ChildNodes;
+                foreach (XmlNode node in nodes)
+                {
+                    if (node.Name == "CreatorID")
+                    {
+                        UUID uuid = UUID.Zero;
+                        UUID.TryParse(node.InnerText, out uuid);
+                        creator = userService.GetUserAccount(scopeID, uuid);
+                    }
+                    if (node.Name == "CreatorData" && node.InnerText != null && node.InnerText != string.Empty)
+                        hasCreatorData = true;
+
+                    //if (node.Name == "OwnerID")
+                    //{
+                    //    UserAccount owner = GetUser(node.InnerText);
+                    //    if (owner != null)
+                    //        node.InnerText = m_ProfileServiceURL + "/" + node.InnerText + "/" + owner.FirstName + " " + owner.LastName;
+                    //}
+                }
+                if (!hasCreatorData && creator != null)
+                {
+                    XmlElement creatorData = doc.CreateElement("CreatorData");
+                    creatorData.InnerText = profileURL + "/" + creator.PrincipalID + ";" + creator.FirstName + " " + creator.LastName;
+                    sop.AppendChild(creatorData);
+                }
+            }
+
+            using (StringWriter wr = new StringWriter())
+            {
+                doc.Save(wr);
+                return wr.ToString();
+            }
+
+        }
+    }
+}
diff --git a/OpenSim/Framework/Communications/Osp/OspResolver.cs b/OpenSim/Framework/Serialization/External/OspResolver.cs
index 24ea64d..53c35ff 100644
--- a/OpenSim/Framework/Communications/Osp/OspResolver.cs
+++ b/OpenSim/Framework/Serialization/External/OspResolver.cs
@@ -32,7 +32,7 @@ using OpenMetaverse;
 using OpenSim.Framework;
 using OpenSim.Services.Interfaces;
 
-namespace OpenSim.Framework.Communications.Osp
+namespace OpenSim.Framework.Serialization
 {
     /// <summary>
     /// Resolves OpenSim Profile Anchors (OSPA).  An OSPA is a string used to provide information for 
diff --git a/OpenSim/Framework/Serialization/External/UserInventoryItemSerializer.cs b/OpenSim/Framework/Serialization/External/UserInventoryItemSerializer.cs
index df9af32..d5e84c7 100644
--- a/OpenSim/Framework/Serialization/External/UserInventoryItemSerializer.cs
+++ b/OpenSim/Framework/Serialization/External/UserInventoryItemSerializer.cs
@@ -35,6 +35,7 @@ using System.Xml;
 using log4net;
 using OpenMetaverse;
 using OpenSim.Framework;
+using OpenSim.Services.Interfaces;
     
 namespace OpenSim.Framework.Serialization.External
 {        
@@ -56,6 +57,8 @@ namespace OpenSim.Framework.Serialization.External
             m_InventoryItemXmlProcessors.Add("ID", ProcessID);
             m_InventoryItemXmlProcessors.Add("InvType", ProcessInvType);
             m_InventoryItemXmlProcessors.Add("CreatorUUID", ProcessCreatorUUID);
+            m_InventoryItemXmlProcessors.Add("CreatorID", ProcessCreatorID); 
+            m_InventoryItemXmlProcessors.Add("CreatorData", ProcessCreatorData);
             m_InventoryItemXmlProcessors.Add("CreationDate", ProcessCreationDate);
             m_InventoryItemXmlProcessors.Add("Owner", ProcessOwner);
             m_InventoryItemXmlProcessors.Add("Description", ProcessDescription);
@@ -94,6 +97,12 @@ namespace OpenSim.Framework.Serialization.External
             item.CreatorId = reader.ReadElementContentAsString("CreatorUUID", String.Empty);
         }
 
+        private static void ProcessCreatorID(InventoryItemBase item, XmlTextReader reader)
+        {
+            // when it exists, this overrides the previous
+            item.CreatorId = reader.ReadElementContentAsString("CreatorID", String.Empty);
+        }
+
         private static void ProcessCreationDate(InventoryItemBase item, XmlTextReader reader)
         {
             item.CreationDate = reader.ReadElementContentAsInt("CreationDate", String.Empty);
@@ -161,12 +170,12 @@ namespace OpenSim.Framework.Serialization.External
 
         private static void ProcessGroupOwned(InventoryItemBase item, XmlTextReader reader)
         {
-            //item.GroupOwned = reader.ReadElementContentAsBoolean("GroupOwned", String.Empty);
-            // We don't do that, because ReadElementContentAsBoolean assumes lower case strings,
-            // and they may not be lower case
-            reader.ReadStartElement(); // GroupOwned
-            item.GroupOwned = Boolean.Parse(reader.ReadContentAsString().ToLower());
-            reader.ReadEndElement();
+            item.GroupOwned = Util.ReadBoolean(reader);
+        }
+
+        private static void ProcessCreatorData(InventoryItemBase item, XmlTextReader reader)
+        {
+            item.CreatorData = reader.ReadElementContentAsString("CreatorData", String.Empty);
         }
 
         #endregion
@@ -231,7 +240,7 @@ namespace OpenSim.Framework.Serialization.External
 
         }      
         
-        public static string Serialize(InventoryItemBase inventoryItem)
+        public static string Serialize(InventoryItemBase inventoryItem, Dictionary<string, object> options, IUserAccountService userAccountService)
         {
             StringWriter sw = new StringWriter();
             XmlTextWriter writer = new XmlTextWriter(sw);
@@ -250,7 +259,7 @@ namespace OpenSim.Framework.Serialization.External
             writer.WriteString(inventoryItem.InvType.ToString());
             writer.WriteEndElement();
             writer.WriteStartElement("CreatorUUID");
-            writer.WriteString(inventoryItem.CreatorId);
+            writer.WriteString(OspResolver.MakeOspa(inventoryItem.CreatorIdAsUuid, userAccountService));
             writer.WriteEndElement();
             writer.WriteStartElement("CreationDate");
             writer.WriteString(inventoryItem.CreationDate.ToString());
@@ -294,6 +303,20 @@ namespace OpenSim.Framework.Serialization.External
             writer.WriteStartElement("GroupOwned");
             writer.WriteString(inventoryItem.GroupOwned.ToString());
             writer.WriteEndElement();
+            if (inventoryItem.CreatorData != null && inventoryItem.CreatorData != string.Empty)
+                writer.WriteElementString("CreatorData", inventoryItem.CreatorData);
+            else if (options.ContainsKey("profile"))
+            {
+                if (userAccountService != null)
+                {
+                    UserAccount account = userAccountService.GetUserAccount(UUID.Zero, inventoryItem.CreatorIdAsUuid);
+                    if (account != null)
+                    {
+                        writer.WriteElementString("CreatorData", (string)options["profile"] + "/" + inventoryItem.CreatorIdAsUuid + ";" + account.FirstName + " " + account.LastName);
+                    }
+                    writer.WriteElementString("CreatorID", inventoryItem.CreatorId);
+                }
+            }
 
             writer.WriteEndElement();
             
diff --git a/OpenSim/Framework/Util.cs b/OpenSim/Framework/Util.cs
index 101ece4..8d1671a 100644
--- a/OpenSim/Framework/Util.cs
+++ b/OpenSim/Framework/Util.cs
@@ -1558,6 +1558,16 @@ namespace OpenSim.Framework
             return string.Empty;
         }
 
+        #region Xml Serialization Utilities
+        public static bool ReadBoolean(XmlTextReader reader)
+        {
+            reader.ReadStartElement();
+            bool result = Boolean.Parse(reader.ReadContentAsString().ToLower());
+            reader.ReadEndElement();
+
+            return result;
+        }
+
         public static UUID ReadUUID(XmlTextReader reader, string name)
         {
             UUID id;
@@ -1619,5 +1629,15 @@ namespace OpenSim.Framework
             return quat;
         }
 
+        public static T ReadEnum<T>(XmlTextReader reader, string name)
+        {
+            string value = reader.ReadElementContentAsString(name, String.Empty);
+            // !!!!! to deal with flags without commas
+            if (value.Contains(" ") && !value.Contains(","))
+                value = value.Replace(" ", ", ");
+
+            return (T)Enum.Parse(typeof(T), value); ;
+        }
+        #endregion
     }
 }