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.

3 files changed, 295 insertions, 8 deletions

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/Serialization/External/OspResolver.cs b/OpenSim/Framework/Serialization/External/OspResolver.cs
new file mode 100644
index 0000000..53c35ff
--- /dev/null
+++ b/OpenSim/Framework/Serialization/External/OspResolver.cs
@@ -0,0 +1,177 @@
+/*
+ * 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.Reflection;
+using System.Text;
+using log4net;
+using OpenMetaverse;
+using OpenSim.Framework;
+using OpenSim.Services.Interfaces;
+
+namespace OpenSim.Framework.Serialization
+{
+    /// <summary>
+    /// Resolves OpenSim Profile Anchors (OSPA).  An OSPA is a string used to provide information for 
+    /// identifying user profiles or supplying a simple name if no profile is available.
+    /// </summary>
+    public class OspResolver
+    {
+        private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
+        
+        public const string OSPA_PREFIX = "ospa:";
+        public const string OSPA_NAME_KEY = "n";
+        public const string OSPA_NAME_VALUE_SEPARATOR = " ";
+        public const string OSPA_TUPLE_SEPARATOR = "|";
+        public static readonly char[] OSPA_TUPLE_SEPARATOR_ARRAY = OSPA_TUPLE_SEPARATOR.ToCharArray();
+        public const string OSPA_PAIR_SEPARATOR = "=";
+
+        /// <summary>
+        /// Make an OSPA given a user UUID
+        /// </summary>
+        /// <param name="userId"></param>
+        /// <param name="commsManager"></param>
+        /// <returns>The OSPA.  Null if a user with the given UUID could not be found.</returns>
+        public static string MakeOspa(UUID userId, IUserAccountService userService)
+        {
+            UserAccount account = userService.GetUserAccount(UUID.Zero, userId);
+            if (account != null)
+                return MakeOspa(account.FirstName, account.LastName);
+
+            return null;
+        }
+        
+        /// <summary>
+        /// Make an OSPA given a user name
+        /// </summary>
+        /// <param name="name"></param>
+        /// <returns></returns>
+        public static string MakeOspa(string firstName, string lastName)
+        {
+            return 
+                OSPA_PREFIX + OSPA_NAME_KEY + OSPA_PAIR_SEPARATOR + firstName + OSPA_NAME_VALUE_SEPARATOR + lastName;
+        }
+        
+        /// <summary>
+        /// Resolve an osp string into the most suitable internal OpenSim identifier.
+        /// </summary>
+        /// 
+        /// In some cases this will be a UUID if a suitable profile exists on the system.  In other cases, this may
+        /// just return the same identifier after creating a temporary profile.
+        /// 
+        /// <param name="ospa"></param>
+        /// <param name="commsManager"></param>
+        /// <returns>
+        /// A suitable UUID for use in Second Life client communication.  If the string was not a valid ospa, then UUID.Zero
+        /// is returned.
+        /// </returns>
+        public static UUID ResolveOspa(string ospa, IUserAccountService userService)
+        {
+            if (!ospa.StartsWith(OSPA_PREFIX))
+                return UUID.Zero;
+
+//            m_log.DebugFormat("[OSP RESOLVER]: Resolving {0}", ospa);
+            
+            string ospaMeat = ospa.Substring(OSPA_PREFIX.Length);
+            string[] ospaTuples = ospaMeat.Split(OSPA_TUPLE_SEPARATOR_ARRAY);
+            
+            foreach (string tuple in ospaTuples)
+            {
+                int tupleSeparatorIndex = tuple.IndexOf(OSPA_PAIR_SEPARATOR);
+
+                if (tupleSeparatorIndex < 0)
+                {
+                    m_log.WarnFormat("[OSP RESOLVER]: Ignoring non-tuple component {0} in OSPA {1}", tuple, ospa);
+                    continue;
+                }
+                
+                string key = tuple.Remove(tupleSeparatorIndex).Trim();
+                string value = tuple.Substring(tupleSeparatorIndex + 1).Trim();
+                
+                if (OSPA_NAME_KEY == key)
+                    return ResolveOspaName(value, userService);
+            }
+            
+            return UUID.Zero;
+        }
+        
+        /// <summary>
+        /// Hash a profile name into a UUID
+        /// </summary>
+        /// <param name="name"></param>
+        /// <returns></returns>
+        public static UUID HashName(string name)
+        {
+            return new UUID(Utils.MD5(Encoding.Unicode.GetBytes(name)), 0);
+        }
+        
+        /// <summary>
+        /// Resolve an OSPI name by querying existing persistent user profiles.  If there is no persistent user profile
+        /// then a temporary user profile is inserted in the cache.
+        /// </summary>
+        /// <param name="name"></param>
+        /// <param name="commsManager"></param>
+        /// <returns>
+        /// An OpenSim internal identifier for the name given.  Returns null if the name was not valid
+        /// </returns>
+        protected static UUID ResolveOspaName(string name, IUserAccountService userService)
+        {
+            if (userService == null)
+                return UUID.Zero;
+
+            int nameSeparatorIndex = name.IndexOf(OSPA_NAME_VALUE_SEPARATOR);
+            
+            if (nameSeparatorIndex < 0)
+            {
+                m_log.WarnFormat("[OSP RESOLVER]: Ignoring unseparated name {0}", name);
+                return UUID.Zero;
+            }
+            
+            string firstName = name.Remove(nameSeparatorIndex).TrimEnd();
+            string lastName = name.Substring(nameSeparatorIndex + 1).TrimStart();
+
+            UserAccount account = userService.GetUserAccount(UUID.Zero, firstName, lastName);
+            if (account != null)
+                return account.PrincipalID;
+
+            // XXX: Disable temporary user profile creation for now as implementation is incomplete - justincc
+            /*
+            UserProfileData tempUserProfile = new UserProfileData();
+            tempUserProfile.FirstName = firstName;
+            tempUserProfile.SurName = lastName;
+            tempUserProfile.ID = HashName(tempUserProfile.Name);
+            
+            m_log.DebugFormat(
+                "[OSP RESOLVER]: Adding temporary user profile for {0} {1}", tempUserProfile.Name, tempUserProfile.ID);
+            commsManager.UserService.AddTemporaryUserProfile(tempUserProfile);
+            
+            return tempUserProfile.ID;
+            */
+
+            return UUID.Zero;
+        }
+    }
+}
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();