diff options
Diffstat (limited to 'OpenSim/Region/CoreModules/World/WorldMap/MapSearchModule.cs')
-rw-r--r-- | OpenSim/Region/CoreModules/World/WorldMap/MapSearchModule.cs | 172 |
1 files changed, 172 insertions, 0 deletions
diff --git a/OpenSim/Region/CoreModules/World/WorldMap/MapSearchModule.cs b/OpenSim/Region/CoreModules/World/WorldMap/MapSearchModule.cs new file mode 100644 index 0000000..45a99a9 --- /dev/null +++ b/OpenSim/Region/CoreModules/World/WorldMap/MapSearchModule.cs | |||
@@ -0,0 +1,172 @@ | |||
1 | /* | ||
2 | * Copyright (c) Contributors, http://opensimulator.org/ | ||
3 | * See CONTRIBUTORS.TXT for a full list of copyright holders. | ||
4 | * | ||
5 | * Redistribution and use in source and binary forms, with or without | ||
6 | * modification, are permitted provided that the following conditions are met: | ||
7 | * * Redistributions of source code must retain the above copyright | ||
8 | * notice, this list of conditions and the following disclaimer. | ||
9 | * * Redistributions in binary form must reproduce the above copyright | ||
10 | * notice, this list of conditions and the following disclaimer in the | ||
11 | * documentation and/or other materials provided with the distribution. | ||
12 | * * Neither the name of the OpenSim Project nor the | ||
13 | * names of its contributors may be used to endorse or promote products | ||
14 | * derived from this software without specific prior written permission. | ||
15 | * | ||
16 | * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY | ||
17 | * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED | ||
18 | * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | ||
19 | * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY | ||
20 | * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES | ||
21 | * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; | ||
22 | * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND | ||
23 | * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
24 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | ||
25 | * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
26 | */ | ||
27 | using System; | ||
28 | using System.Reflection; | ||
29 | using System.Collections.Generic; | ||
30 | using System.Net; | ||
31 | using OpenSim.Framework; | ||
32 | using OpenSim.Region.Framework.Interfaces; | ||
33 | using OpenSim.Region.Framework.Scenes; | ||
34 | using OpenSim.Region.Framework.Scenes.Hypergrid; | ||
35 | using OpenMetaverse; | ||
36 | using log4net; | ||
37 | using Nini.Config; | ||
38 | |||
39 | namespace OpenSim.Region.CoreModules.World.WorldMap | ||
40 | { | ||
41 | public class MapSearchModule : IRegionModule | ||
42 | { | ||
43 | private static readonly ILog m_log = | ||
44 | LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType); | ||
45 | |||
46 | Scene m_scene = null; // only need one for communication with GridService | ||
47 | List<Scene> m_scenes = new List<Scene>(); | ||
48 | |||
49 | #region IRegionModule Members | ||
50 | public void Initialise(Scene scene, IConfigSource source) | ||
51 | { | ||
52 | if (m_scene == null) | ||
53 | { | ||
54 | m_scene = scene; | ||
55 | } | ||
56 | |||
57 | m_scenes.Add(scene); | ||
58 | scene.EventManager.OnNewClient += OnNewClient; | ||
59 | } | ||
60 | |||
61 | public void PostInitialise() | ||
62 | { | ||
63 | } | ||
64 | |||
65 | public void Close() | ||
66 | { | ||
67 | m_scene = null; | ||
68 | m_scenes.Clear(); | ||
69 | } | ||
70 | |||
71 | public string Name | ||
72 | { | ||
73 | get { return "MapSearchModule"; } | ||
74 | } | ||
75 | |||
76 | public bool IsSharedModule | ||
77 | { | ||
78 | get { return true; } | ||
79 | } | ||
80 | |||
81 | #endregion | ||
82 | |||
83 | private void OnNewClient(IClientAPI client) | ||
84 | { | ||
85 | client.OnMapNameRequest += OnMapNameRequest; | ||
86 | } | ||
87 | |||
88 | private void OnMapNameRequest(IClientAPI remoteClient, string mapName) | ||
89 | { | ||
90 | if (mapName.Length < 3) | ||
91 | { | ||
92 | remoteClient.SendAlertMessage("Use a search string with at least 3 characters"); | ||
93 | return; | ||
94 | } | ||
95 | |||
96 | // try to fetch from GridServer | ||
97 | List<RegionInfo> regionInfos = m_scene.SceneGridService.RequestNamedRegions(mapName, 20); | ||
98 | if (regionInfos == null) | ||
99 | { | ||
100 | m_log.Warn("[MAPSEARCHMODULE]: RequestNamedRegions returned null. Old gridserver?"); | ||
101 | // service wasn't available; maybe still an old GridServer. Try the old API, though it will return only one region | ||
102 | regionInfos = new List<RegionInfo>(); | ||
103 | RegionInfo info = m_scene.SceneGridService.RequestClosestRegion(mapName); | ||
104 | if (info != null) regionInfos.Add(info); | ||
105 | } | ||
106 | |||
107 | if ((regionInfos.Count == 0) && IsHypergridOn()) | ||
108 | { | ||
109 | // OK, we tried but there are no regions matching that name. | ||
110 | // Let's check quickly if this is a domain name, and if so link to it | ||
111 | if (mapName.Contains(".") && mapName.Contains(":")) | ||
112 | { | ||
113 | // It probably is a domain name. Try to link to it. | ||
114 | RegionInfo regInfo; | ||
115 | Scene cScene = GetClientScene(remoteClient); | ||
116 | regInfo = HGHyperlink.TryLinkRegion(cScene, remoteClient, mapName); | ||
117 | if (regInfo != null) | ||
118 | regionInfos.Add(regInfo); | ||
119 | } | ||
120 | } | ||
121 | |||
122 | List<MapBlockData> blocks = new List<MapBlockData>(); | ||
123 | |||
124 | MapBlockData data; | ||
125 | if (regionInfos.Count > 0) | ||
126 | { | ||
127 | foreach (RegionInfo info in regionInfos) | ||
128 | { | ||
129 | data = new MapBlockData(); | ||
130 | data.Agents = 0; | ||
131 | data.Access = 21; // TODO what's this? | ||
132 | data.MapImageId = info.RegionSettings.TerrainImageID; | ||
133 | data.Name = info.RegionName; | ||
134 | data.RegionFlags = 0; // TODO not used? | ||
135 | data.WaterHeight = 0; // not used | ||
136 | data.X = (ushort)info.RegionLocX; | ||
137 | data.Y = (ushort)info.RegionLocY; | ||
138 | blocks.Add(data); | ||
139 | } | ||
140 | } | ||
141 | |||
142 | // final block, closing the search result | ||
143 | data = new MapBlockData(); | ||
144 | data.Agents = 0; | ||
145 | data.Access = 255; | ||
146 | data.MapImageId = UUID.Zero; | ||
147 | data.Name = mapName; | ||
148 | data.RegionFlags = 0; | ||
149 | data.WaterHeight = 0; // not used | ||
150 | data.X = 0; | ||
151 | data.Y = 0; | ||
152 | blocks.Add(data); | ||
153 | |||
154 | remoteClient.SendMapBlock(blocks, 0); | ||
155 | } | ||
156 | |||
157 | private bool IsHypergridOn() | ||
158 | { | ||
159 | return (m_scene.SceneGridService is HGSceneCommunicationService); | ||
160 | } | ||
161 | |||
162 | private Scene GetClientScene(IClientAPI client) | ||
163 | { | ||
164 | foreach (Scene s in m_scenes) | ||
165 | { | ||
166 | if (client.Scene.RegionInfo.RegionHandle == s.RegionInfo.RegionHandle) | ||
167 | return s; | ||
168 | } | ||
169 | return m_scene; | ||
170 | } | ||
171 | } | ||
172 | } | ||