From 3a27a056073afb9f1fb285df136d2800f4f9c1a3 Mon Sep 17 00:00:00 2001 From: Justin Clarke Casey Date: Mon, 4 May 2009 17:32:20 +0000 Subject: * refactor: move OspResolver to a different namespace --- .../Framework/Communications/Osp/OspResolver.cs | 170 +++++++++++++++++++++ OpenSim/Framework/Communications/OspResolver.cs | 170 --------------------- .../Archiver/InventoryArchiveReadRequest.cs | 5 +- .../Archiver/InventoryArchiveWriteRequest.cs | 1 + .../Archiver/Tests/InventoryArchiverTests.cs | 1 + 5 files changed, 175 insertions(+), 172 deletions(-) create mode 100644 OpenSim/Framework/Communications/Osp/OspResolver.cs delete mode 100644 OpenSim/Framework/Communications/OspResolver.cs diff --git a/OpenSim/Framework/Communications/Osp/OspResolver.cs b/OpenSim/Framework/Communications/Osp/OspResolver.cs new file mode 100644 index 0000000..a62e1c0 --- /dev/null +++ b/OpenSim/Framework/Communications/Osp/OspResolver.cs @@ -0,0 +1,170 @@ +/* + * 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 OpenSim 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.Framework.Communications.Cache; + +namespace OpenSim.Framework.Communications.Osp +{ + /// + /// 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. + /// + 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 = "="; + + /// + /// Make an OSPA given a user UUID + /// + /// + /// + /// The OSPA. Null if a user with the given UUID could not be found. + public static string MakeOspa(UUID userId, CommunicationsManager commsManager) + { + CachedUserInfo userInfo = commsManager.UserProfileCacheService.GetUserDetails(userId); + if (userInfo != null) + return MakeOspa(userInfo.UserProfile.FirstName, userInfo.UserProfile.SurName); + + return null; + } + + /// + /// Make an OSPA given a user name + /// + /// + /// + public static string MakeOspa(string firstName, string lastName) + { + return + OSPA_PREFIX + OSPA_NAME_KEY + OSPA_PAIR_SEPARATOR + firstName + OSPA_NAME_VALUE_SEPARATOR + lastName; + } + + /// + /// Resolve an osp string into the most suitable internal OpenSim identifier. + /// + /// + /// 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. + /// + /// + /// + /// + /// A suitable internal OpenSim identifier. If the input string wasn't ospi data, then we simply + /// return that same string. If the input string was ospi data but no valid profile information has been found, + /// then returns null. + /// + public static string ResolveOspa(string ospa, CommunicationsManager commsManager) + { + m_log.DebugFormat("[OSP RESOLVER]: Resolving {0}", ospa); + + if (!ospa.StartsWith(OSPA_PREFIX)) + return 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, commsManager); + } + + return null; + } + + /// + /// Hash a profile name into a UUID + /// + /// + /// + public static UUID HashName(string name) + { + return new UUID(Utils.MD5(Encoding.Unicode.GetBytes(name)), 0); + } + + /// + /// 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. + /// + /// + /// + /// + /// An OpenSim internal identifier for the name given. Returns null if the name was not valid + /// + protected static string ResolveOspaName(string name, CommunicationsManager commsManager) + { + int nameSeparatorIndex = name.IndexOf(OSPA_NAME_VALUE_SEPARATOR); + + if (nameSeparatorIndex < 0) + { + m_log.WarnFormat("[OSP RESOLVER]: Ignoring unseparated name {0}", name); + return null; + } + + string firstName = name.Remove(nameSeparatorIndex).TrimEnd(); + string lastName = name.Substring(nameSeparatorIndex + 1).TrimStart(); + + CachedUserInfo userInfo = commsManager.UserProfileCacheService.GetUserDetails(firstName, lastName); + if (userInfo != null) + return userInfo.UserProfile.ID.ToString(); + + 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.ToString(); + } + } +} diff --git a/OpenSim/Framework/Communications/OspResolver.cs b/OpenSim/Framework/Communications/OspResolver.cs deleted file mode 100644 index 073abf8..0000000 --- a/OpenSim/Framework/Communications/OspResolver.cs +++ /dev/null @@ -1,170 +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 OpenSim 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.Framework.Communications.Cache; - -namespace OpenSim.Framework.Communications -{ - /// - /// 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. - /// - 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 = "="; - - /// - /// Make an OSPA given a user UUID - /// - /// - /// - /// The OSPA. Null if a user with the given UUID could not be found. - public static string MakeOspa(UUID userId, CommunicationsManager commsManager) - { - CachedUserInfo userInfo = commsManager.UserProfileCacheService.GetUserDetails(userId); - if (userInfo != null) - return MakeOspa(userInfo.UserProfile.FirstName, userInfo.UserProfile.SurName); - - return null; - } - - /// - /// Make an OSPA given a user name - /// - /// - /// - public static string MakeOspa(string firstName, string lastName) - { - return - OSPA_PREFIX + OSPA_NAME_KEY + OSPA_PAIR_SEPARATOR + firstName + OSPA_NAME_VALUE_SEPARATOR + lastName; - } - - /// - /// Resolve an osp string into the most suitable internal OpenSim identifier. - /// - /// - /// 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. - /// - /// - /// - /// - /// A suitable internal OpenSim identifier. If the input string wasn't ospi data, then we simply - /// return that same string. If the input string was ospi data but no valid profile information has been found, - /// then returns null. - /// - public static string ResolveOspa(string ospa, CommunicationsManager commsManager) - { - m_log.DebugFormat("[OSP RESOLVER]: Resolving {0}", ospa); - - if (!ospa.StartsWith(OSPA_PREFIX)) - return 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, commsManager); - } - - return null; - } - - /// - /// Hash a profile name into a UUID - /// - /// - /// - public static UUID HashName(string name) - { - return new UUID(Utils.MD5(Encoding.Unicode.GetBytes(name)), 0); - } - - /// - /// 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. - /// - /// - /// - /// - /// An OpenSim internal identifier for the name given. Returns null if the name was not valid - /// - protected static string ResolveOspaName(string name, CommunicationsManager commsManager) - { - int nameSeparatorIndex = name.IndexOf(OSPA_NAME_VALUE_SEPARATOR); - - if (nameSeparatorIndex < 0) - { - m_log.WarnFormat("[OSP RESOLVER]: Ignoring unseparated name {0}", name); - return null; - } - - string firstName = name.Remove(nameSeparatorIndex).TrimEnd(); - string lastName = name.Substring(nameSeparatorIndex + 1).TrimStart(); - - CachedUserInfo userInfo = commsManager.UserProfileCacheService.GetUserDetails(firstName, lastName); - if (userInfo != null) - return userInfo.UserProfile.ID.ToString(); - - 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.ToString(); - } - } -} diff --git a/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiveReadRequest.cs b/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiveReadRequest.cs index d9c154a..bf3097a 100644 --- a/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiveReadRequest.cs +++ b/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiveReadRequest.cs @@ -35,10 +35,11 @@ using System.Xml; using log4net; using OpenMetaverse; using OpenSim.Framework; -using OpenSim.Framework.Serialization; -using OpenSim.Framework.Serialization.External; using OpenSim.Framework.Communications; using OpenSim.Framework.Communications.Cache; +using OpenSim.Framework.Communications.Osp; +using OpenSim.Framework.Serialization; +using OpenSim.Framework.Serialization.External; using OpenSim.Region.CoreModules.World.Archiver; namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver diff --git a/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiveWriteRequest.cs b/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiveWriteRequest.cs index 4747f1f..924d6d9 100644 --- a/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiveWriteRequest.cs +++ b/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiveWriteRequest.cs @@ -38,6 +38,7 @@ using OpenSim.Framework.Serialization; using OpenSim.Framework.Serialization.External; using OpenSim.Framework.Communications; using OpenSim.Framework.Communications.Cache; +using OpenSim.Framework.Communications.Osp; using OpenSim.Region.CoreModules.World.Archiver; using OpenSim.Region.Framework.Scenes; diff --git a/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/Tests/InventoryArchiverTests.cs b/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/Tests/InventoryArchiverTests.cs index 214f494..274e329 100644 --- a/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/Tests/InventoryArchiverTests.cs +++ b/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/Tests/InventoryArchiverTests.cs @@ -40,6 +40,7 @@ using OpenSim.Framework.Serialization; using OpenSim.Framework.Serialization.External; using OpenSim.Framework.Communications; using OpenSim.Framework.Communications.Cache; +using OpenSim.Framework.Communications.Osp; using OpenSim.Region.CoreModules.Avatar.Inventory.Archiver; using OpenSim.Region.CoreModules.World.Serialiser; using OpenSim.Region.Framework.Scenes; -- cgit v1.1