/* * 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.Reflection; using System.Threading; using OpenSim.Framework; using OpenSim.Framework.Console; using OpenSim.Framework.Monitoring; using OpenSim.Region.ClientStack.LindenUDP; using OpenSim.Region.Framework; using OpenSim.Region.Framework.Interfaces; using OpenSim.Region.Framework.Scenes; using OpenSim.Services.Interfaces; using OpenSim.Services.Connectors.Hypergrid; using OpenMetaverse; using OpenMetaverse.Packets; using log4net; using Nini.Config; using Mono.Addins; using DirFindFlags = OpenMetaverse.DirectoryManager.DirFindFlags; namespace OpenSim.Region.CoreModules.Framework.UserManagement { [Extension(Path = "/OpenSim/RegionModules", NodeName = "RegionModule", Id = "UserManagementModule")] public class UserManagementModule : ISharedRegionModule, IUserManagement, IPeople { private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType); protected bool m_Enabled; protected List m_Scenes = new List(); protected IServiceThrottleModule m_ServiceThrottle; // The cache protected Dictionary m_UserCache = new Dictionary(); protected bool m_DisplayChangingHomeURI = false; #region ISharedRegionModule public void Initialise(IConfigSource config) { string umanmod = config.Configs["Modules"].GetString("UserManagementModule", Name); if (umanmod == Name) { m_Enabled = true; Init(); m_log.DebugFormat("[USER MANAGEMENT MODULE]: {0} is enabled", Name); } if(!m_Enabled) { return; } IConfig userManagementConfig = config.Configs["UserManagement"]; if (userManagementConfig == null) return; m_DisplayChangingHomeURI = userManagementConfig.GetBoolean("DisplayChangingHomeURI", false); } public bool IsSharedModule { get { return true; } } public virtual string Name { get { return "BasicUserManagementModule"; } } public Type ReplaceableInterface { get { return null; } } public void AddRegion(Scene scene) { if (m_Enabled) { lock (m_Scenes) { m_Scenes.Add(scene); } scene.RegisterModuleInterface(this); scene.RegisterModuleInterface(this); scene.EventManager.OnNewClient += new EventManager.OnNewClientDelegate(EventManager_OnNewClient); scene.EventManager.OnPrimsLoaded += new EventManager.PrimsLoaded(EventManager_OnPrimsLoaded); } } public void RemoveRegion(Scene scene) { if (m_Enabled) { scene.UnregisterModuleInterface(this); lock (m_Scenes) { m_Scenes.Remove(scene); } } } public void RegionLoaded(Scene s) { if (m_Enabled && m_ServiceThrottle == null) m_ServiceThrottle = s.RequestModuleInterface(); } public void PostInitialise() { } public void Close() { lock (m_Scenes) { m_Scenes.Clear(); } lock (m_UserCache) m_UserCache.Clear(); } #endregion ISharedRegionModule #region Event Handlers void EventManager_OnPrimsLoaded(Scene s) { // let's sniff all the user names referenced by objects in the scene m_log.DebugFormat("[USER MANAGEMENT MODULE]: Caching creators' data from {0} ({1} objects)...", s.RegionInfo.RegionName, s.GetEntities().Length); s.ForEachSOG(delegate(SceneObjectGroup sog) { CacheCreators(sog); }); } void EventManager_OnNewClient(IClientAPI client) { client.OnConnectionClosed += new Action(HandleConnectionClosed); client.OnNameFromUUIDRequest += new UUIDNameRequest(HandleUUIDNameRequest); client.OnAvatarPickerRequest += new AvatarPickerRequest(HandleAvatarPickerRequest); } void HandleConnectionClosed(IClientAPI client) { client.OnNameFromUUIDRequest -= new UUIDNameRequest(HandleUUIDNameRequest); client.OnAvatarPickerRequest -= new AvatarPickerRequest(HandleAvatarPickerRequest); } void HandleUUIDNameRequest(UUID uuid, IClientAPI client) { // m_log.DebugFormat( // "[USER MANAGEMENT MODULE]: Handling request for name binding of UUID {0} from {1}", // uuid, remote_client.Name); if (m_Scenes[0].LibraryService != null && (m_Scenes[0].LibraryService.LibraryRootFolder.Owner == uuid)) { client.SendNameReply(uuid, "Mr", "OpenSim"); } else { UserData user; /* bypass that continuation here when entry is already available */ lock (m_UserCache) { if (m_UserCache.TryGetValue(uuid, out user)) { if (!user.IsUnknownUser && user.HasGridUserTried) { client.SendNameReply(uuid, user.FirstName, user.LastName); return; } } } // Not found in cache, queue continuation m_ServiceThrottle.Enqueue("name", uuid.ToString(), delegate { //m_log.DebugFormat("[YYY]: Name request {0}", uuid); // As least upto September 2013, clients permanently cache UUID -> Name bindings. Some clients // appear to clear this when the user asks it to clear the cache, but others may not. // // So to avoid clients // (particularly Hypergrid clients) permanently binding "Unknown User" to a given UUID, we will // instead drop the request entirely. if (GetUser(uuid, out user)) { client.SendNameReply(uuid, user.FirstName, user.LastName); } // else // m_log.DebugFormat( // "[USER MANAGEMENT MODULE]: No bound name for {0} found, ignoring request from {1}", // uuid, client.Name); }); } } public void HandleAvatarPickerRequest(IClientAPI client, UUID avatarID, UUID RequestID, string query) { //EventManager.TriggerAvatarPickerRequest(); m_log.DebugFormat("[USER MANAGEMENT MODULE]: HandleAvatarPickerRequest for {0}", query); List users = GetUserData(query, 500, 1); AvatarPickerReplyPacket replyPacket = (AvatarPickerReplyPacket)PacketPool.Instance.GetPacket(PacketType.AvatarPickerReply); // TODO: don't create new blocks if recycling an old packet AvatarPickerReplyPacket.DataBlock[] searchData = new AvatarPickerReplyPacket.DataBlock[users.Count]; AvatarPickerReplyPacket.AgentDataBlock agentData = new AvatarPickerReplyPacket.AgentDataBlock(); agentData.AgentID = avatarID; agentData.QueryID = RequestID; replyPacket.AgentData = agentData; //byte[] bytes = new byte[AvatarResponses.Count*32]; int i = 0; foreach (UserData item in users) { UUID translatedIDtem = item.Id; searchData[i] = new AvatarPickerReplyPacket.DataBlock(); searchData[i].AvatarID = translatedIDtem; searchData[i].FirstName = Utils.StringToBytes((string)item.FirstName); searchData[i].LastName = Utils.StringToBytes((string)item.LastName); i++; } if (users.Count == 0) { searchData = new AvatarPickerReplyPacket.DataBlock[0]; } replyPacket.Data = searchData; AvatarPickerReplyAgentDataArgs agent_data = new AvatarPickerReplyAgentDataArgs(); agent_data.AgentID = replyPacket.AgentData.AgentID; agent_data.QueryID = replyPacket.AgentData.QueryID; List data_args = new List(); for (i = 0; i < replyPacket.Data.Length; i++) { AvatarPickerReplyDataArgs data_arg = new AvatarPickerReplyDataArgs(); data_arg.AvatarID = replyPacket.Data[i].AvatarID; data_arg.FirstName = replyPacket.Data[i].FirstName; data_arg.LastName = replyPacket.Data[i].LastName; data_args.Add(data_arg); } client.SendAvatarPickerReply(agent_data, data_args); } protected virtual void AddAdditionalUsers(string query, List users) { } #endregion Event Handlers #region IPeople public List GetUserData(string query, int page_size, int page_number) { // search the user accounts service List accs = m_Scenes[0].UserAccountService.GetUserAccounts(m_Scenes[0].RegionInfo.ScopeID, query); List users = new List(); if (accs != null) { foreach (UserAccount acc in accs) { UserData ud = new UserData(); ud.FirstName = acc.FirstName; ud.LastName = acc.LastName; ud.Id = acc.PrincipalID; ud.HasGridUserTried = true; ud.IsUnknownUser = false; users.Add(ud); } } // search the local cache foreach (UserData data in m_UserCache.Values) { if (data.Id != UUID.Zero && !data.IsUnknownUser && users.Find(delegate(UserData d) { return d.Id == data.Id; }) == null && (data.FirstName.ToLower().StartsWith(query.ToLower()) || data.LastName.ToLower().StartsWith(query.ToLower()))) users.Add(data); } AddAdditionalUsers(query, users); return users; } #endregion IPeople private void CacheCreators(SceneObjectGroup sog) { //m_log.DebugFormat("[USER MANAGEMENT MODULE]: processing {0} {1}; {2}", sog.RootPart.Name, sog.RootPart.CreatorData, sog.RootPart.CreatorIdentification); AddUser(sog.RootPart.CreatorID, sog.RootPart.CreatorData); foreach (SceneObjectPart sop in sog.Parts) { AddUser(sop.CreatorID, sop.CreatorData); foreach (TaskInventoryItem item in sop.TaskInventory.Values) AddUser(item.CreatorID, item.CreatorData); } } #region IUserManagement public UUID GetUserIdByName(string name) { string[] parts = name.Split(new string[] { " " }, StringSplitOptions.RemoveEmptyEntries); if (parts.Length < 2) throw new Exception("Name must have 2 components"); return GetUserIdByName(parts[0], parts[1]); } public UUID GetUserIdByName(string firstName, string lastName) { // TODO: Optimize for reverse lookup if this gets used by non-console commands. lock (m_UserCache) { foreach (UserData user in m_UserCache.Values) { if (user.FirstName == firstName && user.LastName == lastName) return user.Id; } } UserAccount account = m_Scenes[0].UserAccountService.GetUserAccount(UUID.Zero, firstName, lastName); if (account != null) return account.PrincipalID; return UUID.Zero; } public string GetUserName(UUID uuid) { UserData user; GetUser(uuid, out user); return user.FirstName + " " + user.LastName; } public string GetUserHomeURL(UUID userID) { UserData user; if(GetUser(userID, out user)) { return user.HomeURL; } return string.Empty; } public string GetUserServerURL(UUID userID, string serverType) { UserData userdata; if(!GetUser(userID, out userdata)) { return string.Empty; } if (userdata.ServerURLs != null && userdata.ServerURLs.ContainsKey(serverType) && userdata.ServerURLs[serverType] != null) { return userdata.ServerURLs[serverType].ToString(); } if (!string.IsNullOrEmpty(userdata.HomeURL)) { // m_log.DebugFormat("[USER MANAGEMENT MODULE]: Requested url type {0} for {1}", serverType, userID); UserAgentServiceConnector uConn = new UserAgentServiceConnector(userdata.HomeURL); try { userdata.ServerURLs = uConn.GetServerURLs(userID); } catch(System.Net.WebException e) { m_log.DebugFormat("[USER MANAGEMENT MODULE]: GetServerURLs call failed {0}", e.Message); userdata.ServerURLs = new Dictionary(); } catch (Exception e) { m_log.Debug("[USER MANAGEMENT MODULE]: GetServerURLs call failed ", e); userdata.ServerURLs = new Dictionary(); } if (userdata.ServerURLs != null && userdata.ServerURLs.ContainsKey(serverType) && userdata.ServerURLs[serverType] != null) return userdata.ServerURLs[serverType].ToString(); } return string.Empty; } public string GetUserUUI(UUID userID) { string uui; GetUserUUI(userID, out uui); return uui; } public bool GetUserUUI(UUID userID, out string uui) { UserData ud; bool result = GetUser(userID, out ud); if (ud != null) { string homeURL = ud.HomeURL; string first = ud.FirstName, last = ud.LastName; if (ud.LastName.StartsWith("@")) { string[] parts = ud.FirstName.Split('.'); if (parts.Length >= 2) { first = parts[0]; last = parts[1]; } uui = userID + ";" + homeURL + ";" + first + " " + last; } } uui = userID.ToString(); return result; } #region Cache Management public bool GetUser(UUID uuid, out UserData userdata) { lock (m_UserCache) { if (m_UserCache.TryGetValue(uuid, out userdata)) { if (userdata.HasGridUserTried) { return true; } } else { userdata = new UserData(); userdata.HasGridUserTried = false; userdata.Id = uuid; userdata.FirstName = "Unknown"; userdata.LastName = "UserUMMAU42"; userdata.HomeURL = string.Empty; userdata.IsUnknownUser = true; userdata.HasGridUserTried = false; } } /* BEGIN: do not wrap this code in any lock here * There are HTTP calls in here. */ if (!userdata.HasGridUserTried) { /* rewrite here */ UserAccount account = m_Scenes[0].UserAccountService.GetUserAccount(m_Scenes[0].RegionInfo.ScopeID, uuid); if (account != null) { userdata.FirstName = account.FirstName; userdata.LastName = account.LastName; userdata.HomeURL = string.Empty; userdata.IsUnknownUser = false; userdata.HasGridUserTried = true; } } if (!userdata.HasGridUserTried) { GridUserInfo uInfo = null; if (null != m_Scenes[0].GridUserService) { uInfo = m_Scenes[0].GridUserService.GetGridUserInfo(uuid.ToString()); } if (uInfo != null) { string url, first, last, tmp; UUID u; if(uInfo.UserID.Length <= 36) { /* not a UUI */ } else if (Util.ParseUniversalUserIdentifier(uInfo.UserID, out u, out url, out first, out last, out tmp)) { if (url != string.Empty) { userdata.FirstName = first.Replace(" ", ".") + "." + last.Replace(" ", "."); userdata.HomeURL = url; try { userdata.LastName = "@" + new Uri(url).Authority; userdata.IsUnknownUser = false; } catch { userdata.LastName = "@unknown"; } userdata.HasGridUserTried = true; } } else m_log.DebugFormat("[USER MANAGEMENT MODULE]: Unable to parse UUI {0}", uInfo.UserID); } } /* END: do not wrap this code in any lock here */ lock (m_UserCache) { m_UserCache[uuid] = userdata; } return !userdata.IsUnknownUser; } public void AddUser(UUID uuid, string first, string last) { lock(m_UserCache) { if(!m_UserCache.ContainsKey(uuid)) { UserData user = new UserData(); user.Id = uuid; user.FirstName = first; user.LastName = last; user.IsUnknownUser = false; user.HasGridUserTried = false; m_UserCache.Add(uuid, user); } } } public void AddUser(UUID uuid, string first, string last, string homeURL) { //m_log.DebugFormat("[USER MANAGEMENT MODULE]: Adding user with id {0}, first {1}, last {2}, url {3}", uuid, first, last, homeURL); UserData oldUser; lock (m_UserCache) { if (m_UserCache.TryGetValue(uuid, out oldUser)) { if (!oldUser.IsUnknownUser) { if (homeURL != oldUser.HomeURL && m_DisplayChangingHomeURI) { m_log.DebugFormat("[USER MANAGEMENT MODULE]: Different HomeURI for {0} {1} ({2}): {3} and {4}", first, last, uuid.ToString(), homeURL, oldUser.HomeURL); } /* no update needed */ return; } } else if(!m_UserCache.ContainsKey(uuid)) { oldUser = new UserData(); oldUser.HasGridUserTried = false; oldUser.IsUnknownUser = false; if (homeURL != string.Empty) { oldUser.FirstName = first.Replace(" ", ".") + "." + last.Replace(" ", "."); try { oldUser.LastName = "@" + new Uri(homeURL).Authority; oldUser.IsUnknownUser = false; } catch { oldUser.LastName = "@unknown"; } } else { oldUser.FirstName = first; oldUser.LastName = last; } oldUser.HomeURL = homeURL; oldUser.Id = uuid; m_UserCache.Add(uuid, oldUser); } } } public void AddUser(UUID id, string creatorData) { // m_log.InfoFormat("[USER MANAGEMENT MODULE]: Adding user with id {0}, creatorData {1}", id, creatorData); if(string.IsNullOrEmpty(creatorData)) { AddUser(id, string.Empty, string.Empty, string.Empty); } else { string homeURL; string firstname = string.Empty; string lastname = string.Empty; //creatorData = ; string[] parts = creatorData.Split(';'); if(parts.Length > 1) { string[] nameparts = parts[1].Split(' '); firstname = nameparts[0]; for(int xi = 1; xi < nameparts.Length; ++xi) { if(xi != 1) { lastname += " "; } lastname += nameparts[xi]; } } else { firstname = "Unknown"; lastname = "UserUMMAU5"; } if (parts.Length >= 1) { homeURL = parts[0]; if(Uri.IsWellFormedUriString(homeURL, UriKind.Absolute)) { AddUser(id, firstname, lastname, homeURL); } else { m_log.DebugFormat("[SCENE]: Unable to parse Uri {0} for CreatorID {1}", parts[0], creatorData); lock (m_UserCache) { if(!m_UserCache.ContainsKey(id)) { UserData newUser = new UserData(); newUser.Id = id; newUser.FirstName = firstname + "." + lastname.Replace(' ', '.'); newUser.LastName = "@unknown"; newUser.HomeURL = string.Empty; newUser.HasGridUserTried = false; newUser.IsUnknownUser = true; /* we mark those users as Unknown user so a re-retrieve may be activated */ m_UserCache.Add(id, newUser); } } } } else { lock(m_UserCache) { if(!m_UserCache.ContainsKey(id)) { UserData newUser = new UserData(); newUser.Id = id; newUser.FirstName = "Unknown"; newUser.LastName = "UserUMMAU4"; newUser.HomeURL = string.Empty; newUser.IsUnknownUser = true; newUser.HasGridUserTried = false; m_UserCache.Add(id, newUser); } } } } } #endregion public bool IsLocalGridUser(UUID uuid) { UserAccount account = m_Scenes[0].UserAccountService.GetUserAccount(m_Scenes[0].RegionInfo.ScopeID, uuid); if (account == null || (account != null && !account.LocalToGrid)) return false; return true; } #endregion IUserManagement protected void Init() { AddUser(UUID.Zero, "Unknown", "User"); RegisterConsoleCmds(); } protected void RegisterConsoleCmds() { MainConsole.Instance.Commands.AddCommand("Users", true, "show name", "show name ", "Show the bindings between a single user UUID and a user name", String.Empty, HandleShowUser); MainConsole.Instance.Commands.AddCommand("Users", true, "show names", "show names", "Show the bindings between user UUIDs and user names", String.Empty, HandleShowUsers); MainConsole.Instance.Commands.AddCommand("Users", true, "reset user cache", "reset user cache", "reset user cache to allow changed settings to be applied", String.Empty, HandleResetUserCache); } private void HandleResetUserCache(string module, string[] cmd) { lock(m_UserCache) { m_UserCache.Clear(); } } private void HandleShowUser(string module, string[] cmd) { if (cmd.Length < 3) { MainConsole.Instance.OutputFormat("Usage: show name "); return; } UUID userId; if (!ConsoleUtil.TryParseConsoleUuid(MainConsole.Instance, cmd[2], out userId)) return; UserData ud; if(!GetUser(userId, out ud)) { MainConsole.Instance.OutputFormat("No name known for user with id {0}", userId); return; } ConsoleDisplayTable cdt = new ConsoleDisplayTable(); cdt.AddColumn("UUID", 36); cdt.AddColumn("Name", 30); cdt.AddColumn("HomeURL", 40); cdt.AddRow(userId, string.Format("{0} {1}", ud.FirstName, ud.LastName), ud.HomeURL); MainConsole.Instance.Output(cdt.ToString()); } private void HandleShowUsers(string module, string[] cmd) { ConsoleDisplayTable cdt = new ConsoleDisplayTable(); cdt.AddColumn("UUID", 36); cdt.AddColumn("Name", 30); cdt.AddColumn("HomeURL", 40); cdt.AddColumn("Checked", 10); Dictionary copyDict; lock(m_UserCache) { copyDict = new Dictionary(m_UserCache); } foreach(KeyValuePair kvp in copyDict) { cdt.AddRow(kvp.Key, string.Format("{0} {1}", kvp.Value.FirstName, kvp.Value.LastName), kvp.Value.HomeURL, kvp.Value.HasGridUserTried ? "yes" : "no"); } MainConsole.Instance.Output(cdt.ToString()); } } }