From 7b0b5c9d97dea840e1ede6e2318b3c049c804983 Mon Sep 17 00:00:00 2001
From: Diva Canto
Date: Sun, 28 Jul 2013 13:49:58 -0700
Subject: Added BasicSearchModule.cs which handles OnDirFindQuery events.
Removed that handler from both Groups modules in core, and replaced them with
an operation on IGroupsModule.
---
.../Framework/Search/BasicSearchModule.cs | 198 +++++++++++++++++++++
.../UserManagement/UserManagementModule.cs | 39 ----
.../Region/Framework/Interfaces/IGroupsModule.cs | 2 +
.../Avatar/XmlRpcGroups/GroupsModule.cs | 22 +--
4 files changed, 206 insertions(+), 55 deletions(-)
create mode 100644 OpenSim/Region/CoreModules/Framework/Search/BasicSearchModule.cs
(limited to 'OpenSim/Region')
diff --git a/OpenSim/Region/CoreModules/Framework/Search/BasicSearchModule.cs b/OpenSim/Region/CoreModules/Framework/Search/BasicSearchModule.cs
new file mode 100644
index 0000000..a089447
--- /dev/null
+++ b/OpenSim/Region/CoreModules/Framework/Search/BasicSearchModule.cs
@@ -0,0 +1,198 @@
+/*
+ * 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.Search
+{
+ [Extension(Path = "/OpenSim/RegionModules", NodeName = "RegionModule", Id = "BasicSearchModule")]
+ public class BasicSearchModule : ISharedRegionModule
+ {
+ private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
+
+ protected bool m_Enabled;
+ protected List<Scene> m_Scenes = new List<Scene>();
+
+ private IGroupsModule m_GroupsService = null;
+
+ #region ISharedRegionModule
+
+ public void Initialise(IConfigSource config)
+ {
+ string umanmod = config.Configs["Modules"].GetString("SearchModule", Name);
+ if (umanmod == Name)
+ {
+ m_Enabled = true;
+ m_log.DebugFormat("[BASIC SEARCH MODULE]: {0} is enabled", Name);
+ }
+ }
+
+ public bool IsSharedModule
+ {
+ get { return true; }
+ }
+
+ public virtual string Name
+ {
+ get { return "BasicSearchModule"; }
+ }
+
+ public Type ReplaceableInterface
+ {
+ get { return null; }
+ }
+
+ public void AddRegion(Scene scene)
+ {
+ if (m_Enabled)
+ {
+ m_Scenes.Add(scene);
+
+ scene.EventManager.OnMakeRootAgent += new Action<ScenePresence>(EventManager_OnMakeRootAgent);
+ scene.EventManager.OnMakeChildAgent += new EventManager.OnMakeChildAgentDelegate(EventManager_OnMakeChildAgent);
+ }
+ }
+
+ public void RemoveRegion(Scene scene)
+ {
+ if (m_Enabled)
+ {
+ m_Scenes.Remove(scene);
+
+ scene.EventManager.OnMakeRootAgent -= new Action<ScenePresence>(EventManager_OnMakeRootAgent);
+ scene.EventManager.OnMakeChildAgent -= new EventManager.OnMakeChildAgentDelegate(EventManager_OnMakeChildAgent);
+ }
+ }
+
+ public void RegionLoaded(Scene s)
+ {
+ if (!m_Enabled)
+ return;
+
+ if (m_GroupsService == null)
+ {
+ m_GroupsService = s.RequestModuleInterface<IGroupsModule>();
+
+ // No Groups Service Connector, then group search won't work...
+ if (m_GroupsService == null)
+ m_log.Warn("[BASIC SEARCH MODULE]: Could not get IGroupsModule");
+ }
+ }
+
+ public void PostInitialise()
+ {
+ }
+
+ public void Close()
+ {
+ m_Scenes.Clear();
+ }
+
+ #endregion ISharedRegionModule
+
+
+ #region Event Handlers
+
+ void EventManager_OnMakeRootAgent(ScenePresence sp)
+ {
+ sp.ControllingClient.OnDirFindQuery += OnDirFindQuery;
+ }
+
+ void EventManager_OnMakeChildAgent(ScenePresence sp)
+ {
+ sp.ControllingClient.OnDirFindQuery -= OnDirFindQuery;
+ }
+
+ void OnDirFindQuery(IClientAPI remoteClient, UUID queryID, string queryText, uint queryFlags, int queryStart)
+ {
+ m_log.Debug("[ZZZ]: Got here");
+ if (((DirFindFlags)queryFlags & DirFindFlags.People) == DirFindFlags.People)
+ {
+ if (string.IsNullOrEmpty(queryText))
+ remoteClient.SendDirPeopleReply(queryID, new DirPeopleReplyData[0]);
+
+ List<UserAccount> accounts = m_Scenes[0].UserAccountService.GetUserAccounts(m_Scenes[0].RegionInfo.ScopeID, queryText);
+ DirPeopleReplyData[] hits = new DirPeopleReplyData[accounts.Count];
+ int i = 0;
+ foreach (UserAccount acc in accounts)
+ {
+ DirPeopleReplyData d = new DirPeopleReplyData();
+ d.agentID = acc.PrincipalID;
+ d.firstName = acc.FirstName;
+ d.lastName = acc.LastName;
+ d.online = false;
+
+ hits[i++] = d;
+ }
+
+ // TODO: This currently ignores pretty much all the query flags including Mature and sort order
+ remoteClient.SendDirPeopleReply(queryID, hits);
+ }
+ else if (((DirFindFlags)queryFlags & DirFindFlags.Groups) == DirFindFlags.Groups)
+ {
+ if (m_GroupsService == null)
+ {
+ m_log.Warn("[BASIC SEARCH MODULE]: Groups service is not available. Unable to search groups.");
+ remoteClient.SendAlertMessage("Groups search is not enabled");
+ return;
+ }
+
+ if (string.IsNullOrEmpty(queryText))
+ remoteClient.SendDirGroupsReply(queryID, new DirGroupsReplyData[0]);
+
+ // TODO: This currently ignores pretty much all the query flags including Mature and sort order
+ remoteClient.SendDirGroupsReply(queryID, m_GroupsService.FindGroups(remoteClient, queryText).ToArray());
+ }
+
+ }
+
+ #endregion Event Handlers
+
+ }
+
+}
\ No newline at end of file
diff --git a/OpenSim/Region/CoreModules/Framework/UserManagement/UserManagementModule.cs b/OpenSim/Region/CoreModules/Framework/UserManagement/UserManagementModule.cs
index 295ad64..7adb203 100644
--- a/OpenSim/Region/CoreModules/Framework/UserManagement/UserManagementModule.cs
+++ b/OpenSim/Region/CoreModules/Framework/UserManagement/UserManagementModule.cs
@@ -100,8 +100,6 @@ namespace OpenSim.Region.CoreModules.Framework.UserManagement
scene.RegisterModuleInterface<IPeople>(this);
scene.EventManager.OnNewClient += new EventManager.OnNewClientDelegate(EventManager_OnNewClient);
scene.EventManager.OnPrimsLoaded += new EventManager.PrimsLoaded(EventManager_OnPrimsLoaded);
- scene.EventManager.OnMakeRootAgent += new Action<ScenePresence>(EventManager_OnMakeRootAgent);
- scene.EventManager.OnMakeChildAgent += new EventManager.OnMakeChildAgentDelegate(EventManager_OnMakeChildAgent);
}
}
@@ -157,43 +155,6 @@ namespace OpenSim.Region.CoreModules.Framework.UserManagement
client.OnAvatarPickerRequest -= new AvatarPickerRequest(HandleAvatarPickerRequest);
}
- void EventManager_OnMakeRootAgent(ScenePresence sp)
- {
- sp.ControllingClient.OnDirFindQuery += OnDirFindQuery;
- }
-
- void EventManager_OnMakeChildAgent(ScenePresence sp)
- {
- sp.ControllingClient.OnDirFindQuery -= OnDirFindQuery;
- }
-
- void OnDirFindQuery(IClientAPI remoteClient, UUID queryID, string queryText, uint queryFlags, int queryStart)
- {
- if (((DirFindFlags)queryFlags & DirFindFlags.People) == DirFindFlags.People)
- {
- if (string.IsNullOrEmpty(queryText))
- remoteClient.SendDirPeopleReply(queryID, new DirPeopleReplyData[0]);
-
- List<UserAccount> accounts = m_Scenes[0].UserAccountService.GetUserAccounts(m_Scenes[0].RegionInfo.ScopeID, queryText);
- DirPeopleReplyData[] hits = new DirPeopleReplyData[accounts.Count];
- int i = 0;
- foreach (UserAccount acc in accounts)
- {
- DirPeopleReplyData d = new DirPeopleReplyData();
- d.agentID = acc.PrincipalID;
- d.firstName = acc.FirstName;
- d.lastName = acc.LastName;
- d.online = false;
-
- hits[i++] = d;
- }
-
- // TODO: This currently ignores pretty much all the query flags including Mature and sort order
- remoteClient.SendDirPeopleReply(queryID, hits);
- }
-
- }
-
void HandleUUIDNameRequest(UUID uuid, IClientAPI client)
{
// m_log.DebugFormat(
diff --git a/OpenSim/Region/Framework/Interfaces/IGroupsModule.cs b/OpenSim/Region/Framework/Interfaces/IGroupsModule.cs
index 6885327..9ae5e87 100644
--- a/OpenSim/Region/Framework/Interfaces/IGroupsModule.cs
+++ b/OpenSim/Region/Framework/Interfaces/IGroupsModule.cs
@@ -97,5 +97,7 @@ namespace OpenSim.Region.Framework.Interfaces
void InviteGroupRequest(IClientAPI remoteClient, UUID GroupID, UUID InviteeID, UUID RoleID);
void InviteGroup(IClientAPI remoteClient, UUID agentID, UUID GroupID, UUID InviteeID, UUID RoleID);
void NotifyChange(UUID GroupID);
+
+ List<DirGroupsReplyData> FindGroups(IClientAPI remoteClient, string query);
}
}
\ No newline at end of file
diff --git a/OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/GroupsModule.cs b/OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/GroupsModule.cs
index 32fb54b..f4734b7 100644
--- a/OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/GroupsModule.cs
+++ b/OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/GroupsModule.cs
@@ -250,7 +250,6 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
client.OnUUIDGroupNameRequest += HandleUUIDGroupNameRequest;
client.OnAgentDataUpdateRequest += OnAgentDataUpdateRequest;
- client.OnDirFindQuery += OnDirFindQuery;
client.OnRequestAvatarProperties += OnRequestAvatarProperties;
// Used for Notices and Group Invites/Accept/Reject
@@ -303,21 +302,6 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
}
*/
- void OnDirFindQuery(IClientAPI remoteClient, UUID queryID, string queryText, uint queryFlags, int queryStart)
- {
- if (((DirFindFlags)queryFlags & DirFindFlags.Groups) == DirFindFlags.Groups)
- {
- if (m_debugEnabled)
- m_log.DebugFormat(
- "[GROUPS]: {0} called with queryText({1}) queryFlags({2}) queryStart({3})",
- System.Reflection.MethodBase.GetCurrentMethod().Name, queryText, (DirFindFlags)queryFlags, queryStart);
-
- // TODO: This currently ignores pretty much all the query flags including Mature and sort order
- remoteClient.SendDirGroupsReply(queryID, m_groupData.FindGroups(GetRequestingAgentID(remoteClient), queryText).ToArray());
- }
-
- }
-
private void OnAgentDataUpdateRequest(IClientAPI remoteClient, UUID dataForAgentID, UUID sessionID)
{
if (m_debugEnabled) m_log.DebugFormat("[GROUPS]: {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name);
@@ -1178,6 +1162,12 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
}
}
+ public List<DirGroupsReplyData> FindGroups(IClientAPI remoteClient, string query)
+ {
+ return m_groupData.FindGroups(GetRequestingAgentID(remoteClient), query);
+ }
+
+
#endregion
#region Client/Update Tools
--
cgit v1.1