OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
LandServiceInConnectorModule.cs
Go to the documentation of this file.
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 OpenSimulator 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 
28 using System;
29 using System.Reflection;
30 using System.Collections.Generic;
31 using log4net;
32 using Mono.Addins;
33 using Nini.Config;
34 using OpenSim.Framework;
35 using OpenSim.Framework.Servers;
36 using OpenSim.Region.Framework.Scenes;
37 using OpenSim.Region.Framework.Interfaces;
38 using OpenSim.Server.Base;
39 using OpenSim.Server.Handlers.Base;
40 using OpenSim.Services.Interfaces;
41 using OpenMetaverse;
42 
43 
44 namespace OpenSim.Region.CoreModules.ServiceConnectorsIn.Land
45 {
46  [Extension(Path = "/OpenSim/RegionModules", NodeName = "RegionModule", Id = "LandServiceInConnectorModule")]
48  {
49  private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
50  private static bool m_Enabled = false;
51  private static bool m_Registered = false;
52 
53  private IConfigSource m_Config;
54  private List<Scene> m_Scenes = new List<Scene>();
55 
56  #region Region Module interface
57 
58  public void Initialise(IConfigSource config)
59  {
60  m_Config = config;
61 
62  IConfig moduleConfig = config.Configs["Modules"];
63  if (moduleConfig != null)
64  {
65  m_Enabled = moduleConfig.GetBoolean("LandServiceInConnector", false);
66  if (m_Enabled)
67  {
68  m_log.Info("[LAND IN CONNECTOR]: LandServiceInConnector enabled");
69  }
70 
71  }
72 
73  }
74 
75  public void PostInitialise()
76  {
77  if (!m_Enabled)
78  return;
79 
80 // m_log.Info("[LAND IN CONNECTOR]: Starting...");
81  }
82 
83  public void Close()
84  {
85  }
86 
87  public Type ReplaceableInterface
88  {
89  get { return null; }
90  }
91 
92  public string Name
93  {
94  get { return "LandServiceInConnectorModule"; }
95  }
96 
97  public void AddRegion(Scene scene)
98  {
99  if (!m_Enabled)
100  return;
101 
102  if (!m_Registered)
103  {
104  m_Registered = true;
105  Object[] args = new Object[] { m_Config, MainServer.Instance, this, scene };
106  ServerUtils.LoadPlugin<IServiceConnector>("OpenSim.Server.Handlers.dll:LandServiceInConnector", args);
107  }
108 
109  m_Scenes.Add(scene);
110 
111  }
112 
113  public void RemoveRegion(Scene scene)
114  {
115  if (m_Enabled && m_Scenes.Contains(scene))
116  m_Scenes.Remove(scene);
117  }
118 
119  public void RegionLoaded(Scene scene)
120  {
121  }
122 
123  #endregion
124 
125  #region ILandService
126 
127  public LandData GetLandData(UUID scopeID, ulong regionHandle, uint x, uint y, out byte regionAccess)
128  {
129  m_log.DebugFormat("[LAND IN CONNECTOR]: GetLandData for {0}. Count = {1}",
130  regionHandle, m_Scenes.Count);
131  foreach (Scene s in m_Scenes)
132  {
133  if (s.RegionInfo.RegionHandle == regionHandle)
134  {
135  m_log.Debug("[LAND IN CONNECTOR]: Found region to GetLandData from");
136  regionAccess = s.RegionInfo.AccessLevel;
137  return s.GetLandData(x, y);
138  }
139  }
140  m_log.DebugFormat("[LAND IN CONNECTOR]: region handle {0} not found", regionHandle);
141  regionAccess = 42;
142  return null;
143  }
144 
145  #endregion ILandService
146  }
147 }
void PostInitialise()
This is called exactly once after all the shared region-modules have been instanciated and IRegionMod...
void RegionLoaded(Scene scene)
This will be called once for every scene loaded. In a shared module this will be multiple times in on...
LandData GetLandData(UUID scopeID, ulong regionHandle, uint x, uint y, out byte regionAccess)
void AddRegion(Scene scene)
This is called whenever a Scene is added. For shared modules, this can happen several times...
void Close()
This is the inverse to Initialise. After a Close(), this instance won't be usable anymore...
Details of a Parcel of land
Definition: LandData.cs:47
void RemoveRegion(Scene scene)
This is called whenever a Scene is removed. For shared modules, this can happen several times...
Interactive OpenSim region server
Definition: OpenSim.cs:55
void Initialise(IConfigSource config)
This is called to initialize the region module. For shared modules, this is called exactly once...